com.vmware.content

Class LibraryModel

java.lang.Object

com.vmware.content.LibraryModel

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

public final class LibraryModel
extends java.lang.Object
implements java.io.Serializable, StaticStructure

The LibraryModel class represents a Content Library resource model.

A LibraryModel is a container for a set of items which represent a usable set of files. The Content Library Service allows for multiple libraries to be created with separate authorization and sharing policies.

Each LibraryModel is a container for a set of ItemModel instances. Each item is a logical object in a library, which may have multiple files.

A LibraryModel may be local or subscribed. A local library has its source of truth about items within this Content Library Service. Items may be added to or removed from the library. A local library may also be private or published. When published, the library is exposed by a network endpoint and can be used by another Content Library Service for synchronization. A private local library cannot be used for synchronization.

A subscribed library is a library which gets its source of truth from another library that may be across a network in another Content Library Service. A subscribed library may have a different name and metadata from the library to which it subscribes, but the set of library items is always the same as those in the source library. Library items cannot be manually added to a subscribed library -- they can only be added by adding new items to the source library.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LibraryModel.Builder Builder class for LibraryModel.
static class	LibraryModel.LibraryType The LibraryType enumeration class defines the type of a LibraryModel.

Field Summary

Fields

Modifier and Type	Field and Description
protected StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	LibraryModel() Default constructor.
protected	LibraryModel(StructValue __dynamicStructureFields)

Method Summary

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 LibraryModel	_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 LibraryModel	_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.util.Calendar	getCreationTime() The date and time when this library was created.
java.lang.String	getDescription() A human-readable description for this library.
java.lang.String	getId() An identifier which uniquely identifies this LibraryModel.
java.util.Calendar	getLastModifiedTime() The date and time when this library was last updated.
java.util.Calendar	getLastSyncTime() The date and time when this library was last synchronized.
java.lang.String	getName() The name of the library.
OptimizationInfo	getOptimizationInfo() Defines various optimizations and optimization parameters applied to this library.
PublishInfo	getPublishInfo() Defines how this library is published so that it can be subscribed to by a remote subscribed library.
java.lang.String	getServerGuid() The unique identifier of the vCenter server where the library exists.
java.util.List<StorageBacking>	getStorageBackings() The list of default storage backings which are available for this library.
SubscriptionInfo	getSubscriptionInfo() Defines the subscription behavior for this Library.
LibraryModel.LibraryType	getType() The type (LOCAL, SUBSCRIBED) of this library.
java.lang.String	getVersion() A version number which is updated on metadata changes.
int	hashCode()
void	setCreationTime(java.util.Calendar creationTime) The date and time when this library was created.
void	setDescription(java.lang.String description) A human-readable description for this library.
void	setId(java.lang.String id) An identifier which uniquely identifies this LibraryModel.
void	setLastModifiedTime(java.util.Calendar lastModifiedTime) The date and time when this library was last updated.
void	setLastSyncTime(java.util.Calendar lastSyncTime) The date and time when this library was last synchronized.
void	setName(java.lang.String name) The name of the library.
void	setOptimizationInfo(OptimizationInfo optimizationInfo) Defines various optimizations and optimization parameters applied to this library.
void	setPublishInfo(PublishInfo publishInfo) Defines how this library is published so that it can be subscribed to by a remote subscribed library.
void	setServerGuid(java.lang.String serverGuid) The unique identifier of the vCenter server where the library exists.
void	setStorageBackings(java.util.List<StorageBacking> storageBackings) The list of default storage backings which are available for this library.
void	setSubscriptionInfo(SubscriptionInfo subscriptionInfo) Defines the subscription behavior for this Library.
void	setType(LibraryModel.LibraryType type) The type (LOCAL, SUBSCRIBED) of this library.
void	setVersion(java.lang.String version) A version number which 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 StructValue __dynamicStructureFields

Constructor Detail

LibraryModel

public LibraryModel()

Default constructor.

LibraryModel

protected LibraryModel(StructValue __dynamicStructureFields)

Method Detail

getId

public java.lang.String getId()

An identifier which uniquely identifies this LibraryModel. 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. 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.

setId

public void setId(java.lang.String id)

An identifier which uniquely identifies this LibraryModel. 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. 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.

getCreationTime

public java.util.Calendar getCreationTime()

The date and time when this library 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 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. 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 should be left unchanged.

Returns:

The current value of the property.

setDescription

public void setDescription(java.lang.String description)

A human-readable description for this library. 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 should be left unchanged.

Parameters:

description - New value for the property.

getLastModifiedTime

public java.util.Calendar getLastModifiedTime()

The date and time when this library was last updated.

This property is updated automatically when the library properties are changed. This property is not affected by adding, removing, or modifying a library item or its content within the library. Tagging the library or syncing the subscribed library does not alter this property.

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 this library was last updated.

This property is updated automatically when the library properties are changed. This property is not affected by adding, removing, or modifying a library item or its content within the library. Tagging the library or syncing the subscribed library does not alter this property.

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 was last synchronized.

