Inheritance diagram for Com::Vmware::Content::Library::Item::DownloadSessionModel:

Classes
class	State

Avaliable Methods
public method	set_client_progress ()

public method	get_library_item_id ()

public method	get_id ()

public method	set_id ()

public method	set_error_message ()

public method	set_expiration_time ()

public method	set_state ()

public method	get_client_progress ()

public method	set_library_item_content_version ()

public method	get_error_message ()

public method	set_library_item_id ()

public method	new ()

public method	get_library_item_content_version ()

public method	get_state ()

public method	get_expiration_time ()

Detailed Description

The Com::Vmware::Content::Library::Item::DownloadSessionModel class provides information on an active class Com::Vmware::Content::Library::Item::DownloadSession resource.

Member Function Documentation

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::get_client_progress ( )

Gets the value of 'client_progress' property.

Return values

client_progress - The current value of the field. The progress that has been made with the download. This property is to be updated by the client during the download process to indicate the progress of its work in completing the download. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the download is complete. optional#

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::get_error_message ( )

Gets the value of 'error_message' property.

Return values

error_message - The current value of the field. If the session is in the :attr:Com::Vmware::Content::Library::Item::DownloadSessionModel::State.ERROR status this property will have more details about the error. optional#

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::get_expiration_time ( )

Gets the value of 'expiration_time' property.

Return values

expiration_time - The current value of the field. Indicates the time after which the session will expire. The session is guaranteed not to expire before this time. optional#

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::get_id ( )

Gets the value of 'id' property.

Return values

id	- The current value of the field. The identifier of this download session. optional#

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::get_library_item_content_version ( )

Gets the value of 'library_item_content_version' property.

Return values

library_item_content_version - The current value of the field. The content version of the library item whose content is being downloaded. This value is the :attr:Com::Vmware::Content::Library::ItemModel.content_version at the time when the session is created for the library item. optional#

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::get_library_item_id ( )

Gets the value of 'library_item_id' property.

Return values

library_item_id - The current value of the field. The identifier of the library item whose content is being downloaded. optional#

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::get_state ( )

Gets the value of 'state' property.

Return values

state - The current value of the field. The current state (ACTIVE, CANCELED, ERROR) of the download session. optional#

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::new ( )

Constructor to initialize the Com::Vmware::Content::Library::Item::DownloadSessionModel structure

Return values

Blessed object

Code:

click to view

# Number of lines of code in new: 28
sub new {
   my ($class, %args) = @_;
   $class = ref($class) || $class;
   my $validatorList = [];
      
   my $self = $class->SUPER::new('validator_list' => $validatorList, %args);
   $self->{id} = $args{'id'};
   $self->{library_item_id} = $args{'library_item_id'};
   $self->{library_item_content_version} = $args{'library_item_content_version'};
   $self->{error_message} = $args{'error_message'};
   $self->{client_progress} = $args{'client_progress'};
   $self->{state} = $args{'state'};
   $self->{expiration_time} = $args{'expiration_time'};
   $self->set_binding_class('binding_class' => 'Com::Vmware::Content::Library::Item::DownloadSessionModel');
   $self->set_binding_name('name' => 'com.vmware.content.library.item.download_session_model');
   $self->set_binding_field('key' => 'id', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'library_item_id', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'library_item_content_version', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'error_message', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::ReferenceType('module_ctx' => 'Com::Vmware::Vapi::Std', 'type_name' => 'LocalizableMessage')));
   $self->set_binding_field('key' => 'client_progress', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::LongType()));
   $self->set_binding_field('key' => 'state', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::ReferenceType('module_ctx' => 'Com::Vmware::Content::Library::Item', 'type_name' => 'DownloadSessionModel::State')));
   $self->set_binding_field('key' => 'expiration_time', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::DateTimeType()));
   bless $self, $class;
   return $self;
}

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::set_client_progress ( )

Sets the given value for 'client_progress' property.

Parameters

client_progress - New value for the field. The progress that has been made with the download. This property is to be updated by the client during the download process to indicate the progress of its work in completing the download. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the download is complete.

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::set_error_message ( )

Sets the given value for 'error_message' property.

Parameters

error_message - New value for the field. If the session is in the :attr:Com::Vmware::Content::Library::Item::DownloadSessionModel::State.ERROR status this property will have more details about the error.

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::set_expiration_time ( )

Sets the given value for 'expiration_time' property.

Parameters

expiration_time - New value for the field. Indicates the time after which the session will expire. The session is guaranteed not to expire before this time.

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::set_id ( )

Sets the given value for 'id' property.

Parameters

id	- New value for the field. The identifier of this download session.

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::set_library_item_content_version ( )

Sets the given value for 'library_item_content_version' property.

Parameters

library_item_content_version - New value for the field. The content version of the library item whose content is being downloaded. This value is the :attr:Com::Vmware::Content::Library::ItemModel.content_version at the time when the session is created for the library item.

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::set_library_item_id ( )

Sets the given value for 'library_item_id' property.

Parameters

library_item_id - New value for the field. The identifier of the library item whose content is being downloaded.

Code:

click to view

public method Com::Vmware::Content::Library::Item::DownloadSessionModel::set_state ( )

Sets the given value for 'state' property.

Parameters

state - New value for the field. The current state (ACTIVE, CANCELED, ERROR) of the download session.

Code:

click to view

The documentation for this class was generated from the following file:

Com/Vmware/Content/Library/Item/DownloadSessionModel.pm

Classes

Avaliable Methods

Detailed Description

Member Function Documentation