com.vmware.content

Class LibraryModel.Builder

java.lang.Object

com.vmware.content.LibraryModel.Builder

Enclosing class:

LibraryModel

public static final class LibraryModel.Builder
extends Object

Builder class for LibraryModel.

Constructor Summary

Constructors

Constructor and Description
LibraryModel.Builder() Constructor with parameters for the required properties of LibraryModel.

Method Summary

Methods

Modifier and Type	Method and Description
LibraryModel	build()
LibraryModel.Builder	setCreationTime(Calendar creationTime) The date and time when this library was created.
LibraryModel.Builder	setDescription(String description) A human-readable description for this library.
LibraryModel.Builder	setId(String id) An identifier which uniquely identifies this LibraryModel.
LibraryModel.Builder	setLastModifiedTime(Calendar lastModifiedTime) The date and time when this library was last updated.
LibraryModel.Builder	setLastSyncTime(Calendar lastSyncTime) The date and time when this library was last synchronized.
LibraryModel.Builder	setName(String name) The name of the library.
LibraryModel.Builder	setOptimizationInfo(OptimizationInfo optimizationInfo) Defines various optimizations and optimization parameters applied to this library.
LibraryModel.Builder	setPublishInfo(PublishInfo publishInfo) Defines how this library is published so that it can be subscribed to by a remote subscribed library.
LibraryModel.Builder	setServerGuid(String serverGuid) The unique identifier of the vCenter server where the library exists.
LibraryModel.Builder	setStorageBackings(List<StorageBacking> storageBackings) The list of storage backings which are available for this library.
LibraryModel.Builder	setSubscriptionInfo(SubscriptionInfo subscriptionInfo) Defines the subscription behavior for this Library.
LibraryModel.Builder	setType(LibraryModel.LibraryType type) The type (LOCAL, SUBSCRIBED) of this library.
LibraryModel.Builder	setVersion(String version) A version number which is updated on metadata changes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LibraryModel.Builder

public LibraryModel.Builder()

Constructor with parameters for the required properties of LibraryModel.

Method Detail

setId

public LibraryModel.Builder setId(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.

setCreationTime

public LibraryModel.Builder setCreationTime(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.

setDescription

public LibraryModel.Builder setDescription(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.

setLastModifiedTime

public LibraryModel.Builder setLastModifiedTime(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.

setLastSyncTime

public LibraryModel.Builder setLastSyncTime(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.

setName

public LibraryModel.Builder setName(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.

setStorageBackings

public LibraryModel.Builder setStorageBackings(List<StorageBacking> storageBackings)

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

A StorageBacking defines a storage location which can be used to store files for the library items in this library. Multiple 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.

setType

public LibraryModel.Builder 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 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:

type - New value for the property.

setOptimizationInfo

public LibraryModel.Builder 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.

setVersion

public LibraryModel.Builder setVersion(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.

setPublishInfo

public LibraryModel.Builder 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.

setSubscriptionInfo

public LibraryModel.Builder 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.

setServerGuid

public LibraryModel.Builder setServerGuid(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.

build

public LibraryModel build()