com.vmware.content

Interface SubscribedLibrary

All Superinterfaces:

Service, SubscribedLibraryTypes

All Known Implementing Classes:

SubscribedLibraryStub

public interface SubscribedLibrary
extends Service, SubscribedLibraryTypes

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.content.SubscribedLibraryTypes

SubscribedLibraryTypes.ProbeResult

Field Summary

Fields inherited from interface com.vmware.content.SubscribedLibraryTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(java.lang.String clientToken, LibraryModel createSpec) Creates a new subscribed library.
void	create(java.lang.String clientToken, LibraryModel createSpec, AsyncCallback<java.lang.String> asyncCallback) Creates a new subscribed library.
void	create(java.lang.String clientToken, LibraryModel createSpec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a new subscribed library.
java.lang.String	create(java.lang.String clientToken, LibraryModel createSpec, InvocationConfig invocationConfig) Creates a new subscribed library.
void	delete(java.lang.String libraryId) Deletes the specified subscribed library.
void	delete(java.lang.String libraryId, AsyncCallback<java.lang.Void> asyncCallback) Deletes the specified subscribed library.
void	delete(java.lang.String libraryId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes the specified subscribed library.
void	delete(java.lang.String libraryId, InvocationConfig invocationConfig) Deletes the specified subscribed library.
void	evict(java.lang.String libraryId) Evicts the cached content of an on-demand subscribed library.
void	evict(java.lang.String libraryId, AsyncCallback<java.lang.Void> asyncCallback) Evicts the cached content of an on-demand subscribed library.
void	evict(java.lang.String libraryId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Evicts the cached content of an on-demand subscribed library.
void	evict(java.lang.String libraryId, InvocationConfig invocationConfig) Evicts the cached content of an on-demand subscribed library.
LibraryModel	get(java.lang.String libraryId) Returns a given subscribed library.
void	get(java.lang.String libraryId, AsyncCallback<LibraryModel> asyncCallback) Returns a given subscribed library.
void	get(java.lang.String libraryId, AsyncCallback<LibraryModel> asyncCallback, InvocationConfig invocationConfig) Returns a given subscribed library.
LibraryModel	get(java.lang.String libraryId, InvocationConfig invocationConfig) Returns a given subscribed library.
java.util.List<java.lang.String>	list() Returns the identifiers of all subscribed libraries in the Content Library.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Returns the identifiers of all subscribed libraries in the Content Library.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers of all subscribed libraries in the Content Library.
java.util.List<java.lang.String>	list(InvocationConfig invocationConfig) Returns the identifiers of all subscribed libraries in the Content Library.
SubscribedLibraryTypes.ProbeResult	probe(SubscriptionInfo subscriptionInfo) Probes remote library subscription information, including URL, SSL certificate and password.
void	probe(SubscriptionInfo subscriptionInfo, AsyncCallback<SubscribedLibraryTypes.ProbeResult> asyncCallback) Probes remote library subscription information, including URL, SSL certificate and password.
void	probe(SubscriptionInfo subscriptionInfo, AsyncCallback<SubscribedLibraryTypes.ProbeResult> asyncCallback, InvocationConfig invocationConfig) Probes remote library subscription information, including URL, SSL certificate and password.
SubscribedLibraryTypes.ProbeResult	probe(SubscriptionInfo subscriptionInfo, InvocationConfig invocationConfig) Probes remote library subscription information, including URL, SSL certificate and password.
void	sync(java.lang.String libraryId) Forces the synchronization of the subscribed library.
void	sync(java.lang.String libraryId, AsyncCallback<java.lang.Void> asyncCallback) Forces the synchronization of the subscribed library.
void	sync(java.lang.String libraryId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Forces the synchronization of the subscribed library.
void	sync(java.lang.String libraryId, InvocationConfig invocationConfig) Forces the synchronization of the subscribed library.
void	update(java.lang.String libraryId, LibraryModel updateSpec) Updates the properties of a subscribed library.
void	update(java.lang.String libraryId, LibraryModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback) Updates the properties of a subscribed library.
void	update(java.lang.String libraryId, LibraryModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the properties of a subscribed library.
void	update(java.lang.String libraryId, LibraryModel updateSpec, InvocationConfig invocationConfig) Updates the properties of a subscribed library.

Method Detail

create

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

Creates a new subscribed library.

Once created, the subscribed library will be empty. If the LibraryModel.getSubscriptionInfo() property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear.

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

Parameters:

clientToken - 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 for the new subscribed library.

Returns:

Identifier of the newly created subscribed library. The return value will be an identifier for the resource type: com.vmware.content.Library.

Throws:

InvalidArgument - if the createSpec is not valid.

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

Unsupported - if using multiple storage backings.

ResourceInaccessible - if subscribing to a published library which cannot be accessed.

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

• Method execution requires ContentLibrary.CreateSubscribedLibrary.
• The resource Datastore referenced by the property StorageBacking.getDatastoreId() requires Datastore.AllocateSpace.

create

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

Creates a new subscribed library.

Once created, the subscribed library will be empty. If the LibraryModel.getSubscriptionInfo() property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear.

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 - 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 for the new subscribed library.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the newly created subscribed library. The return value will be an identifier for the resource type: com.vmware.content.Library.

Throws:

InvalidArgument - if the createSpec is not valid.

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

Unsupported - if using multiple storage backings.

ResourceInaccessible - if subscribing to a published library which cannot be accessed.

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

• Method execution requires ContentLibrary.CreateSubscribedLibrary.
• The resource Datastore referenced by the property StorageBacking.getDatastoreId() requires Datastore.AllocateSpace.

create

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

Creates a new subscribed library.

Once created, the subscribed library will be empty. If the LibraryModel.getSubscriptionInfo() property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear.

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

Invocation Result:
Identifier of the newly created subscribed library. The return value will be an identifier for the resource type: com.vmware.content.Library.

Operation Errors:
InvalidArgument - if the createSpec is not valid.
InvalidArgument - if the clientToken does not conform to the UUID format.
Unsupported - if using multiple storage backings.
ResourceInaccessible - if subscribing to a published library which cannot be accessed.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.CreateSubscribedLibrary.
• The resource Datastore referenced by the property StorageBacking.getDatastoreId() requires Datastore.AllocateSpace.

Parameters:

clientToken - 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 for the new subscribed library.

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

create

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

Creates a new subscribed library.

Once created, the subscribed library will be empty. If the LibraryModel.getSubscriptionInfo() property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear.

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 newly created subscribed library. The return value will be an identifier for the resource type: com.vmware.content.Library.

Operation Errors:
InvalidArgument - if the createSpec is not valid.
InvalidArgument - if the clientToken does not conform to the UUID format.
Unsupported - if using multiple storage backings.
ResourceInaccessible - if subscribing to a published library which cannot be accessed.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.CreateSubscribedLibrary.
• The resource Datastore referenced by the property StorageBacking.getDatastoreId() requires Datastore.AllocateSpace.

Parameters:

clientToken - 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 for the new subscribed library.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String libraryId)

Deletes the specified subscribed library.

Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

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

Parameters:

libraryId - Identifier of the subscribed library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library.

Throws:

InvalidElementType - if the library referenced by libraryId is not a subscribed library.

NotFound - if the library referenced by 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 ContentLibrary.DeleteSubscribedLibrary.

delete

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

Deletes the specified subscribed library.

Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

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 subscribed library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library.

invocationConfig - Configuration for the method invocation.

Throws:

InvalidElementType - if the library referenced by libraryId is not a subscribed library.

NotFound - if the library referenced by 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 ContentLibrary.DeleteSubscribedLibrary.

delete

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

Deletes the specified subscribed library.

Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

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

Operation Errors:
InvalidElementType - if the library referenced by libraryId is not a subscribed library.
NotFound - if the library referenced by 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 ContentLibrary.DeleteSubscribedLibrary.

Parameters:

libraryId - Identifier of the subscribed library to delete. 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.

delete

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

Deletes the specified subscribed library.

Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

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 referenced by libraryId is not a subscribed library.
NotFound - if the library referenced by 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 ContentLibrary.DeleteSubscribedLibrary.

Parameters:

libraryId - Identifier of the subscribed library to delete. 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.

evict

void evict(java.lang.String libraryId)

Evicts the cached content of an on-demand subscribed library.

This method allows the cached content of a subscribed library to be removed to free up storage capacity. This method will only work when a subscribed library is synchronized on-demand.

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

Parameters:

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

Throws:

NotFound - if the library specified by libraryId does not exist.

InvalidElementType - if the library specified by libraryId is not a subscribed library.

NotAllowedInCurrentState - if the library specified by libraryId does not synchronize on-demand, or if the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

For instance, this {@term error) is reported on evicting an on-demand subscribed library that was restored from backup, and the library was deleted after the backup was taken, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library is present on a restore, while its content has been deleted.

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

evict

void evict(java.lang.String libraryId,
           InvocationConfig invocationConfig)

Evicts the cached content of an on-demand subscribed library.

This method allows the cached content of a subscribed library to be removed to free up storage capacity. This method will only work when a subscribed library is synchronized on-demand.

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 subscribed library whose content should be evicted. The parameter must be an identifier for the resource type: com.vmware.content.Library.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the library specified by libraryId does not exist.

InvalidElementType - if the library specified by libraryId is not a subscribed library.

NotAllowedInCurrentState - if the library specified by libraryId does not synchronize on-demand, or if the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

For instance, this {@term error) is reported on evicting an on-demand subscribed library that was restored from backup, and the library was deleted after the backup was taken, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library is present on a restore, while its content has been deleted.

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

evict

void evict(java.lang.String libraryId,
           AsyncCallback<java.lang.Void> asyncCallback)

Evicts the cached content of an on-demand subscribed library.

This method allows the cached content of a subscribed library to be removed to free up storage capacity. This method will only work when a subscribed library is synchronized on-demand.

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

Operation Errors:
NotFound - if the library specified by libraryId does not exist.
InvalidElementType - if the library specified by libraryId is not a subscribed library.
NotAllowedInCurrentState - if the library specified by libraryId does not synchronize on-demand, or if the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

For instance, this error) is reported on evicting an on-demand subscribed library that was restored from backup, and the library was deleted after the backup was taken, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library is present on a restore, while its content has been deleted.

{@link com.vmware.vapi.std.errors.Unauthorized} - if you do not have all of the privileges described as follows:

• The resource {@code com.vmware.content.Library} referenced by the parameter {@code libraryId} requires {@code ContentLibrary.EvictSubscribedLibrary}.

Parameters:

libraryId - Identifier of the subscribed library whose content should be evicted. 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.

evict

void evict(java.lang.String libraryId,
           AsyncCallback<java.lang.Void> asyncCallback,
           InvocationConfig invocationConfig)

Evicts the cached content of an on-demand subscribed library.

This method allows the cached content of a subscribed library to be removed to free up storage capacity. This method will only work when a subscribed library is synchronized on-demand.

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 specified by libraryId does not exist.
InvalidElementType - if the library specified by libraryId is not a subscribed library.
NotAllowedInCurrentState - if the library specified by libraryId does not synchronize on-demand, or if the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

For instance, this error) is reported on evicting an on-demand subscribed library that was restored from backup, and the library was deleted after the backup was taken, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library is present on a restore, while its content has been deleted.

{@link com.vmware.vapi.std.errors.Unauthorized} - if you do not have all of the privileges described as follows:

• The resource {@code com.vmware.content.Library} referenced by the parameter {@code libraryId} requires {@code ContentLibrary.EvictSubscribedLibrary}.

Parameters:

libraryId - Identifier of the subscribed library whose content should be evicted. 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.

get

LibraryModel get(java.lang.String libraryId)

Returns a given subscribed library.

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

Parameters:

libraryId - Identifier of the subscribed library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library.

Returns:

The LibraryModel instance that corresponds to libraryId.

Throws:

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

InvalidElementType - if the library associated with libraryId is not a subscribed library.

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.

get

LibraryModel get(java.lang.String libraryId,
                 InvocationConfig invocationConfig)

Returns a given 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:

libraryId - Identifier of the subscribed library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library.

invocationConfig - Configuration for the method invocation.

Returns:

The LibraryModel instance that corresponds to libraryId.

Throws:

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

InvalidElementType - if the library associated with libraryId is not a subscribed library.

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.

get

void get(java.lang.String libraryId,
         AsyncCallback<LibraryModel> asyncCallback)

Returns a given subscribed library.

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

Invocation Result:
The LibraryModel instance that corresponds to libraryId.

Operation Errors:
NotFound - if the library associated with libraryId does not exist.
InvalidElementType - if the library associated with libraryId is not a subscribed library.
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 subscribed library to return. 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.

get

void get(java.lang.String libraryId,
         AsyncCallback<LibraryModel> asyncCallback,
         InvocationConfig invocationConfig)

Returns a given 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 LibraryModel instance that corresponds to libraryId.

Operation Errors:
NotFound - if the library associated with libraryId does not exist.
InvalidElementType - if the library associated with libraryId is not a subscribed library.
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 subscribed library to return. 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.

list

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

Returns the identifiers of all subscribed libraries in the Content Library.

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

Returns:

The List of identifiers of all subscribed libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Throws:

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

• Method execution requires System.Read.

list

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

Returns the identifiers of all subscribed libraries in the Content 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:

invocationConfig - Configuration for the method invocation.

Returns:

The List of identifiers of all subscribed libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Throws:

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

• Method execution requires System.Read.

list

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

Returns the identifiers of all subscribed libraries in the Content Library.

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

Invocation Result:
The List of identifiers of all subscribed libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

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

• Method execution requires System.Read.

Parameters:

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

list

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

Returns the identifiers of all subscribed libraries in the Content 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 all subscribed libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

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

• Method execution requires System.Read.

Parameters:

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

invocationConfig - Configuration for the method invocation.

sync

void sync(java.lang.String libraryId)

Forces the synchronization of the subscribed library.

Synchronizing a subscribed library forcefully with this method will perform the same synchronization behavior as would run periodically for the library. The SubscriptionInfo.getOnDemand() setting is respected. Calling this method on a library that is already in the process of synchronizing will have no effect.

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

Parameters:

libraryId - Identifier of the subscribed library to synchronize. The parameter must be an identifier for the resource type: com.vmware.content.Library.

Throws:

NotFound - if the library specified by libraryId does not exist.

InvalidElementType - if the library specified by libraryId is not a subscribed library.

NotAllowedInCurrentState - if the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

For instance, this {@term error) is reported on synchronizing a subscribed library that was restored from backup, and the library was deleted after the backup was taken, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library is present on a restore, while its content has been deleted.

InvalidArgument - if some parameter in the subscribed library subscription info is invalid.

ResourceInaccessible - if the published library cannot be contacted or found.

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

sync

void sync(java.lang.String libraryId,
          InvocationConfig invocationConfig)

Forces the synchronization of the subscribed library.

Synchronizing a subscribed library forcefully with this method will perform the same synchronization behavior as would run periodically for the library. The SubscriptionInfo.getOnDemand() setting is respected. Calling this method on a library that is already in the process of synchronizing will have no effect.

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 subscribed library to synchronize. The parameter must be an identifier for the resource type: com.vmware.content.Library.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the library specified by libraryId does not exist.

InvalidElementType - if the library specified by libraryId is not a subscribed library.

NotAllowedInCurrentState - if the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

For instance, this {@term error) is reported on synchronizing a subscribed library that was restored from backup, and the library was deleted after the backup was taken, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library is present on a restore, while its content has been deleted.

InvalidArgument - if some parameter in the subscribed library subscription info is invalid.

ResourceInaccessible - if the published library cannot be contacted or found.

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

sync

void sync(java.lang.String libraryId,
          AsyncCallback<java.lang.Void> asyncCallback)

Forces the synchronization of the subscribed library.

Synchronizing a subscribed library forcefully with this method will perform the same synchronization behavior as would run periodically for the library. The SubscriptionInfo.getOnDemand() setting is respected. Calling this method on a library that is already in the process of synchronizing will have no effect.

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

Operation Errors:
NotFound - if the library specified by libraryId does not exist.
InvalidElementType - if the library specified by libraryId is not a subscribed library.
NotAllowedInCurrentState - if the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

For instance, this error) is reported on synchronizing a subscribed library that was restored from backup, and the library was deleted after the backup was taken, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library is present on a restore, while its content has been deleted.

{@link com.vmware.vapi.std.errors.InvalidArgument} - if some parameter in the subscribed library subscription info is invalid.
{@link com.vmware.vapi.std.errors.ResourceInaccessible} - if the published library cannot be contacted or found.
{@link com.vmware.vapi.std.errors.Unauthorized} - if you do not have all of the privileges described as follows:

• The resource {@code com.vmware.content.Library} referenced by the parameter {@code libraryId} requires {@code ContentLibrary.SyncLibrary}.

Parameters:

libraryId - Identifier of the subscribed library to synchronize. 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.

sync

void sync(java.lang.String libraryId,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Forces the synchronization of the subscribed library.

Synchronizing a subscribed library forcefully with this method will perform the same synchronization behavior as would run periodically for the library. The SubscriptionInfo.getOnDemand() setting is respected. Calling this method on a library that is already in the process of synchronizing will have no effect.

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 specified by libraryId does not exist.
InvalidElementType - if the library specified by libraryId is not a subscribed library.
NotAllowedInCurrentState - if the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

For instance, this error) is reported on synchronizing a subscribed library that was restored from backup, and the library was deleted after the backup was taken, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library is present on a restore, while its content has been deleted.

{@link com.vmware.vapi.std.errors.InvalidArgument} - if some parameter in the subscribed library subscription info is invalid.
{@link com.vmware.vapi.std.errors.ResourceInaccessible} - if the published library cannot be contacted or found.
{@link com.vmware.vapi.std.errors.Unauthorized} - if you do not have all of the privileges described as follows:

• The resource {@code com.vmware.content.Library} referenced by the parameter {@code libraryId} requires {@code ContentLibrary.SyncLibrary}.

Parameters:

libraryId - Identifier of the subscribed library to synchronize. 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.

update

void update(java.lang.String libraryId,
            LibraryModel updateSpec)

Updates the properties of a subscribed library.

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

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

Parameters:

libraryId - Identifier of the subscribed library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the subscribed library.

Throws:

NotFound - if the library specified by libraryId does not exist.

NotAllowedInCurrentState - if the updateSpec updates the subscription URL (see SubscriptionInfo.getSubscriptionUrl()) and the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

InvalidElementType - if the library specified by libraryId is not a subscribed library.

InvalidArgument - if the updateSpec is not valid.

ResourceInaccessible - if the subscription info is being updated but the published library cannot be contacted or found.

ResourceBusy - if the LibraryModel.getVersion() of updateSpec is null and the library is being concurrently updated by another user.

ConcurrentChange - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.

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

update

void update(java.lang.String libraryId,
            LibraryModel updateSpec,
            InvocationConfig invocationConfig)

Updates the properties of a subscribed library.

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

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 subscribed library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the subscribed library.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the library specified by libraryId does not exist.

NotAllowedInCurrentState - if the updateSpec updates the subscription URL (see SubscriptionInfo.getSubscriptionUrl()) and the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.

InvalidElementType - if the library specified by libraryId is not a subscribed library.

InvalidArgument - if the updateSpec is not valid.

ResourceInaccessible - if the subscription info is being updated but the published library cannot be contacted or found.

ResourceBusy - if the LibraryModel.getVersion() of updateSpec is null and the library is being concurrently updated by another user.

ConcurrentChange - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.

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

update

void update(java.lang.String libraryId,
            LibraryModel updateSpec,
            AsyncCallback<java.lang.Void> asyncCallback)

Updates the properties of a subscribed library.

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

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

Operation Errors:
NotFound - if the library specified by libraryId does not exist.
NotAllowedInCurrentState - if the updateSpec updates the subscription URL (see SubscriptionInfo.getSubscriptionUrl()) and the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.
InvalidElementType - if the library specified by libraryId is not a subscribed library.
InvalidArgument - if the updateSpec is not valid.
ResourceInaccessible - if the subscription info is being updated but the published library cannot be contacted or found.
ResourceBusy - if the LibraryModel.getVersion() of updateSpec is null and the library is being concurrently updated by another user.
ConcurrentChange - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.
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 ContentLibrary.UpdateSubscribedLibrary.

Parameters:

libraryId - Identifier of the subscribed library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the subscribed library.

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

update

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

Updates the properties of a subscribed library.

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

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 specified by libraryId does not exist.
NotAllowedInCurrentState - if the updateSpec updates the subscription URL (see SubscriptionInfo.getSubscriptionUrl()) and the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.getStorageBackings()) associated with it.
InvalidElementType - if the library specified by libraryId is not a subscribed library.
InvalidArgument - if the updateSpec is not valid.
ResourceInaccessible - if the subscription info is being updated but the published library cannot be contacted or found.
ResourceBusy - if the LibraryModel.getVersion() of updateSpec is null and the library is being concurrently updated by another user.
ConcurrentChange - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.
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 ContentLibrary.UpdateSubscribedLibrary.

