com.vmware.content.library.item

Class DownloadSessionModel.Builder

java.lang.Object

com.vmware.content.library.item.DownloadSessionModel.Builder

Enclosing class:

DownloadSessionModel

public static final class DownloadSessionModel.Builder
extends java.lang.Object

Builder class for DownloadSessionModel.

Constructor Summary

Constructors

Constructor and Description
DownloadSessionModel.Builder() Constructor with parameters for the required properties of DownloadSessionModel.

Method Summary

Methods

Modifier and Type	Method and Description
DownloadSessionModel	build()
DownloadSessionModel.Builder	setClientProgress(java.lang.Long clientProgress) The progress that has been made with the download.
DownloadSessionModel.Builder	setErrorMessage(LocalizableMessage errorMessage) If the session is in the DownloadSessionModel.State.ERROR status this property will have more details about the error.
DownloadSessionModel.Builder	setExpirationTime(java.util.Calendar expirationTime) Indicates the time after which the session will expire.
DownloadSessionModel.Builder	setId(java.lang.String id) The identifier of this download session.
DownloadSessionModel.Builder	setLibraryItemContentVersion(java.lang.String libraryItemContentVersion) The content version of the library item whose content is being downloaded.
DownloadSessionModel.Builder	setLibraryItemId(java.lang.String libraryItemId) The identifier of the library item whose content is being downloaded.
DownloadSessionModel.Builder	setState(DownloadSessionModel.State state) The current state (ACTIVE, CANCELED, ERROR) of the download session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DownloadSessionModel.Builder

public DownloadSessionModel.Builder()

Constructor with parameters for the required properties of DownloadSessionModel.

Method Detail

setId

public DownloadSessionModel.Builder 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.

setLibraryItemId

public DownloadSessionModel.Builder 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.

setLibraryItemContentVersion

public DownloadSessionModel.Builder 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.

setErrorMessage

public DownloadSessionModel.Builder 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.

setClientProgress

public DownloadSessionModel.Builder 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.

setState

public DownloadSessionModel.Builder 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.

setExpirationTime

public DownloadSessionModel.Builder 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.

build

public DownloadSessionModel build()