VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::content::library::ItemModel::Builder Class Reference

Builder class for ItemModel. More...

List of all members.

Public Member Functions

 Builder ()
 Constructor with parameters for the required properties of ItemModel.
Builder SetId (string id)
 A unique identifier for this library item.
Builder SetLibraryId (string libraryId)
 The identifier of the vmware.content.LibraryModel to which this item belongs.
Builder SetContentVersion (string contentVersion)
 The latest version of the file content list of this library item.
Builder SetCreationTime (global::System.DateTimeOffset?creationTime)
 The date and time when this library item was created.
Builder SetDescription (string description)
 A human-readable description for this library item.
Builder SetLastModifiedTime (global::System.DateTimeOffset?lastModifiedTime)
 The date and time when the metadata for this library item was last changed.
Builder SetLastSyncTime (global::System.DateTimeOffset?lastSyncTime)
 The date and time when this library item was last synchronized.
Builder SetMetadataVersion (string metadataVersion)
 A version number for the metadata of this library item.
Builder SetName (string name)
 A human-readable name for this library item.
Builder SetCached (bool?cached)
 The status that indicates whether the library item is on disk or not.
Builder SetSize (long?size)
 The library item size, in bytes.
Builder SetType (string type)
 An optional type identifier which indicates the type adapter plugin to use.
Builder SetVersion (string version)
 A version number that is updated on metadata changes.
Builder SetSourceId (string sourceId)
 The identifier of the ItemModel to which this item is synchronized to if the item belongs to a subscribed library.
ItemModel Build ()

Detailed Description

Builder class for ItemModel.


Constructor & Destructor Documentation

vmware::content::library::ItemModel::Builder::Builder ( ) [inline]

Constructor with parameters for the required properties of ItemModel.


Member Function Documentation

ItemModel vmware::content::library::ItemModel::Builder::Build ( ) [inline]
Builder vmware::content::library::ItemModel::Builder::SetCached ( bool?  cached) [inline]

The status that indicates whether the library item is on disk or not.

The library item is cached when all its files are on disk.

Builder vmware::content::library::ItemModel::Builder::SetContentVersion ( string  contentVersion) [inline]

The latest version of the file content list of this library item.

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.Version . 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.Version .

Builder vmware::content::library::ItemModel::Builder::SetCreationTime ( global::System.DateTimeOffset?  creationTime) [inline]

The date and time when this library item was created.

Builder vmware::content::library::ItemModel::Builder::SetDescription ( string  description) [inline]

A human-readable description for this library item.

Builder vmware::content::library::ItemModel::Builder::SetId ( string  id) [inline]

A unique identifier for this library item.

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 .

Builder vmware::content::library::ItemModel::Builder::SetLastModifiedTime ( global::System.DateTimeOffset?  lastModifiedTime) [inline]

The date and time when the metadata for this library item was last changed.

This field is affected by changes to the properties or file content of this item. It is not modified by changes to the tags of the item, or by changes to the library which owns this item.

Builder vmware::content::library::ItemModel::Builder::SetLastSyncTime ( global::System.DateTimeOffset?  lastSyncTime) [inline]

The date and time when this library item was last synchronized.

This field is updated every time a synchronization is triggered on the library item, including when a synchronization is triggered on the library to which this item belongs. The value is null for a library item that belongs to a local library.

Builder vmware::content::library::ItemModel::Builder::SetLibraryId ( string  libraryId) [inline]

The identifier of the vmware.content.LibraryModel to which this item belongs.

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 . 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 .

Builder vmware::content::library::ItemModel::Builder::SetMetadataVersion ( string  metadataVersion) [inline]

A version number for the metadata of this library item.

This value is incremented with each change to the metadata of this item. Changes to name, description, and so on will increment this value. The value is not incremented by changes to the content or tags of the item or the library which owns it.

Builder vmware::content::library::ItemModel::Builder::SetName ( string  name) [inline]

A human-readable name for this library item.

The name may not be null or an empty string. The name does not have to be unique, even within the same library.

Builder vmware::content::library::ItemModel::Builder::SetSize ( long?  size) [inline]

The library item size, in bytes.

The size is the sum of the size used on the storage backing for all the files in the item. When the library item is not cached, the size is 0.

Builder vmware::content::library::ItemModel::Builder::SetSourceId ( string  sourceId) [inline]

The identifier of the ItemModel to which this item is synchronized to if the item belongs to a subscribed library.

The value is null for a library item that belongs to a local library. 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 .

Builder vmware::content::library::ItemModel::Builder::SetType ( string  type) [inline]

An optional type identifier which indicates the type adapter plugin to use.

This field may be set to a non-empty string value that corresponds to an identifier supported by a type adapter plugin present in the Content Library Service. A type adapter plugin, if present for the specified type, can provide additional information and services around the item content. A type adapter can guide the upload process by creating file entries that are in need of being uploaded to complete an item.

The types and plugins supported by the Content Library Service can be queried using the vmware.content.Type interface.

Builder vmware::content::library::ItemModel::Builder::SetVersion ( string  version) [inline]

A version number that is updated on metadata changes.

This value is used to validate update requests to provide optimistic concurrency of changes.

This value represents a number that is incremented every time library item properties, such as name or description, are changed. It is not incremented by changes to the file content of the library item, including adding or removing files. It is also not affected by tagging the library item.


The documentation for this class was generated from the following file: