UpdateSessionModel (vSphere Automation SDK for Java 7.0.1.0)

java.lang.Object
- com.vmware.content.library.item.UpdateSessionModel

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable
```
public final class UpdateSessionModel
extends java.lang.Object
implements java.io.Serializable, StaticStructure
```
The UpdateSessionModel class provides information on an active UpdateSession resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UpdateSessionModel.Builder` Builder class for `UpdateSessionModel`.
`static class`	`UpdateSessionModel.State` The state of an update session.

Field Summary

Fields
Modifier and Type Field and Description

protected StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

UpdateSessionModel()
Default constructor.

protected UpdateSessionModel(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`UpdateSessionModel()` Default constructor.
`protected`	`UpdateSessionModel(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_convertTo(java.lang.Class<T> clazz)` Converts this structure into an instance of the provided class structure if possible.
`java.lang.String`	`_getCanonicalName()` Returns the canonical name of the structure.
`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.
`StructValue`	`_getDataValue()` Returns this `Structure` represented in the dynamic `DataValue` model.
`DataValue`	`_getDynamicField(java.lang.String fieldName)` Get dynamic filed value.
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()` Get the names of the dynamic fields in the structure.
`com.vmware.vapi.bindings.type.StructType`	`_getType()` WARNING: Internal method, subject to change in future versions.
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)` Checks if the runtime type name of this structure matches the type represented by the specified binding class.
`static UpdateSessionModel`	`_newInstance(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 UpdateSessionModel`	`_newInstance2(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, DataValue fieldValue)` Sets a dynamic field value.
`protected void`	`_updateDataValue(StructValue structValue)`
`void`	`_validate()` Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding `Structure`.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Long`	`getClientProgress()` The progress that has been made with the upload.
`LocalizableMessage`	`getErrorMessage()` If the session is in the `UpdateSessionModel.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 update session.
`java.lang.String`	`getLibraryItemContentVersion()` The content version of the library item whose content is being modified.
`java.lang.String`	`getLibraryItemId()` The identifier of the library item to which content will be uploaded or removed.
`PreviewInfo`	`getPreviewInfo()` A preview of the files currently being uploaded in the session.
`UpdateSessionModel.State`	`getState()` The current state (ACTIVE, DONE, ERROR, CANCELED) of the update session.
`java.util.List<WarningBehavior>`	`getWarningBehavior()` Indicates the update session behavior if warnings are raised in the session preview.
`int`	`hashCode()`
`void`	`setClientProgress(java.lang.Long clientProgress)` The progress that has been made with the upload.
`void`	`setErrorMessage(LocalizableMessage errorMessage)` If the session is in the `UpdateSessionModel.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 update session.
`void`	`setLibraryItemContentVersion(java.lang.String libraryItemContentVersion)` The content version of the library item whose content is being modified.
`void`	`setLibraryItemId(java.lang.String libraryItemId)` The identifier of the library item to which content will be uploaded or removed.
`void`	`setPreviewInfo(PreviewInfo previewInfo)` A preview of the files currently being uploaded in the session.
`void`	`setState(UpdateSessionModel.State state)` The current state (ACTIVE, DONE, ERROR, CANCELED) of the update session.
`void`	`setWarningBehavior(java.util.List<WarningBehavior> warningBehavior)` Indicates the update session behavior if warnings are raised in the session preview.
`java.lang.String`	`toString()` Returns a string representation of this structure.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - UpdateSessionModel
```
public UpdateSessionModel()
```
    Default constructor.
  - UpdateSessionModel
```
protected UpdateSessionModel(StructValue __dynamicStructureFields)
```
- Method Detail
  - getId
```
public java.lang.String getId()
```
    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.
    
    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.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.
  - setId
```
public void 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.
  - getLibraryItemId
```
public java.lang.String getLibraryItemId()
```
    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.
    
    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 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.
  - getLibraryItemContentVersion
```
public java.lang.String getLibraryItemContentVersion()
```
    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.
    
    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 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.
  - getErrorMessage
```
public LocalizableMessage getErrorMessage()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setErrorMessage
```
public void 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.
  - getClientProgress
```
public java.lang.Long getClientProgress()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setClientProgress
```
public void 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.
  - getState
```
public UpdateSessionModel.State getState()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setState
```
public void 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.
  - getExpirationTime
```
public java.util.Calendar getExpirationTime()
```
    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.
    
    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 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.
  - getPreviewInfo
```
public PreviewInfo getPreviewInfo()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setPreviewInfo
```
public void 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.
  - getWarningBehavior
```
public java.util.List<WarningBehavior> getWarningBehavior()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setWarningBehavior
```
public void 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.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    Returns this Structure represented in the dynamic DataValue model.
    Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    
    StructValue representing this structure
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
    More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface 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()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.
This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo
```
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
```
Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(java.lang.String fieldName)
```
Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_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()
```
Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance
```
public static UpdateSessionModel _newInstance(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 UpdateSessionModel _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class UpdateSessionModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

UpdateSessionModel

UpdateSessionModel

Method Detail

getId

setId

getLibraryItemId

setLibraryItemId

getLibraryItemContentVersion

setLibraryItemContentVersion

getErrorMessage

setErrorMessage

getClientProgress

setClientProgress

getState

setState

getExpirationTime

setExpirationTime

getPreviewInfo

setPreviewInfo

getWarningBehavior

setWarningBehavior

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2