public class LocalLibraryStub extends com.vmware.vapi.internal.bindings.Stub implements LocalLibrary
LocalLibrary
API service.
WARNING: Internal class, subject to change in future versions.
LocalLibraryTypes.DestinationSpec
apiProvider, converter, ifaceId, retryPolicy, securityContext
_VAPI_SERVICE_ID
Constructor and Description |
---|
LocalLibraryStub(ApiProvider apiProvider,
StubConfigurationBase config) |
LocalLibraryStub(ApiProvider apiProvider,
com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
StubConfigurationBase config) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
create(java.lang.String clientToken,
LibraryModel createSpec)
Creates a new local library.
|
void |
create(java.lang.String clientToken,
LibraryModel createSpec,
AsyncCallback<java.lang.String> asyncCallback)
Creates a new local library.
|
void |
create(java.lang.String clientToken,
LibraryModel createSpec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Creates a new local library.
|
java.lang.String |
create(java.lang.String clientToken,
LibraryModel createSpec,
InvocationConfig invocationConfig)
Creates a new local library.
|
void |
delete(java.lang.String libraryId)
Deletes the specified local library.
|
void |
delete(java.lang.String libraryId,
AsyncCallback<java.lang.Void> asyncCallback)
Deletes the specified local library.
|
void |
delete(java.lang.String libraryId,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Deletes the specified local library.
|
void |
delete(java.lang.String libraryId,
InvocationConfig invocationConfig)
Deletes the specified local library.
|
LibraryModel |
get(java.lang.String libraryId)
Returns a given local library.
|
void |
get(java.lang.String libraryId,
AsyncCallback<LibraryModel> asyncCallback)
Returns a given local library.
|
void |
get(java.lang.String libraryId,
AsyncCallback<LibraryModel> asyncCallback,
InvocationConfig invocationConfig)
Returns a given local library.
|
LibraryModel |
get(java.lang.String libraryId,
InvocationConfig invocationConfig)
Returns a given local library.
|
java.util.List<java.lang.String> |
list()
Returns the identifiers of all local libraries in the Content Library.
|
void |
list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback)
Returns the identifiers of all local libraries in the Content Library.
|
void |
list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
InvocationConfig invocationConfig)
Returns the identifiers of all local libraries in the Content Library.
|
java.util.List<java.lang.String> |
list(InvocationConfig invocationConfig)
Returns the identifiers of all local libraries in the Content Library.
|
void |
publish(java.lang.String libraryId,
java.util.List<LocalLibraryTypes.DestinationSpec> subscriptions)
Publishes the library to specified subscriptions.
|
void |
publish(java.lang.String libraryId,
java.util.List<LocalLibraryTypes.DestinationSpec> subscriptions,
AsyncCallback<java.lang.Void> asyncCallback)
Publishes the library to specified subscriptions.
|
void |
publish(java.lang.String libraryId,
java.util.List<LocalLibraryTypes.DestinationSpec> subscriptions,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Publishes the library to specified subscriptions.
|
void |
publish(java.lang.String libraryId,
java.util.List<LocalLibraryTypes.DestinationSpec> subscriptions,
InvocationConfig invocationConfig)
Publishes the library to specified subscriptions.
|
void |
update(java.lang.String libraryId,
LibraryModel updateSpec)
Updates the properties of a local library.
|
void |
update(java.lang.String libraryId,
LibraryModel updateSpec,
AsyncCallback<java.lang.Void> asyncCallback)
Updates the properties of a local library.
|
void |
update(java.lang.String libraryId,
LibraryModel updateSpec,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Updates the properties of a local library.
|
void |
update(java.lang.String libraryId,
LibraryModel updateSpec,
InvocationConfig invocationConfig)
Updates the properties of a local library.
|
public LocalLibraryStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)
public LocalLibraryStub(ApiProvider apiProvider, StubConfigurationBase config)
public java.lang.String create(java.lang.String clientToken, LibraryModel createSpec)
LocalLibrary
Synchronous method overload. Result of the invocation will be reported as a method return value.
create
in interface LocalLibrary
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 for the new local library.LibraryModel
.
The return value will be an identifier for the resource type: com.vmware.content.Library
.public java.lang.String create(java.lang.String clientToken, LibraryModel createSpec, InvocationConfig invocationConfig)
LocalLibrary
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
create
in interface LocalLibrary
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 for the new local library.invocationConfig
- Configuration for the method invocation.LibraryModel
.
The return value will be an identifier for the resource type: com.vmware.content.Library
.public void create(java.lang.String clientToken, LibraryModel createSpec, AsyncCallback<java.lang.String> asyncCallback)
LocalLibrary
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Identifier of the newly created LibraryModel
.
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.
Unauthorized
- if you do not have all of the privileges described as follows:
ContentLibrary.CreateLocalLibrary
. Datastore
referenced by the property StorageBacking.getDatastoreId()
requires Datastore.AllocateSpace
. create
in interface LocalLibrary
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 for the new local library.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void create(java.lang.String clientToken, LibraryModel createSpec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
LocalLibrary
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 LibraryModel
.
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.
Unauthorized
- if you do not have all of the privileges described as follows:
ContentLibrary.CreateLocalLibrary
. Datastore
referenced by the property StorageBacking.getDatastoreId()
requires Datastore.AllocateSpace
. create
in interface LocalLibrary
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 for the new local library.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void delete(java.lang.String libraryId)
LocalLibrary
Deleting a local 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.
delete
in interface LocalLibrary
libraryId
- Identifier of the local library to delete.
The parameter must be an identifier for the resource type: com.vmware.content.Library
.public void delete(java.lang.String libraryId, InvocationConfig invocationConfig)
LocalLibrary
Deleting a local 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.
delete
in interface LocalLibrary
libraryId
- Identifier of the local library to delete.
The parameter must be an identifier for the resource type: com.vmware.content.Library
.invocationConfig
- Configuration for the method invocation.public void delete(java.lang.String libraryId, AsyncCallback<java.lang.Void> asyncCallback)
LocalLibrary
Deleting a local 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 specified by libraryId
is not a local library.
NotFound
- if the library specified by libraryId
does not exist.
NotAllowedInCurrentState
- if the library contains a library item that cannot be deleted in its current
state. For example, 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:
com.vmware.content.Library
referenced by the parameter libraryId
requires ContentLibrary.DeleteLocalLibrary
. delete
in interface LocalLibrary
libraryId
- Identifier of the local 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.public void delete(java.lang.String libraryId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
LocalLibrary
Deleting a local 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 specified by libraryId
is not a local library.
NotFound
- if the library specified by libraryId
does not exist.
NotAllowedInCurrentState
- if the library contains a library item that cannot be deleted in its current
state. For example, 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:
com.vmware.content.Library
referenced by the parameter libraryId
requires ContentLibrary.DeleteLocalLibrary
. delete
in interface LocalLibrary
libraryId
- Identifier of the local 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.public LibraryModel get(java.lang.String libraryId)
LocalLibrary
Synchronous method overload. Result of the invocation will be reported as a method return value.
get
in interface LocalLibrary
libraryId
- Identifier of the local library to return.
The parameter must be an identifier for the resource type: com.vmware.content.Library
.LibraryModel
instance associated with libraryId
.public LibraryModel get(java.lang.String libraryId, InvocationConfig invocationConfig)
LocalLibrary
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
get
in interface LocalLibrary
libraryId
- Identifier of the local library to return.
The parameter must be an identifier for the resource type: com.vmware.content.Library
.invocationConfig
- Configuration for the method invocation.LibraryModel
instance associated with libraryId
.public void get(java.lang.String libraryId, AsyncCallback<LibraryModel> asyncCallback)
LocalLibrary
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
The LibraryModel
instance associated with libraryId
.
Operation Errors:
NotFound
- if the library specified by libraryId
does not exist.
InvalidElementType
- if the library specified by libraryId
is not a local library.
Unauthorized
- if you do not have all of the privileges described as follows:
com.vmware.content.Library
referenced by the parameter libraryId
requires System.Read
. get
in interface LocalLibrary
libraryId
- Identifier of the local 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.public void get(java.lang.String libraryId, AsyncCallback<LibraryModel> asyncCallback, InvocationConfig invocationConfig)
LocalLibrary
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 associated with libraryId
.
Operation Errors:
NotFound
- if the library specified by libraryId
does not exist.
InvalidElementType
- if the library specified by libraryId
is not a local library.
Unauthorized
- if you do not have all of the privileges described as follows:
com.vmware.content.Library
referenced by the parameter libraryId
requires System.Read
. get
in interface LocalLibrary
libraryId
- Identifier of the local 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.public java.util.List<java.lang.String> list()
LocalLibrary
Synchronous method overload. Result of the invocation will be reported as a method return value.
list
in interface LocalLibrary
List
of identifiers of all local libraries in the Content
Library.
The return value will contain identifiers for the resource type: com.vmware.content.Library
.public java.util.List<java.lang.String> list(InvocationConfig invocationConfig)
LocalLibrary
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
list
in interface LocalLibrary
invocationConfig
- Configuration for the method invocation.List
of identifiers of all local libraries in the Content
Library.
The return value will contain identifiers for the resource type: com.vmware.content.Library
.public void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback)
LocalLibrary
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
The List
of identifiers of all local 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:
System.Read
. list
in interface LocalLibrary
asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig)
LocalLibrary
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 local 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:
System.Read
. list
in interface LocalLibrary
asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void update(java.lang.String libraryId, LibraryModel updateSpec)
LocalLibrary
This is an incremental update to
the local 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.
update
in interface LocalLibrary
libraryId
- Identifier of the local 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 local library.public void update(java.lang.String libraryId, LibraryModel updateSpec, InvocationConfig invocationConfig)
LocalLibrary
This is an incremental update to
the local 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.
update
in interface LocalLibrary
libraryId
- Identifier of the local 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 local library.invocationConfig
- Configuration for the method invocation.public void update(java.lang.String libraryId, LibraryModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback)
LocalLibrary
This is an incremental update to
the local 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 library specified by libraryId
is a published library with JSON
persistence enabled (see PublishInfo.getPersistJsonEnabled()
) and the content
of the library has been deleted from the storage backings (see LibraryModel.getStorageBackings()
) associated with it.
InvalidElementType
- if the library specified by libraryId
is not a local library.
InvalidArgument
- if the updateSpec
is not valid.
InvalidArgument
- if the PublishInfo.getCurrentPassword()
in the
updateSpec
does not match the existing password of the published
library.
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:
com.vmware.content.Library
referenced by the parameter libraryId
requires ContentLibrary.UpdateLocalLibrary
. update
in interface LocalLibrary
libraryId
- Identifier of the local 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 local library.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void update(java.lang.String libraryId, LibraryModel updateSpec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
LocalLibrary
This is an incremental update to
the local 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 library specified by libraryId
is a published library with JSON
persistence enabled (see PublishInfo.getPersistJsonEnabled()
) and the content
of the library has been deleted from the storage backings (see LibraryModel.getStorageBackings()
) associated with it.
InvalidElementType
- if the library specified by libraryId
is not a local library.
InvalidArgument
- if the updateSpec
is not valid.
InvalidArgument
- if the PublishInfo.getCurrentPassword()
in the
updateSpec
does not match the existing password of the published
library.
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:
com.vmware.content.Library
referenced by the parameter libraryId
requires ContentLibrary.UpdateLocalLibrary
. update
in interface LocalLibrary
libraryId
- Identifier of the local 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 local library.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void publish(java.lang.String libraryId, java.util.List<LocalLibraryTypes.DestinationSpec> subscriptions)
LocalLibrary
Synchronous method overload. Result of the invocation will be reported as a method return value.
publish
in interface LocalLibrary
libraryId
- Identifier of the published library.
The parameter must be an identifier for the resource type: com.vmware.content.Library
.subscriptions
- The list of subscriptions to publish this library to.public void publish(java.lang.String libraryId, java.util.List<LocalLibraryTypes.DestinationSpec> subscriptions, InvocationConfig invocationConfig)
LocalLibrary
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
publish
in interface LocalLibrary
libraryId
- Identifier of the published library.
The parameter must be an identifier for the resource type: com.vmware.content.Library
.subscriptions
- The list of subscriptions to publish this library to.invocationConfig
- Configuration for the method invocation.public void publish(java.lang.String libraryId, java.util.List<LocalLibraryTypes.DestinationSpec> subscriptions, AsyncCallback<java.lang.Void> asyncCallback)
LocalLibrary
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 specified by libraryId
does not exist.
InvalidArgument
- If one or more subscriptions
is not valid.
InvalidElementType
- If the library specified by libraryId
is a subscribed library.
NotAllowedInCurrentState
- If the library specified by libraryId
is not 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:
com.vmware.content.Library
referenced by the parameter libraryId
requires ContentLibrary.PublishLibrary
. publish
in interface LocalLibrary
libraryId
- Identifier of the published library.
The parameter must be an identifier for the resource type: com.vmware.content.Library
.subscriptions
- The list of subscriptions to publish this library to.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void publish(java.lang.String libraryId, java.util.List<LocalLibraryTypes.DestinationSpec> subscriptions, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
LocalLibrary
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 specified by libraryId
does not exist.
InvalidArgument
- If one or more subscriptions
is not valid.
InvalidElementType
- If the library specified by libraryId
is a subscribed library.
NotAllowedInCurrentState
- If the library specified by libraryId
is not 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:
com.vmware.content.Library
referenced by the parameter libraryId
requires ContentLibrary.PublishLibrary
. publish
in interface LocalLibrary
libraryId
- Identifier of the published library.
The parameter must be an identifier for the resource type: com.vmware.content.Library
.subscriptions
- The list of subscriptions to publish this library to.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.