ItemModel (VMware-vSphere-Automation-SDK-Java)

java.lang.Object
- com.vmware.content.library.ItemModel

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable
```
public final class ItemModel
extends java.lang.Object
implements java.io.Serializable, StaticStructure
```
The ItemModel class represents a library item that has been stored in a library.
A ItemModel represents a single logical unit to be managed within a LibraryModel. Items contain the actual content of a library, and their placement within a library determines policies that affect that content such as publishing.

A library item can have a specified type, indicated with the getType() property. This property is associated with a Content Library Service plugin that supports specific types and provides additional services. The types available in a specific Content Library Service can be queried using the Type interface. Items of an unknown or unspecified type are treated generically. Because subscribed library catalogs are synchronized as is, subscribing to a remote Content Library Service effectively gives you a library with the functionality of the remote service's type adapter plugins, even if they are not installed locally.

Items can be managed using the Item interface and, for items in subscribed libraries, the SubscribedItem interface.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ItemModel.Builder
Builder class for ItemModel.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ItemModel.Builder` Builder class for `ItemModel`.

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

ItemModel()
Default constructor.

protected ItemModel(StructValue __dynamicStructureFields)

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

Method Summary

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 that the runtime type name matches the type name from the binding class.
`static ItemModel`	`_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.
`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.Boolean`	`getCached()` The status that indicates whether the library item is on disk or not.
`java.lang.String`	`getContentVersion()` The version of the file content list of this library item.
`java.util.Calendar`	`getCreationTime()` The date and time when this library item was created.
`java.lang.String`	`getDescription()` A human-readable description for this library item.
`java.lang.String`	`getId()` A unique identifier for this library item.
`java.util.Calendar`	`getLastModifiedTime()` The date and time when the metadata for this library item was last changed.
`java.util.Calendar`	`getLastSyncTime()` The date and time when this library item was last synchronized.
`java.lang.String`	`getLibraryId()` The identifier of the `LibraryModel` to which this item belongs.
`java.lang.String`	`getMetadataVersion()` A version number for the metadata of this library item.
`java.lang.String`	`getName()` A human-readable name for this library item.
`java.lang.Long`	`getSize()` The library item size, in bytes.
`java.lang.String`	`getSourceId()` The identifier of the `ItemModel` to which this item is synchronized to if the item belongs to a subscribed library.
`java.lang.String`	`getType()` An optional type identifier which indicates the type adapter plugin to use.
`java.lang.String`	`getVersion()` A version number that is updated on metadata changes.
`int`	`hashCode()`
`void`	`setCached(java.lang.Boolean cached)` The status that indicates whether the library item is on disk or not.
`void`	`setContentVersion(java.lang.String contentVersion)` The version of the file content list of this library item.
`void`	`setCreationTime(java.util.Calendar creationTime)` The date and time when this library item was created.
`void`	`setDescription(java.lang.String description)` A human-readable description for this library item.
`void`	`setId(java.lang.String id)` A unique identifier for this library item.
`void`	`setLastModifiedTime(java.util.Calendar lastModifiedTime)` The date and time when the metadata for this library item was last changed.
`void`	`setLastSyncTime(java.util.Calendar lastSyncTime)` The date and time when this library item was last synchronized.
`void`	`setLibraryId(java.lang.String libraryId)` The identifier of the `LibraryModel` to which this item belongs.
`void`	`setMetadataVersion(java.lang.String metadataVersion)` A version number for the metadata of this library item.
`void`	`setName(java.lang.String name)` A human-readable name for this library item.
`void`	`setSize(java.lang.Long size)` The library item size, in bytes.
`void`	`setSourceId(java.lang.String sourceId)` The identifier of the `ItemModel` to which this item is synchronized to if the item belongs to a subscribed library.
`void`	`setType(java.lang.String type)` An optional type identifier which indicates the type adapter plugin to use.
`void`	`setVersion(java.lang.String version)` A version number that is updated on metadata changes.
`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 final StructValue __dynamicStructureFields
```
- Constructor Detail
  - ItemModel
```
public ItemModel()
```
    Default constructor.
  - ItemModel
```
protected ItemModel(StructValue __dynamicStructureFields)
```
- Method Detail
  - getId
```
public java.lang.String getId()
```
    A unique identifier for this library item. 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. 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.
  - setId
```
public void setId(java.lang.String id)
```
    A unique identifier for this library item. 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. 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.
  - getLibraryId
```
public java.lang.String getLibraryId()
```
    The identifier of the LibraryModel to which this item belongs. 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. 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.
  - setLibraryId
```
public void setLibraryId(java.lang.String libraryId)
```
    The identifier of the LibraryModel to which this item belongs. 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:
    libraryId - 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. 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.
  - getContentVersion
```
public java.lang.String getContentVersion()
```
    The version of the file content list of this 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.
  - setContentVersion