Parameters:

libraryId - Identifier of the subscribed library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the subscribed library.

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

invocationConfig - Configuration for the method invocation.

probe

SubscribedLibraryTypes.ProbeResult probe(SubscriptionInfo subscriptionInfo)

Probes remote library subscription information, including URL, SSL certificate and password. The resulting SubscribedLibraryTypes.ProbeResult class describes whether or not the subscription configuration is successful.

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

Parameters:

subscriptionInfo - The subscription info to be probed.

Returns:

The subscription info probe result.

Throws:

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

• Method execution requires ContentLibrary.ProbeSubscription.

probe

SubscribedLibraryTypes.ProbeResult probe(SubscriptionInfo subscriptionInfo,
                                         InvocationConfig invocationConfig)

Probes remote library subscription information, including URL, SSL certificate and password. The resulting SubscribedLibraryTypes.ProbeResult class describes whether or not the subscription configuration is successful.

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:

subscriptionInfo - The subscription info to be probed.

invocationConfig - Configuration for the method invocation.

Returns:

The subscription info probe result.

Throws:

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

• Method execution requires ContentLibrary.ProbeSubscription.

probe

void probe(SubscriptionInfo subscriptionInfo,
           AsyncCallback<SubscribedLibraryTypes.ProbeResult> asyncCallback)

Probes remote library subscription information, including URL, SSL certificate and password. The resulting SubscribedLibraryTypes.ProbeResult class describes whether or not the subscription configuration is successful.

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

Invocation Result:
The subscription info probe result.

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

• Method execution requires ContentLibrary.ProbeSubscription.

Parameters:

subscriptionInfo - The subscription info to be probed.

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

probe

void probe(SubscriptionInfo subscriptionInfo,
           AsyncCallback<SubscribedLibraryTypes.ProbeResult> asyncCallback,
           InvocationConfig invocationConfig)

Probes remote library subscription information, including URL, SSL certificate and password. The resulting SubscribedLibraryTypes.ProbeResult class describes whether or not the subscription configuration is successful.

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 subscription info probe result.

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

• Method execution requires ContentLibrary.ProbeSubscription.

Parameters:

subscriptionInfo - The subscription info to be probed.

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

invocationConfig - Configuration for the method invocation.