com.vmware.content.library

Interface Item

All Superinterfaces:

ItemTypes, Service

All Known Implementing Classes:

ItemStub

public interface Item
extends Service, ItemTypes

The Item interface provides methods for managing library items.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.content.library.ItemTypes

ItemTypes.DestinationSpec, ItemTypes.FindSpec

Field Summary

Fields inherited from interface com.vmware.content.library.ItemTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	copy(java.lang.String clientToken, java.lang.String sourceLibraryItemId, ItemModel destinationCreateSpec) Copies a library item.
void	copy(java.lang.String clientToken, java.lang.String sourceLibraryItemId, ItemModel destinationCreateSpec, AsyncCallback<java.lang.String> asyncCallback) Copies a library item.
void	copy(java.lang.String clientToken, java.lang.String sourceLibraryItemId, ItemModel destinationCreateSpec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Copies a library item.
java.lang.String	copy(java.lang.String clientToken, java.lang.String sourceLibraryItemId, ItemModel destinationCreateSpec, InvocationConfig invocationConfig) Copies a library item.
java.lang.String	create(java.lang.String clientToken, ItemModel createSpec) Creates a new library item.
void	create(java.lang.String clientToken, ItemModel createSpec, AsyncCallback<java.lang.String> asyncCallback) Creates a new library item.
void	create(java.lang.String clientToken, ItemModel createSpec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a new library item.
java.lang.String	create(java.lang.String clientToken, ItemModel createSpec, InvocationConfig invocationConfig) Creates a new library item.
void	delete(java.lang.String libraryItemId) Deletes a library item.
void	delete(java.lang.String libraryItemId, AsyncCallback<java.lang.Void> asyncCallback) Deletes a library item.
void	delete(java.lang.String libraryItemId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes a library item.
void	delete(java.lang.String libraryItemId, InvocationConfig invocationConfig) Deletes a library item.
java.util.List<java.lang.String>	find(ItemTypes.FindSpec spec) Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested ItemTypes.FindSpec.
void	find(ItemTypes.FindSpec spec, AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested ItemTypes.FindSpec.
void	find(ItemTypes.FindSpec spec, AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested ItemTypes.FindSpec.
java.util.List<java.lang.String>	find(ItemTypes.FindSpec spec, InvocationConfig invocationConfig) Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested ItemTypes.FindSpec.
ItemModel	get(java.lang.String libraryItemId) Returns the ItemModel with the given identifier.
void	get(java.lang.String libraryItemId, AsyncCallback<ItemModel> asyncCallback) Returns the ItemModel with the given identifier.
void	get(java.lang.String libraryItemId, AsyncCallback<ItemModel> asyncCallback, InvocationConfig invocationConfig) Returns the ItemModel with the given identifier.
ItemModel	get(java.lang.String libraryItemId, InvocationConfig invocationConfig) Returns the ItemModel with the given identifier.
java.util.List<java.lang.String>	list(java.lang.String libraryId) Returns the identifiers of all items in the given library.
void	list(java.lang.String libraryId, AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Returns the identifiers of all items in the given library.
void	list(java.lang.String libraryId, AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers of all items in the given library.
java.util.List<java.lang.String>	list(java.lang.String libraryId, InvocationConfig invocationConfig) Returns the identifiers of all items in the given library.
void	publish(java.lang.String libraryItemId, boolean forceSyncContent, java.util.List<ItemTypes.DestinationSpec> subscriptions) Publishes the library item to specified subscriptions of the library.
void	publish(java.lang.String libraryItemId, boolean forceSyncContent, java.util.List<ItemTypes.DestinationSpec> subscriptions, AsyncCallback<java.lang.Void> asyncCallback) Publishes the library item to specified subscriptions of the library.
void	publish(java.lang.String libraryItemId, boolean forceSyncContent, java.util.List<ItemTypes.DestinationSpec> subscriptions, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Publishes the library item to specified subscriptions of the library.
void	publish(java.lang.String libraryItemId, boolean forceSyncContent, java.util.List<ItemTypes.DestinationSpec> subscriptions, InvocationConfig invocationConfig) Publishes the library item to specified subscriptions of the library.
void	update(java.lang.String libraryItemId, ItemModel updateSpec) Updates the specified properties of a library item.
void	update(java.lang.String libraryItemId, ItemModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback) Updates the specified properties of a library item.
void	update(java.lang.String libraryItemId, ItemModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the specified properties of a library item.
void	update(java.lang.String libraryItemId, ItemModel updateSpec, InvocationConfig invocationConfig) Updates the specified properties of a library item.

Method Detail

copy

java.lang.String copy(java.lang.String clientToken,
                      java.lang.String sourceLibraryItemId,
                      ItemModel destinationCreateSpec)

Copies a library item.

Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task.

If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator.

A library item cannot be copied into a subscribed library.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

clientToken - A unique token generated on the client for each copy request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent copy. If not specified copy is not idempotent.

sourceLibraryItemId - Identifier of the existing library item from which the content will be copied. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

destinationCreateSpec - Specification for the new library item to be created.

Returns:

The identifier of the new library item into which the content is being copied. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Throws:

NotFound - if the library item with sourceLibraryItemId does not exist, or if the library referenced by the ItemModel.getLibraryId() property of destinationCreateSpec does not exist.

InvalidArgument - if one of the following is true for the new library item:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters

InvalidArgument - if the clientToken does not conform to the UUID format.

InvalidElementType - if the ItemModel.getLibraryId() property of destinationCreateSpec refers to a subscribed library.

ResourceInaccessible - if the copy operation failed because the source or destination library item is not accessible.

NotAllowedInCurrentState - if the content of the source library item specified by sourceLibraryItemId, or the content of the target library specified by the library ID (see ItemModel.getLibraryId()) property of destinationCreateSpec has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter sourceLibraryItemId requires System.Read.
• The resource com.vmware.content.Library referenced by the property ItemModel.getLibraryId() requires ContentLibrary.AddLibraryItem.

copy

java.lang.String copy(java.lang.String clientToken,
                      java.lang.String sourceLibraryItemId,
                      ItemModel destinationCreateSpec,
                      InvocationConfig invocationConfig)

Copies a library item.

Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task.

If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator.

A library item cannot be copied into a subscribed library.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

clientToken - A unique token generated on the client for each copy request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent copy. If not specified copy is not idempotent.

sourceLibraryItemId - Identifier of the existing library item from which the content will be copied. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

destinationCreateSpec - Specification for the new library item to be created.

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the new library item into which the content is being copied. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Throws:

NotFound - if the library item with sourceLibraryItemId does not exist, or if the library referenced by the ItemModel.getLibraryId() property of destinationCreateSpec does not exist.

InvalidArgument - if one of the following is true for the new library item:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters

InvalidArgument - if the clientToken does not conform to the UUID format.

InvalidElementType - if the ItemModel.getLibraryId() property of destinationCreateSpec refers to a subscribed library.

ResourceInaccessible - if the copy operation failed because the source or destination library item is not accessible.

NotAllowedInCurrentState - if the content of the source library item specified by sourceLibraryItemId, or the content of the target library specified by the library ID (see ItemModel.getLibraryId()) property of destinationCreateSpec has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter sourceLibraryItemId requires System.Read.
• The resource com.vmware.content.Library referenced by the property ItemModel.getLibraryId() requires ContentLibrary.AddLibraryItem.

copy

void copy(java.lang.String clientToken,
          java.lang.String sourceLibraryItemId,
          ItemModel destinationCreateSpec,
          AsyncCallback<java.lang.String> asyncCallback)

Copies a library item.

Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task.

If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator.

A library item cannot be copied into a subscribed library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The identifier of the new library item into which the content is being copied. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Operation Errors:
NotFound - if the library item with sourceLibraryItemId does not exist, or if the library referenced by the ItemModel.getLibraryId() property of destinationCreateSpec does not exist.
InvalidArgument - if one of the following is true for the new library item:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters

InvalidArgument - if the clientToken does not conform to the UUID format.
InvalidElementType - if the ItemModel.getLibraryId() property of destinationCreateSpec refers to a subscribed library.
ResourceInaccessible - if the copy operation failed because the source or destination library item is not accessible.
NotAllowedInCurrentState - if the content of the source library item specified by sourceLibraryItemId, or the content of the target library specified by the library ID (see ItemModel.getLibraryId()) property of destinationCreateSpec has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter sourceLibraryItemId requires System.Read.
• The resource com.vmware.content.Library referenced by the property ItemModel.getLibraryId() requires ContentLibrary.AddLibraryItem.

Parameters:

clientToken - A unique token generated on the client for each copy request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent copy. If not specified copy is not idempotent.

sourceLibraryItemId - Identifier of the existing library item from which the content will be copied. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

destinationCreateSpec - Specification for the new library item to be created.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

copy

void copy(java.lang.String clientToken,
          java.lang.String sourceLibraryItemId,
          ItemModel destinationCreateSpec,
          AsyncCallback<java.lang.String> asyncCallback,
          InvocationConfig invocationConfig)

Copies a library item.

Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task.

If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator.

A library item cannot be copied into a subscribed library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The identifier of the new library item into which the content is being copied. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Operation Errors:
NotFound - if the library item with sourceLibraryItemId does not exist, or if the library referenced by the ItemModel.getLibraryId() property of destinationCreateSpec does not exist.
InvalidArgument - if one of the following is true for the new library item:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters

InvalidArgument - if the clientToken does not conform to the UUID format.
InvalidElementType - if the ItemModel.getLibraryId() property of destinationCreateSpec refers to a subscribed library.
ResourceInaccessible - if the copy operation failed because the source or destination library item is not accessible.
NotAllowedInCurrentState - if the content of the source library item specified by sourceLibraryItemId, or the content of the target library specified by the library ID (see ItemModel.getLibraryId()) property of destinationCreateSpec has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter sourceLibraryItemId requires System.Read.
• The resource com.vmware.content.Library referenced by the property ItemModel.getLibraryId() requires ContentLibrary.AddLibraryItem.

Parameters:

clientToken - A unique token generated on the client for each copy request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent copy. If not specified copy is not idempotent.

sourceLibraryItemId - Identifier of the existing library item from which the content will be copied. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

destinationCreateSpec - Specification for the new library item to be created.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

create

java.lang.String create(java.lang.String clientToken,
                        ItemModel createSpec)

Creates a new library item.

A new library item is created without any content. After creation, content can be added through the UpdateSession and File interfaces.

A library item cannot be created in a subscribed library.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.

createSpec - Specification that defines the properties of the new library item.

Returns:

Identifier of the new library item. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Throws:

NotFound - if the ItemModel.getLibraryId() property of createSpec refers to a library that does not exist.

InvalidArgument - if one of the following is true for the new library item:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters

InvalidArgument - if the clientToken does not conform to the UUID format.

InvalidElementType - if the ItemModel.getLibraryId() property of createSpec refers to a subscribed library.

NotAllowedInCurrentState - if the content of the library specified by the library ID (see ItemModel.getLibraryId()) property of createSpec has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

AlreadyExists - if there is already a library item with same name in the library.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the property ItemModel.getLibraryId() requires ContentLibrary.AddLibraryItem.

create

java.lang.String create(java.lang.String clientToken,
                        ItemModel createSpec,
                        InvocationConfig invocationConfig)

Creates a new library item.

A new library item is created without any content. After creation, content can be added through the UpdateSession and File interfaces.

A library item cannot be created in a subscribed library.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.

createSpec - Specification that defines the properties of the new library item.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the new library item. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Throws:

NotFound - if the ItemModel.getLibraryId() property of createSpec refers to a library that does not exist.

InvalidArgument - if one of the following is true for the new library item:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters

InvalidArgument - if the clientToken does not conform to the UUID format.

InvalidElementType - if the ItemModel.getLibraryId() property of createSpec refers to a subscribed library.

NotAllowedInCurrentState - if the content of the library specified by the library ID (see ItemModel.getLibraryId()) property of createSpec has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

AlreadyExists - if there is already a library item with same name in the library.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the property ItemModel.getLibraryId() requires ContentLibrary.AddLibraryItem.

create

void create(java.lang.String clientToken,
            ItemModel createSpec,
            AsyncCallback<java.lang.String> asyncCallback)

Creates a new library item.

A new library item is created without any content. After creation, content can be added through the UpdateSession and File interfaces.

A library item cannot be created in a subscribed library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Identifier of the new library item. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Operation Errors:
NotFound - if the ItemModel.getLibraryId() property of createSpec refers to a library that does not exist.
InvalidArgument - if one of the following is true for the new library item:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters

InvalidArgument - if the clientToken does not conform to the UUID format.
InvalidElementType - if the ItemModel.getLibraryId() property of createSpec refers to a subscribed library.
NotAllowedInCurrentState - if the content of the library specified by the library ID (see ItemModel.getLibraryId()) property of createSpec has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.
AlreadyExists - if there is already a library item with same name in the library.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the property ItemModel.getLibraryId() requires ContentLibrary.AddLibraryItem.

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.

createSpec - Specification that defines the properties of the new library item.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

void create(java.lang.String clientToken,
            ItemModel createSpec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Creates a new library item.

A new library item is created without any content. After creation, content can be added through the UpdateSession and File interfaces.

A library item cannot be created in a subscribed library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Identifier of the new library item. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Operation Errors:
NotFound - if the ItemModel.getLibraryId() property of createSpec refers to a library that does not exist.
InvalidArgument - if one of the following is true for the new library item:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters

InvalidArgument - if the clientToken does not conform to the UUID format.
InvalidElementType - if the ItemModel.getLibraryId() property of createSpec refers to a subscribed library.
NotAllowedInCurrentState - if the content of the library specified by the library ID (see ItemModel.getLibraryId()) property of createSpec has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.
AlreadyExists - if there is already a library item with same name in the library.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the property ItemModel.getLibraryId() requires ContentLibrary.AddLibraryItem.

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.

createSpec - Specification that defines the properties of the new library item.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String libraryItemId)

Deletes a library item.

This method will immediately remove the item from the library that owns it. The content of the item will be asynchronously removed from the storage backings. The content deletion can be tracked with a task. In the event that the task fails, an administrator may need to manually remove the files from the storage backing.

This method cannot be used to delete a library item that is a member of a subscribed library. Removing an item from a subscribed library requires deleting the item from the original published local library and syncing the subscribed library.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

libraryItemId - Identifier of the library item to delete. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

Throws:

InvalidElementType - if the library item with the given libraryItemId is a member of a subscribed library.

NotFound - if the library item with the specified libraryItemId does not exist.

NotAllowedInCurrentState - if the library item contains a virtual machine template and a virtual machine is checked out of the library item.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.DeleteLibraryItem.

delete

void delete(java.lang.String libraryItemId,
            InvocationConfig invocationConfig)

Deletes a library item.

This method will immediately remove the item from the library that owns it. The content of the item will be asynchronously removed from the storage backings. The content deletion can be tracked with a task. In the event that the task fails, an administrator may need to manually remove the files from the storage backing.

This method cannot be used to delete a library item that is a member of a subscribed library. Removing an item from a subscribed library requires deleting the item from the original published local library and syncing the subscribed library.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

libraryItemId - Identifier of the library item to delete. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

invocationConfig - Configuration for the method invocation.

Throws:

InvalidElementType - if the library item with the given libraryItemId is a member of a subscribed library.

NotFound - if the library item with the specified libraryItemId does not exist.

NotAllowedInCurrentState - if the library item contains a virtual machine template and a virtual machine is checked out of the library item.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.DeleteLibraryItem.

delete

void delete(java.lang.String libraryItemId,
            AsyncCallback<java.lang.Void> asyncCallback)

Deletes a library item.

This method will immediately remove the item from the library that owns it. The content of the item will be asynchronously removed from the storage backings. The content deletion can be tracked with a task. In the event that the task fails, an administrator may need to manually remove the files from the storage backing.

This method cannot be used to delete a library item that is a member of a subscribed library. Removing an item from a subscribed library requires deleting the item from the original published local library and syncing the subscribed library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidElementType - if the library item with the given libraryItemId is a member of a subscribed library.
NotFound - if the library item with the specified libraryItemId does not exist.
NotAllowedInCurrentState - if the library item contains a virtual machine template and a virtual machine is checked out of the library item.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.DeleteLibraryItem.

Parameters:

libraryItemId - Identifier of the library item to delete. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(java.lang.String libraryItemId,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Deletes a library item.

This method will immediately remove the item from the library that owns it. The content of the item will be asynchronously removed from the storage backings. The content deletion can be tracked with a task. In the event that the task fails, an administrator may need to manually remove the files from the storage backing.

This method cannot be used to delete a library item that is a member of a subscribed library. Removing an item from a subscribed library requires deleting the item from the original published local library and syncing the subscribed library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidElementType - if the library item with the given libraryItemId is a member of a subscribed library.
NotFound - if the library item with the specified libraryItemId does not exist.
NotAllowedInCurrentState - if the library item contains a virtual machine template and a virtual machine is checked out of the library item.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.DeleteLibraryItem.

Parameters:

libraryItemId - Identifier of the library item to delete. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

ItemModel get(java.lang.String libraryItemId)

Returns the ItemModel with the given identifier.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

libraryItemId - Identifier of the library item to return. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

Returns:

The ItemModel instance with the given libraryItemId.

Throws:

NotFound - if no item with the given libraryItemId exists.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

get

ItemModel get(java.lang.String libraryItemId,
              InvocationConfig invocationConfig)

Returns the ItemModel with the given identifier.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

libraryItemId - Identifier of the library item to return. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

invocationConfig - Configuration for the method invocation.

Returns:

The ItemModel instance with the given libraryItemId.

Throws:

NotFound - if no item with the given libraryItemId exists.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

get

void get(java.lang.String libraryItemId,
         AsyncCallback<ItemModel> asyncCallback)

Returns the ItemModel with the given identifier.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The ItemModel instance with the given libraryItemId.

Operation Errors:
NotFound - if no item with the given libraryItemId exists.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

Parameters:

libraryItemId - Identifier of the library item to return. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String libraryItemId,
         AsyncCallback<ItemModel> asyncCallback,
         InvocationConfig invocationConfig)

Returns the ItemModel with the given identifier.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The ItemModel instance with the given libraryItemId.

Operation Errors:
NotFound - if no item with the given libraryItemId exists.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.

Parameters:

libraryItemId - Identifier of the library item to return. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

java.util.List<java.lang.String> list(java.lang.String libraryId)

Returns the identifiers of all items in the given library.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

libraryId - Identifier of the library whose items should be returned. The parameter must be an identifier for the resource type: com.vmware.content.Library.

Returns:

The List of identifiers of the items in the library specified by libraryId. The return value will contain identifiers for the resource type: com.vmware.content.library.Item.

Throws:

NotFound - if the library associated with libraryId does not exist.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

list

java.util.List<java.lang.String> list(java.lang.String libraryId,
                                      InvocationConfig invocationConfig)

Returns the identifiers of all items in the given library.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

libraryId - Identifier of the library whose items should be returned. The parameter must be an identifier for the resource type: com.vmware.content.Library.

invocationConfig - Configuration for the method invocation.

Returns:

The List of identifiers of the items in the library specified by libraryId. The return value will contain identifiers for the resource type: com.vmware.content.library.Item.

Throws:

NotFound - if the library associated with libraryId does not exist.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

list

void list(java.lang.String libraryId,
          AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Returns the identifiers of all items in the given library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The List of identifiers of the items in the library specified by libraryId. The return value will contain identifiers for the resource type: com.vmware.content.library.Item.

Operation Errors:
NotFound - if the library associated with libraryId does not exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

Parameters:

libraryId - Identifier of the library whose items should be returned. The parameter must be an identifier for the resource type: com.vmware.content.Library.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(java.lang.String libraryId,
          AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
          InvocationConfig invocationConfig)

Returns the identifiers of all items in the given library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The List of identifiers of the items in the library specified by libraryId. The return value will contain identifiers for the resource type: com.vmware.content.library.Item.

Operation Errors:
NotFound - if the library associated with libraryId does not exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

Parameters:

libraryId - Identifier of the library whose items should be returned. The parameter must be an identifier for the resource type: com.vmware.content.Library.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

find

java.util.List<java.lang.String> find(ItemTypes.FindSpec spec)

Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested ItemTypes.FindSpec.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

spec - Specification describing what properties to filter on.

Returns:

The List of identifiers of all the visible library items matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.library.Item.

Throws:

InvalidArgument - if no properties are specified in the spec.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The resource com.vmware.content.Library referenced by the property ItemTypes.FindSpec.getLibraryId() requires System.Read.

find

java.util.List<java.lang.String> find(ItemTypes.FindSpec spec,
                                      InvocationConfig invocationConfig)

Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested ItemTypes.FindSpec.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - Specification describing what properties to filter on.

invocationConfig - Configuration for the method invocation.

Returns:

The List of identifiers of all the visible library items matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.library.Item.

Throws:

InvalidArgument - if no properties are specified in the spec.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The resource com.vmware.content.Library referenced by the property ItemTypes.FindSpec.getLibraryId() requires System.Read.

find

void find(ItemTypes.FindSpec spec,
          AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested ItemTypes.FindSpec.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The List of identifiers of all the visible library items matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.library.Item.

Operation Errors:
InvalidArgument - if no properties are specified in the spec.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The resource com.vmware.content.Library referenced by the property ItemTypes.FindSpec.getLibraryId() requires System.Read.

Parameters:

spec - Specification describing what properties to filter on.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

find

void find(ItemTypes.FindSpec spec,
          AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
          InvocationConfig invocationConfig)

Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested ItemTypes.FindSpec.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The List of identifiers of all the visible library items matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.library.Item.

Operation Errors:
InvalidArgument - if no properties are specified in the spec.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.
• The resource com.vmware.content.Library referenced by the property ItemTypes.FindSpec.getLibraryId() requires System.Read.

Parameters:

spec - Specification describing what properties to filter on.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String libraryItemId,
            ItemModel updateSpec)

Updates the specified properties of a library item.

This is an incremental update to the library item. Properties that are null in the update specification are left unchanged.

This method cannot update a library item that is a member of a subscribed library. Those items must be updated in the source published library and synchronized to the subscribed library.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

libraryItemId - Identifier of the library item to update. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

updateSpec - Specification of the properties to set.

Throws:

NotFound - if the library item specified by libraryItemId does not exist.

InvalidElementType - if the library item corresponding to libraryItemId is a member of a subscribed library.

InvalidArgument - if one of the following is true for the updateSpec:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters
• version is not equal to the current version of the library item

NotAllowedInCurrentState - if the library item belongs to a published library with JSON persistence enabled (see PublishInfo.getPersistJsonEnabled()) and the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

AlreadyExists - if there is already a library item with same name in the library.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.UpdateLibraryItem.

update

void update(java.lang.String libraryItemId,
            ItemModel updateSpec,
            InvocationConfig invocationConfig)

Updates the specified properties of a library item.

This is an incremental update to the library item. Properties that are null in the update specification are left unchanged.

This method cannot update a library item that is a member of a subscribed library. Those items must be updated in the source published library and synchronized to the subscribed library.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

libraryItemId - Identifier of the library item to update. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

updateSpec - Specification of the properties to set.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the library item specified by libraryItemId does not exist.

InvalidElementType - if the library item corresponding to libraryItemId is a member of a subscribed library.

InvalidArgument - if one of the following is true for the updateSpec:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters
• version is not equal to the current version of the library item

NotAllowedInCurrentState - if the library item belongs to a published library with JSON persistence enabled (see PublishInfo.getPersistJsonEnabled()) and the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

AlreadyExists - if there is already a library item with same name in the library.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.UpdateLibraryItem.

update

void update(java.lang.String libraryItemId,
            ItemModel updateSpec,
            AsyncCallback<java.lang.Void> asyncCallback)

Updates the specified properties of a library item.

This is an incremental update to the library item. Properties that are null in the update specification are left unchanged.

This method cannot update a library item that is a member of a subscribed library. Those items must be updated in the source published library and synchronized to the subscribed library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if the library item specified by libraryItemId does not exist.
InvalidElementType - if the library item corresponding to libraryItemId is a member of a subscribed library.
InvalidArgument - if one of the following is true for the updateSpec:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters
• version is not equal to the current version of the library item

NotAllowedInCurrentState - if the library item belongs to a published library with JSON persistence enabled (see PublishInfo.getPersistJsonEnabled()) and the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.
AlreadyExists - if there is already a library item with same name in the library.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.UpdateLibraryItem.

Parameters:

libraryItemId - Identifier of the library item to update. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

updateSpec - Specification of the properties to set.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

void update(java.lang.String libraryItemId,
            ItemModel updateSpec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Updates the specified properties of a library item.

This is an incremental update to the library item. Properties that are null in the update specification are left unchanged.

This method cannot update a library item that is a member of a subscribed library. Those items must be updated in the source published library and synchronized to the subscribed library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if the library item specified by libraryItemId does not exist.
InvalidElementType - if the library item corresponding to libraryItemId is a member of a subscribed library.
InvalidArgument - if one of the following is true for the updateSpec:

• name is empty
• name exceeds 80 characters
• description exceeds 2000 characters
• version is not equal to the current version of the library item

NotAllowedInCurrentState - if the library item belongs to a published library with JSON persistence enabled (see PublishInfo.getPersistJsonEnabled()) and the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.
AlreadyExists - if there is already a library item with same name in the library.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.UpdateLibraryItem.

Parameters:

libraryItemId - Identifier of the library item to update. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

updateSpec - Specification of the properties to set.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

publish

void publish(java.lang.String libraryItemId,
             boolean forceSyncContent,
             java.util.List<ItemTypes.DestinationSpec> subscriptions)

Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

libraryItemId - Library item identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

forceSyncContent - Whether to synchronize file content as well as metadata. This parameter applies only if the subscription is on-demand.

subscriptions - The list of subscriptions to publish this library item to.

Throws:

Error - If the system reports an error while responding to the request.

NotFound - If the library item specified by libraryItemId does not exist.

InvalidArgument - If one or more arguments in subscriptions is not valid.

InvalidElementType - If the library item specified by libraryItemId is a member of a subscribed library.

NotAllowedInCurrentState - If the library item specified by libraryItemId does not belong to a published library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.PublishLibraryItem.

publish

void publish(java.lang.String libraryItemId,
             boolean forceSyncContent,
             java.util.List<ItemTypes.DestinationSpec> subscriptions,
             InvocationConfig invocationConfig)

Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

libraryItemId - Library item identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

forceSyncContent - Whether to synchronize file content as well as metadata. This parameter applies only if the subscription is on-demand.

subscriptions - The list of subscriptions to publish this library item to.

invocationConfig - Configuration for the method invocation.

Throws:

Error - If the system reports an error while responding to the request.

NotFound - If the library item specified by libraryItemId does not exist.

InvalidArgument - If one or more arguments in subscriptions is not valid.

InvalidElementType - If the library item specified by libraryItemId is a member of a subscribed library.

NotAllowedInCurrentState - If the library item specified by libraryItemId does not belong to a published library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.PublishLibraryItem.

publish

void publish(java.lang.String libraryItemId,
             boolean forceSyncContent,
             java.util.List<ItemTypes.DestinationSpec> subscriptions,
             AsyncCallback<java.lang.Void> asyncCallback)

Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - If the system reports an error while responding to the request.
NotFound - If the library item specified by libraryItemId does not exist.
InvalidArgument - If one or more arguments in subscriptions is not valid.
InvalidElementType - If the library item specified by libraryItemId is a member of a subscribed library.
NotAllowedInCurrentState - If the library item specified by libraryItemId does not belong to a published library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.PublishLibraryItem.

Parameters:

libraryItemId - Library item identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

forceSyncContent - Whether to synchronize file content as well as metadata. This parameter applies only if the subscription is on-demand.

subscriptions - The list of subscriptions to publish this library item to.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

publish

void publish(java.lang.String libraryItemId,
             boolean forceSyncContent,
             java.util.List<ItemTypes.DestinationSpec> subscriptions,
             AsyncCallback<java.lang.Void> asyncCallback,
             InvocationConfig invocationConfig)

Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - If the system reports an error while responding to the request.
NotFound - If the library item specified by libraryItemId does not exist.
InvalidArgument - If one or more arguments in subscriptions is not valid.
InvalidElementType - If the library item specified by libraryItemId is a member of a subscribed library.
NotAllowedInCurrentState - If the library item specified by libraryItemId does not belong to a published library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.PublishLibraryItem.

Parameters:

libraryItemId - Library item identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

forceSyncContent - Whether to synchronize file content as well as metadata. This parameter applies only if the subscription is on-demand.

subscriptions - The list of subscriptions to publish this library item to.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.