|
VMware vSphere Automation SDK for .NET 7.0.0.1
|
|
VMware vSphere Automation SDK for .NET 7.0.0.1
|
The UpdateSessionModel class provides information on an active UpdateSession resource.
More...
Classes | |
| class | Builder |
| Builder class for UpdateSessionModel. More... | |
| class | State |
| The state of an update session. More... | |
Public Member Functions | |
| UpdateSessionModel () | |
| Generate all-fields constructor only for errors and standard structures that have relevant fields. | |
| string | GetId () |
| The identifier of this update session. | |
| void | SetId (string id) |
| The identifier of this update session. | |
| string | GetLibraryItemId () |
| The identifier of the library item to which content will be uploaded or removed. | |
| void | SetLibraryItemId (string libraryItemId) |
| The identifier of the library item to which content will be uploaded or removed. | |
| string | GetLibraryItemContentVersion () |
| The content version of the library item whose content is being modified. | |
| void | SetLibraryItemContentVersion (string libraryItemContentVersion) |
| The content version of the library item whose content is being modified. | |
| vmware.vapi.std.LocalizableMessage | GetErrorMessage () |
| If the session is in the UpdateSessionModel.State.ERROR status this property will have more details about the error. | |
| void | SetErrorMessage (vmware.vapi.std.LocalizableMessage errorMessage) |
| If the session is in the UpdateSessionModel.State.ERROR status this property will have more details about the error. | |
| long | GetClientProgress () |
| The progress that has been made with the upload. | |
| void | SetClientProgress (long?clientProgress) |
| The progress that has been made with the upload. | |
| vmware.content.library.item.UpdateSessionModel.State | GetState () |
| The current state ( ACTIVE, DONE, ERROR, CANCELED) of the update session. | |
| void | SetState (vmware.content.library.item.UpdateSessionModel.State state) |
| The current state ( ACTIVE, DONE, ERROR, CANCELED) of the update session. | |
| global::System.DateTimeOffset | GetExpirationTime () |
| Indicates the time after which the session will expire. | |
| void | SetExpirationTime (global::System.DateTimeOffset?expirationTime) |
| Indicates the time after which the session will expire. | |
| vmware.content.library.item.updatesession.PreviewInfo | GetPreviewInfo () |
| A preview of the files currently being uploaded in the session. | |
| void | SetPreviewInfo (vmware.content.library.item.updatesession.PreviewInfo previewInfo) |
| A preview of the files currently being uploaded in the session. | |
| global::System.Collections.Generic.List < vmware.content.library.item.updatesession.WarningBehavior > | GetWarningBehavior () |
| Indicates the update session behavior if warnings are raised in the session preview. | |
| void | SetWarningBehavior (global::System.Collections.Generic.List< vmware.content.library.item.updatesession.WarningBehavior > warningBehavior) |
| Indicates the update session behavior if warnings are raised in the session preview. | |
| vmware.vapi.bindings.type.StructType | _GetType () |
| vmware.vapi.data.StructValue | _GetDataValue () |
| void | _Validate () |
| bool | _HasTypeNameOf< T > () |
| T | _ConvertTo< T > () |
| override bool | Equals (object obj) |
| override int | GetHashCode () |
| override string | ToString () |
The UpdateSessionModel class provides information on an active UpdateSession resource.
| vmware::content::library::item::UpdateSessionModel::UpdateSessionModel | ( | ) | [inline] |
Generate all-fields constructor only for errors and standard structures that have relevant fields.
Creates a default new instance.
| T vmware::content::library::item::UpdateSessionModel::_ConvertTo< T > | ( | ) | [inline] |
| T | : | vmware.vapi.bindings.IStructure |
| vmware.vapi.data.StructValue vmware::content::library::item::UpdateSessionModel::_GetDataValue | ( | ) | [inline] |
| vmware.vapi.bindings.type.StructType vmware::content::library::item::UpdateSessionModel::_GetType | ( | ) | [inline] |
| bool vmware::content::library::item::UpdateSessionModel::_HasTypeNameOf< T > | ( | ) | [inline] |
| T | : | vmware.vapi.bindings.IStructure |
| void vmware::content::library::item::UpdateSessionModel::_Validate | ( | ) | [inline] |
| override bool vmware::content::library::item::UpdateSessionModel::Equals | ( | object | obj | ) | [inline] |
| long vmware::content::library::item::UpdateSessionModel::GetClientProgress | ( | ) | [inline] |
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.
| vmware.vapi.std.LocalizableMessage vmware::content::library::item::UpdateSessionModel::GetErrorMessage | ( | ) | [inline] |
If the session is in the UpdateSessionModel.State.ERROR status this property will have more details about the error.
| global::System.DateTimeOffset vmware::content::library::item::UpdateSessionModel::GetExpirationTime | ( | ) | [inline] |
Indicates the time after which the session will expire.
The session is guaranteed not to expire earlier than this time.
| override int vmware::content::library::item::UpdateSessionModel::GetHashCode | ( | ) | [inline] |
| string vmware::content::library::item::UpdateSessionModel::GetId | ( | ) | [inline] |
The identifier of this update session.
When clients pass a value of this class as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession . When methods return a value of this class as a result, the field will be an identifier for the resource type: com.vmware.content.library.item.UpdateSession .
| string vmware::content::library::item::UpdateSessionModel::GetLibraryItemContentVersion | ( | ) | [inline] |
The content version of the library item whose content is being modified.
This value is the vmware.content.library.ItemModel.contentVersion at the time when the session is created for the library item.
| string vmware::content::library::item::UpdateSessionModel::GetLibraryItemId | ( | ) | [inline] |
The identifier of the library item to which content will be uploaded or removed.
When clients pass a value of this class as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item . When methods return a value of this class as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item .
| vmware.content.library.item.updatesession.PreviewInfo vmware::content::library::item::UpdateSessionModel::GetPreviewInfo | ( | ) | [inline] |
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 attribute was added in vSphere API 6.8.
| vmware.content.library.item.UpdateSessionModel.State vmware::content::library::item::UpdateSessionModel::GetState | ( | ) | [inline] |
The current state ( ACTIVE, DONE, ERROR, CANCELED) of the update session.
This attribute was added in vSphere API 6.8.
| global::System.Collections.Generic.List<vmware.content.library.item.updatesession.WarningBehavior> vmware::content::library::item::UpdateSessionModel::GetWarningBehavior | ( | ) | [inline] |
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 attribute was added in vSphere API 6.8.
| void vmware::content::library::item::UpdateSessionModel::SetClientProgress | ( | long? | clientProgress | ) | [inline] |
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.
| void vmware::content::library::item::UpdateSessionModel::SetErrorMessage | ( | vmware.vapi.std.LocalizableMessage | errorMessage | ) | [inline] |
If the session is in the UpdateSessionModel.State.ERROR status this property will have more details about the error.
| void vmware::content::library::item::UpdateSessionModel::SetExpirationTime | ( | global::System.DateTimeOffset? | expirationTime | ) | [inline] |
Indicates the time after which the session will expire.
The session is guaranteed not to expire earlier than this time.
| void vmware::content::library::item::UpdateSessionModel::SetId | ( | string | id | ) | [inline] |
The identifier of this update session.
When clients pass a value of this class as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession . When methods return a value of this class as a result, the field will be an identifier for the resource type: com.vmware.content.library.item.UpdateSession .
| void vmware::content::library::item::UpdateSessionModel::SetLibraryItemContentVersion | ( | string | libraryItemContentVersion | ) | [inline] |
The content version of the library item whose content is being modified.
This value is the vmware.content.library.ItemModel.contentVersion at the time when the session is created for the library item.
| void vmware::content::library::item::UpdateSessionModel::SetLibraryItemId | ( | string | libraryItemId | ) | [inline] |
The identifier of the library item to which content will be uploaded or removed.
When clients pass a value of this class as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item . When methods return a value of this class as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item .
| void vmware::content::library::item::UpdateSessionModel::SetPreviewInfo | ( | vmware.content.library.item.updatesession.PreviewInfo | previewInfo | ) | [inline] |
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 attribute was added in vSphere API 6.8.
| void vmware::content::library::item::UpdateSessionModel::SetState | ( | vmware.content.library.item.UpdateSessionModel.State | state | ) | [inline] |
The current state ( ACTIVE, DONE, ERROR, CANCELED) of the update session.
This attribute was added in vSphere API 6.8.
| void vmware::content::library::item::UpdateSessionModel::SetWarningBehavior | ( | global::System.Collections.Generic.List< vmware.content.library.item.updatesession.WarningBehavior > | warningBehavior | ) | [inline] |
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 attribute was added in vSphere API 6.8.
| override string vmware::content::library::item::UpdateSessionModel::ToString | ( | ) | [inline] |