This property applies only to subscribed libraries. It is updated every time a synchronization is triggered on the library. The value is null for 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 was last synchronized.

This property applies only to subscribed libraries. It is updated every time a synchronization is triggered on the library. The value is null for 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.

getName

public java.lang.String getName()

The name of the library.

A Library is identified by a human-readable name. Library names cannot be undefined or an empty string. Names do not have to be unique.

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)

The name of the library.

A Library is identified by a human-readable name. Library names cannot be undefined or an empty string. Names do not have to be unique.

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.

getStorageBackings

public java.util.List<StorageBacking> getStorageBackings()

The list of default storage backings which are available for this library.

A StorageBacking defines a default storage location which can be used to store files for library items in this library. Some library items, for instance, virtual machine template items, support files that may be distributed across various storage backings. One or more item files may or may not be located on the default storage backing.

Multiple default storage locations are not currently supported but may become supported in future releases.

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.

setStorageBackings

public void setStorageBackings(java.util.List<StorageBacking> storageBackings)

The list of default storage backings which are available for this library.

A StorageBacking defines a default storage location which can be used to store files for library items in this library. Some library items, for instance, virtual machine template items, support files that may be distributed across various storage backings. One or more item files may or may not be located on the default storage backing.

Multiple default storage locations are not currently supported but may become supported in future releases.

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:

storageBackings - New value for the property.

getType

public LibraryModel.LibraryType getType()

The type (LOCAL, SUBSCRIBED) of this library.

This value can be used to determine what additional services and information can be available for this library. This property is not used for the create and update methods. It will always be present in the result of a get method.

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.

setType

public void setType(LibraryModel.LibraryType type)

The type (LOCAL, SUBSCRIBED) of this library.

This value can be used to determine what additional services and information can be available for this library. This property is not used for the create and update methods. It will always be present in the result of a get method.

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:

type - New value for the property.

getOptimizationInfo

public OptimizationInfo getOptimizationInfo()

Defines various optimizations and optimization parameters applied to this library. 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.

setOptimizationInfo

public void setOptimizationInfo(OptimizationInfo optimizationInfo)

Defines various optimizations and optimization parameters applied to this library. 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:

optimizationInfo - New value for the property.

getVersion

public java.lang.String getVersion()

A version number which is updated on metadata changes. This value allows clients to detect concurrent updates and prevent accidental clobbering of data.

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

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 which is updated on metadata changes. This value allows clients to detect concurrent updates and prevent accidental clobbering of data.

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

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.

getPublishInfo

public PublishInfo getPublishInfo()

Defines how this library is published so that it can be subscribed to by a remote subscribed library.

The PublishInfo defines where and how the metadata for this local library is accessible. A local library is only published publically if PublishInfo.getPublished() is true.

This property is optional for the create and update methods. If not specified during creation, the default is for the library to not be published. If not specified during update, the property is left unchanged.

Returns:

The current value of the property.

setPublishInfo

public void setPublishInfo(PublishInfo publishInfo)

Defines how this library is published so that it can be subscribed to by a remote subscribed library.

The PublishInfo defines where and how the metadata for this local library is accessible. A local library is only published publically if PublishInfo.getPublished() is true.

This property is optional for the create and update methods. If not specified during creation, the default is for the library to not be published. If not specified during update, the property is left unchanged.

Parameters:

publishInfo - New value for the property.

getSubscriptionInfo

public SubscriptionInfo getSubscriptionInfo()

Defines the subscription behavior for this Library.

The SubscriptionInfo defines how this subscribed library synchronizes to a remote source. Setting the value will determine the remote source to which the library synchronizes, and how. Changing the subscription will result in synchronizing to a new source. If the new source differs from the old one, the old library items and data will be lost. Setting SubscriptionInfo.getAutomaticSyncEnabled() to false will halt subscription but will not remove existing cached data.

This property is optional for the create and update methods. If not specified during creation, a default will be created without an active subscription. If not specified during update, the property is left unchanged.

Returns:

The current value of the property.

setSubscriptionInfo

public void setSubscriptionInfo(SubscriptionInfo subscriptionInfo)

Defines the subscription behavior for this Library.

The SubscriptionInfo defines how this subscribed library synchronizes to a remote source. Setting the value will determine the remote source to which the library synchronizes, and how. Changing the subscription will result in synchronizing to a new source. If the new source differs from the old one, the old library items and data will be lost. Setting SubscriptionInfo.getAutomaticSyncEnabled() to false will halt subscription but will not remove existing cached data.

This property is optional for the create and update methods. If not specified during creation, a default will be created without an active subscription. If not specified during update, the property is left unchanged.

Parameters:

subscriptionInfo - New value for the property.

getServerGuid

public java.lang.String getServerGuid()

The unique identifier of the vCenter server where the library exists. This property is optional 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.vcenter.VCenter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vcenter.VCenter.

setServerGuid

public void setServerGuid(java.lang.String serverGuid)

The unique identifier of the vCenter server where the library exists. This property is optional 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:

serverGuid - 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.vcenter.VCenter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vcenter.VCenter.

_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 LibraryModel _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 LibraryModel _newInstance2(StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.