com.vmware.content.library.item

Class UpdateSessionModel.Builder

java.lang.Object

com.vmware.content.library.item.UpdateSessionModel.Builder

Enclosing class:

UpdateSessionModel

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

Builder class for UpdateSessionModel.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
UpdateSessionModel	build()
UpdateSessionModel.Builder	setClientProgress(java.lang.Long clientProgress) The progress that has been made with the upload.
UpdateSessionModel.Builder	setErrorMessage(LocalizableMessage errorMessage) If the session is in the UpdateSessionModel.State.ERROR status this property will have more details about the error.
UpdateSessionModel.Builder	setExpirationTime(java.util.Calendar expirationTime) Indicates the time after which the session will expire.
UpdateSessionModel.Builder	setId(java.lang.String id) The identifier of this update session.
UpdateSessionModel.Builder	setLibraryItemContentVersion(java.lang.String libraryItemContentVersion) The content version of the library item whose content is being modified.
UpdateSessionModel.Builder	setLibraryItemId(java.lang.String libraryItemId) The identifier of the library item to which content will be uploaded or removed.
UpdateSessionModel.Builder	setPreviewInfo(PreviewInfo previewInfo) A preview of the files currently being uploaded in the session.
UpdateSessionModel.Builder	setState(UpdateSessionModel.State state) The current state (ACTIVE, DONE, ERROR, CANCELED) of the update session.
UpdateSessionModel.Builder	setWarningBehavior(java.util.List<WarningBehavior> warningBehavior) Indicates the update session behavior if warnings are raised in the session preview.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of UpdateSessionModel.

Method Detail

setId

public UpdateSessionModel.Builder setId(java.lang.String id)

The identifier of this update 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.UpdateSession. 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.UpdateSession.

setLibraryItemId

public UpdateSessionModel.Builder setLibraryItemId(java.lang.String libraryItemId)

The identifier of the library item to which content will be uploaded or removed. 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 UpdateSessionModel.Builder setLibraryItemContentVersion(java.lang.String libraryItemContentVersion)

The content version of the library item whose content is being modified. 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 UpdateSessionModel.Builder setErrorMessage(LocalizableMessage errorMessage)

If the session is in the UpdateSessionModel.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 UpdateSessionModel.Builder setClientProgress(java.lang.Long clientProgress)

The progress that has been made with the upload. This property is to be updated by the client during the upload process to indicate the progress of its work in completing the upload. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the update 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 not used for the update method.

Parameters:

clientProgress - New value for the property.

setState

public UpdateSessionModel.Builder setState(UpdateSessionModel.State state)

The current state (ACTIVE, DONE, ERROR, CANCELED) of the update session. This property was added in vSphere API 6.8. 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 UpdateSessionModel.Builder setExpirationTime(java.util.Calendar expirationTime)

Indicates the time after which the session will expire. The session is guaranteed not to expire earlier than 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.

setPreviewInfo

public UpdateSessionModel.Builder setPreviewInfo(PreviewInfo previewInfo)

A preview of the files currently being uploaded in the session. This property will be set only when the session is in the UpdateSessionModel.State.ACTIVE. This property was added in vSphere API 6.8. This property is optional and it is only relevant when the value of getState() is UpdateSessionModel.State.ACTIVE.

Parameters:

previewInfo - New value for the property.

setWarningBehavior

public UpdateSessionModel.Builder setWarningBehavior(java.util.List<WarningBehavior> warningBehavior)

Indicates the update session behavior if warnings are raised in the session preview. Any warning which is raised by session preview but not ignored by the client will, by default, fail the update session. This property was added in vSphere API 6.8. This property is optional for the create method. It is optional in the return value of the get or list methods. It is optional for the update method.

Parameters:

warningBehavior - New value for the property.

build

public UpdateSessionModel build()