com.vmware.content.library.item

Class DownloadSessionModel

java.lang.Object

com.vmware.content.library.item.DownloadSessionModel

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class DownloadSessionModel
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The DownloadSessionModel class provides information on an active DownloadSession resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DownloadSessionModel.Builder Builder class for DownloadSessionModel.
static class	DownloadSessionModel.State The state of the download session.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	DownloadSessionModel() Default constructor.
protected	DownloadSessionModel(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal method, subject to change in future versions.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static DownloadSessionModel	_newInstance(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
static DownloadSessionModel	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.lang.Long	getClientProgress() The progress that has been made with the download.
LocalizableMessage	getErrorMessage() If the session is in the DownloadSessionModel.State.ERROR status this property will have more details about the error.
java.util.Calendar	getExpirationTime() Indicates the time after which the session will expire.
java.lang.String	getId() The identifier of this download session.
java.lang.String	getLibraryItemContentVersion() The content version of the library item whose content is being downloaded.
java.lang.String	getLibraryItemId() The identifier of the library item whose content is being downloaded.
DownloadSessionModel.State	getState() The current state (ACTIVE, CANCELED, ERROR) of the download session.
int	hashCode()
void	setClientProgress(java.lang.Long clientProgress) The progress that has been made with the download.
void	setErrorMessage(LocalizableMessage errorMessage) If the session is in the DownloadSessionModel.State.ERROR status this property will have more details about the error.
void	setExpirationTime(java.util.Calendar expirationTime) Indicates the time after which the session will expire.
void	setId(java.lang.String id) The identifier of this download session.
void	setLibraryItemContentVersion(java.lang.String libraryItemContentVersion) The content version of the library item whose content is being downloaded.
void	setLibraryItemId(java.lang.String libraryItemId) The identifier of the library item whose content is being downloaded.
void	setState(DownloadSessionModel.State state) The current state (ACTIVE, CANCELED, ERROR) of the download session.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

DownloadSessionModel

public DownloadSessionModel()

Default constructor.

DownloadSessionModel

protected DownloadSessionModel(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getId

public java.lang.String getId()

The identifier of this download session. This property is not used for the create method. It will not be present in the return value of the get or list methods. It is not used for the update method.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

setId

public void setId(java.lang.String id)

The identifier of this download session. This property is not used for the create method. It will not be present in the return value of the get or list methods. It is not used for the update method.

Parameters:

id - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

getLibraryItemId

public java.lang.String getLibraryItemId()

The identifier of the library item whose content is being downloaded. This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is not used for the update method.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.Item. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.content.library.Item.

setLibraryItemId

public void setLibraryItemId(java.lang.String libraryItemId)

The identifier of the library item whose content is being downloaded. This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is not used for the update method.

Parameters:

libraryItemId - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.Item. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.content.library.Item.

getLibraryItemContentVersion

public java.lang.String getLibraryItemContentVersion()

The content version of the library item whose content is being downloaded. This value is the ItemModel.getContentVersion() at the time when the session is created for the library item. This property is not used for the create method. It will always be present in the return value of the get or list methods. It is not used for the update method.

Returns:

The current value of the property.

setLibraryItemContentVersion

public void setLibraryItemContentVersion(java.lang.String libraryItemContentVersion)

The content version of the library item whose content is being downloaded. This value is the ItemModel.getContentVersion() at the time when the session is created for the library item. This property is not used for the create method. It will always be present in the return value of the get or list methods. It is not used for the update method.

Parameters:

libraryItemContentVersion - New value for the property.

getErrorMessage

public LocalizableMessage getErrorMessage()

If the session is in the DownloadSessionModel.State.ERROR status this property will have more details about the error. This property is not used for the create method. It is optional in the return value of the get or list methods. It is not used for the update method.

Returns:

The current value of the property.

setErrorMessage

public void setErrorMessage(LocalizableMessage errorMessage)

If the session is in the DownloadSessionModel.State.ERROR status this property will have more details about the error. This property is not used for the create method. It is optional in the return value of the get or list methods. It is not used for the update method.

Parameters:

errorMessage - New value for the property.

getClientProgress

public java.lang.Long getClientProgress()

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. This property is not used for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.

Returns:

The current value of the property.

setClientProgress

public void setClientProgress(java.lang.Long clientProgress)

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. This property is not used for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.

Parameters:

clientProgress - New value for the property.

getState

public DownloadSessionModel.State getState()

The current state (ACTIVE, CANCELED, ERROR) of the download session. This property is not used for the create method. It will always be present in the return value of the get or list methods. It is not used for the update method.

Returns:

The current value of the property.

setState

public void setState(DownloadSessionModel.State state)

The current state (ACTIVE, CANCELED, ERROR) of the download session. This property is not used for the create method. It will always be present in the return value of the get or list methods. It is not used for the update method.

Parameters:

state - New value for the property.

getExpirationTime

public java.util.Calendar getExpirationTime()

Indicates the time after which the session will expire. The session is guaranteed not to expire before this time. This property is not used for the create method. It will always be present in the return value of the get or list methods. It is not used for the update method.

Returns:

The current value of the property.

setExpirationTime

public void setExpirationTime(java.util.Calendar expirationTime)

Indicates the time after which the session will expire. The session is guaranteed not to expire before this time. This property is not used for the create method. It will always be present in the return value of the get or list methods. It is not used for the update method.

Parameters:

expirationTime - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static DownloadSessionModel _newInstance(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2

public static DownloadSessionModel _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.