```
public void setContentVersion(java.lang.String contentVersion)
```
    The version of the file content list of this 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:
    contentVersion - New value for the property.
  - getCreationTime
```
public java.util.Calendar getCreationTime()
```
    The date and time when this library item was created. 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.
  - setCreationTime
```
public void setCreationTime(java.util.Calendar creationTime)
```
    The date and time when this library item was created. 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:
    creationTime - New value for the property.
  - getDescription
```
public java.lang.String getDescription()
```
    A human-readable description for this library item. This property is optional for the create method. Leaving it null during creation will result in an empty string value. It will always be present in the result of a get or list method. It is optional for the update method. Leaving it null during update indicates that the description remains unchanged.
    
    Returns:
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    A human-readable description for this library item. This property is optional for the create method. Leaving it null during creation will result in an empty string value. It will always be present in the result of a get or list method. It is optional for the update method. Leaving it null during update indicates that the description remains unchanged.
    
    Parameters:
    description - New value for the property.
  - getLastModifiedTime
```
public java.util.Calendar getLastModifiedTime()
```
    The date and time when the metadata for this library item was last changed.
    This property 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.
    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.
  - setLastModifiedTime
```
public void setLastModifiedTime(java.util.Calendar lastModifiedTime)
```
    The date and time when the metadata for this library item was last changed.
    This property 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.
    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:
    lastModifiedTime - New value for the property.
  - getLastSyncTime
```
public java.util.Calendar getLastSyncTime()
```
    The date and time when this library item was last synchronized.
    This property 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.
    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.
  - setLastSyncTime
```
public void setLastSyncTime(java.util.Calendar lastSyncTime)
```
    The date and time when this library item was last synchronized.
    This property 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.
    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:
    lastSyncTime - New value for the property.
  - getMetadataVersion
```
public java.lang.String getMetadataVersion()
```
    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.
    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.
  - setMetadataVersion
```
public void setMetadataVersion(java.lang.String metadataVersion)
```
    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.
    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:
    metadataVersion - New value for the property.
  - getName
```
public java.lang.String getName()
```
    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.
    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 optional for the update method.
    
    Returns:
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    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.
    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 optional for the update method.
    
    Parameters:
    name - New value for the property.
  - getCached
```
public java.lang.Boolean getCached()
```
    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. 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.
  - setCached
```
public void setCached(java.lang.Boolean cached)
```
    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. 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:
    cached - New value for the property.
  - getSize
```
public java.lang.Long getSize()
```
    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. 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.
  - setSize
```
public void setSize(java.lang.Long size)
```
    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. 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:
    size - New value for the property.
  - getType
```
public java.lang.String getType()
```
    An optional type identifier which indicates the type adapter plugin to use.
    This property 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 Type interface.
    This property is optional for the create and update methods. During creation, if the type is left unspecified, or if the type is specified but does not have a corresponding type support plugin, then the type of the library item is considered to be generic and all data is treated as generic files. During update, if the type is not specified, then it is not updated.
    
    Returns:
    The current value of the property.
  - setType
```
public void setType(java.lang.String type)
```
    An optional type identifier which indicates the type adapter plugin to use.
    This property 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 Type interface.
    This property is optional for the create and update methods. During creation, if the type is left unspecified, or if the type is specified but does not have a corresponding type support plugin, then the type of the library item is considered to be generic and all data is treated as generic files. During update, if the type is not specified, then it is not updated.
    
    Parameters:
    type - New value for the property.
  - getVersion
```
public java.lang.String getVersion()
```
    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.
    This property is not used for the create method. It will always be present in the result of a get or list method. It is optional for the update method. Leaving it null during update indicates that you do not need to detect concurrent updates.
    
    Returns:
    The current value of the property.
  - setVersion
```
public void setVersion(java.lang.String version)
```
    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.
    This property is not used for the create method. It will always be present in the result of a get or list method. It is optional for the update method. Leaving it null during update indicates that you do not need to detect concurrent updates.
    
    Parameters:
    version - New value for the property.
  - getSourceId
```
public java.lang.String getSourceId()
```
    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. 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. 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.
  - setSourceId
```
public void setSourceId(java.lang.String sourceId)
```
    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. 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:
    sourceId - 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.
  - _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 that the runtime type name matches the type name from the binding class.

Specified by:

_hasTypeNameOf in interface Structure

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

Returns:
true if this structures type name matches exactly the provided 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 ItemModel _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

Class ItemModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

ItemModel

ItemModel

Method Detail

getId

setId

getLibraryId

setLibraryId

getContentVersion

setContentVersion

getCreationTime

setCreationTime

getDescription

setDescription

getLastModifiedTime

setLastModifiedTime

getLastSyncTime

setLastSyncTime

getMetadataVersion

setMetadataVersion

getName

setName

getCached

setCached

getSize

setSize

getType

setType

getVersion

setVersion

getSourceId

setSourceId

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance