public class OfflineStub extends com.vmware.vapi.internal.bindings.Stub implements Offline
Offline
API service.
WARNING: Internal class, subject to change in future versions.
OfflineTypes._VAPI_OPERATIONS, OfflineTypes.ConnectionSpec, OfflineTypes.CreateResult, OfflineTypes.CreateSpec, OfflineTypes.DeleteResult, OfflineTypes.DepotExtractInfo, OfflineTypes.HostCredentials, OfflineTypes.Info, OfflineTypes.PrecheckResult, OfflineTypes.SourceType, OfflineTypes.Summary
apiProvider, converter, ifaceId, retryPolicy, securityContext
_VAPI_SERVICE_ID, RESOURCE_TYPE
Constructor and Description |
---|
OfflineStub(ApiProvider apiProvider,
StubConfigurationBase config) |
OfflineStub(ApiProvider apiProvider,
com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
StubConfigurationBase config) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
create_Task(OfflineTypes.CreateSpec spec)
Imports a new offline software depot.
|
void |
create_Task(OfflineTypes.CreateSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Imports a new offline software depot.
|
void |
create_Task(OfflineTypes.CreateSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Imports a new offline software depot.
|
java.lang.String |
create_Task(OfflineTypes.CreateSpec spec,
InvocationConfig invocationConfig)
Imports a new offline software depot.
|
java.lang.String |
createFromHost_Task(OfflineTypes.ConnectionSpec spec)
Extract the current software specification applied to the host and import it
into the depot.
|
void |
createFromHost_Task(OfflineTypes.ConnectionSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Extract the current software specification applied to the host and import it
into the depot.
|
void |
createFromHost_Task(OfflineTypes.ConnectionSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Extract the current software specification applied to the host and import it
into the depot.
|
java.lang.String |
createFromHost_Task(OfflineTypes.ConnectionSpec spec,
InvocationConfig invocationConfig)
Extract the current software specification applied to the host and import it
into the depot.
|
java.lang.String |
delete_Task(java.lang.String depot)
The task-based
delete() method removes content of an imported offline
depot from vLCM completely. |
void |
delete_Task(java.lang.String depot,
AsyncCallback<java.lang.String> asyncCallback)
The task-based
delete() method removes content of an imported offline
depot from vLCM completely. |
void |
delete_Task(java.lang.String depot,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
The task-based
delete() method removes content of an imported offline
depot from vLCM completely. |
java.lang.String |
delete_Task(java.lang.String depot,
InvocationConfig invocationConfig)
The task-based
delete() method removes content of an imported offline
depot from vLCM completely. |
void |
delete(java.lang.String depot)
The task-based
delete() method removes content of an imported offline
depot from vLCM completely. |
void |
delete(java.lang.String depot,
AsyncCallback<java.lang.Void> asyncCallback)
The task-based
delete() method removes content of an imported offline
depot from vLCM completely. |
void |
delete(java.lang.String depot,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
The task-based
delete() method removes content of an imported offline
depot from vLCM completely. |
void |
delete(java.lang.String depot,
InvocationConfig invocationConfig)
The task-based
delete() method removes content of an imported offline
depot from vLCM completely. |
OfflineTypes.Info |
get(java.lang.String depot)
Gets the information about an imported offline software depot.
|
void |
get(java.lang.String depot,
AsyncCallback<OfflineTypes.Info> asyncCallback)
Gets the information about an imported offline software depot.
|
void |
get(java.lang.String depot,
AsyncCallback<OfflineTypes.Info> asyncCallback,
InvocationConfig invocationConfig)
Gets the information about an imported offline software depot.
|
OfflineTypes.Info |
get(java.lang.String depot,
InvocationConfig invocationConfig)
Gets the information about an imported offline software depot.
|
java.util.Map<java.lang.String,OfflineTypes.Summary> |
list()
Returns currently imported offline software depots.
|
void |
list(AsyncCallback<java.util.Map<java.lang.String,OfflineTypes.Summary>> asyncCallback)
Returns currently imported offline software depots.
|
void |
list(AsyncCallback<java.util.Map<java.lang.String,OfflineTypes.Summary>> asyncCallback,
InvocationConfig invocationConfig)
Returns currently imported offline software depots.
|
java.util.Map<java.lang.String,OfflineTypes.Summary> |
list(InvocationConfig invocationConfig)
Returns currently imported offline software depots.
|
public OfflineStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)
public OfflineStub(ApiProvider apiProvider, StubConfigurationBase config)
public OfflineTypes.Info get(java.lang.String depot)
Offline
Synchronous method overload. Result of the invocation will be reported as a method return value.
public OfflineTypes.Info get(java.lang.String depot, InvocationConfig invocationConfig)
Offline
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 Offline
depot
- Identifier for the depot.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline
.invocationConfig
- Configuration for the method invocation.public void get(java.lang.String depot, AsyncCallback<OfflineTypes.Info> asyncCallback)
Offline
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Information about the imported offline software depot.
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
NotFound
- If there is no depot with given identifier depot
in the system.
ServiceUnavailable
- If the service is not available.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. public void get(java.lang.String depot, AsyncCallback<OfflineTypes.Info> asyncCallback, InvocationConfig invocationConfig)
Offline
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:
Information about the imported offline software depot.
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
NotFound
- If there is no depot with given identifier depot
in the system.
ServiceUnavailable
- If the service is not available.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. get
in interface Offline
depot
- Identifier for the depot.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public java.util.Map<java.lang.String,OfflineTypes.Summary> list()
Offline
Synchronous method overload. Result of the invocation will be reported as a method return value.
public java.util.Map<java.lang.String,OfflineTypes.Summary> list(InvocationConfig invocationConfig)
Offline
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 Offline
invocationConfig
- Configuration for the method invocation.Map
will be an identifier for the
resource type: com.vmware.esx.settings.depots.offline
.public void list(AsyncCallback<java.util.Map<java.lang.String,OfflineTypes.Summary>> asyncCallback)
Offline
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Map of currently imported offline software depots keyed by their identifier.
The key in the return value Map
will be an identifier for the
resource type: com.vmware.esx.settings.depots.offline
.
Operation Errors:
Unauthenticated
- if the caller is not authenticated.
ServiceUnavailable
- If the service is not available.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. public void list(AsyncCallback<java.util.Map<java.lang.String,OfflineTypes.Summary>> asyncCallback, InvocationConfig invocationConfig)
Offline
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:
Map of currently imported offline software depots keyed by their identifier.
The key in the return value Map
will be an identifier for the
resource type: com.vmware.esx.settings.depots.offline
.
Operation Errors:
Unauthenticated
- if the caller is not authenticated.
ServiceUnavailable
- If the service is not available.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. public java.lang.String create_Task(OfflineTypes.CreateSpec spec)
Offline
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
create_Task
in interface Offline
spec
- Specification to import an offline depot.public java.lang.String create_Task(OfflineTypes.CreateSpec spec, InvocationConfig invocationConfig)
Offline
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
Use invocationConfig
to specify configuration for this particular invocation.
create_Task
in interface Offline
spec
- Specification to import an offline depot.invocationConfig
- Configuration for the method invocation.public void create_Task(OfflineTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback)
Offline
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If an invalid OfflineTypes.CreateSpec.getLocation()
is provided.
ServiceUnavailable
- If the service is not available.
AlreadyExists
- If the depot content already exists. The value of the data property of Error
will be a class that contains existing depot
identifier as part of depot property defined in OfflineTypes.CreateResult
.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
create_Task
in interface Offline
spec
- Specification to import an offline depot.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void create_Task(OfflineTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Offline
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If an invalid OfflineTypes.CreateSpec.getLocation()
is provided.
ServiceUnavailable
- If the service is not available.
AlreadyExists
- If the depot content already exists. The value of the data property of Error
will be a class that contains existing depot
identifier as part of depot property defined in OfflineTypes.CreateResult
.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
create_Task
in interface Offline
spec
- Specification to import an offline depot.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void delete(java.lang.String depot)
Offline
delete()
method removes content of an imported offline
depot from vLCM completely. Note: The non task-based delete()
method has
been deprecated. It deletes only the record of depot from the list of imported
offline software depots, instead of removing the depot's content from vLCM.
Synchronous method overload. Result of the invocation will be reported as a method return value.
public void delete(java.lang.String depot, InvocationConfig invocationConfig)
Offline
delete()
method removes content of an imported offline
depot from vLCM completely. Note: The non task-based delete()
method has
been deprecated. It deletes only the record of depot from the list of imported
offline software depots, instead of removing the depot's content from vLCM.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public java.lang.String delete_Task(java.lang.String depot)
Offline
delete()
method removes content of an imported offline
depot from vLCM completely. Note: The non task-based delete()
method has
been deprecated. It deletes only the record of depot from the list of imported
offline software depots, instead of removing the depot's content from vLCM.
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
delete_Task
in interface Offline
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline
.public java.lang.String delete_Task(java.lang.String depot, InvocationConfig invocationConfig)
Offline
delete()
method removes content of an imported offline
depot from vLCM completely. Note: The non task-based delete()
method has
been deprecated. It deletes only the record of depot from the list of imported
offline software depots, instead of removing the depot's content from vLCM.
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
Use invocationConfig
to specify configuration for this particular invocation.
delete_Task
in interface Offline
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline
.invocationConfig
- Configuration for the method invocation.public void delete_Task(java.lang.String depot, AsyncCallback<java.lang.String> asyncCallback)
Offline
delete()
method removes content of an imported offline
depot from vLCM completely. Note: The non task-based delete()
method has
been deprecated. It deletes only the record of depot from the list of imported
offline software depots, instead of removing the depot's content from vLCM.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.
NotFound
- If there is no depot associated with parameter depot
in the system.
ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. delete_Task
in interface Offline
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void delete_Task(java.lang.String depot, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Offline
delete()
method removes content of an imported offline
depot from vLCM completely. Note: The non task-based delete()
method has
been deprecated. It deletes only the record of depot from the list of imported
offline software depots, instead of removing the depot's content from vLCM.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.
NotFound
- If there is no depot associated with parameter depot
in the system.
ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. delete_Task
in interface Offline
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void delete(java.lang.String depot, AsyncCallback<java.lang.Void> asyncCallback)
Offline
delete()
method removes content of an imported offline
depot from vLCM completely. Note: The non task-based delete()
method has
been deprecated. It deletes only the record of depot from the list of imported
offline software depots, instead of removing the depot's content from vLCM.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.
NotFound
- If there is no depot associated with parameter depot
in the system.
ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. public void delete(java.lang.String depot, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Offline
delete()
method removes content of an imported offline
depot from vLCM completely. Note: The non task-based delete()
method has
been deprecated. It deletes only the record of depot from the list of imported
offline software depots, instead of removing the depot's content from vLCM.
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:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.
NotFound
- If there is no depot associated with parameter depot
in the system.
ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. delete
in interface Offline
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public java.lang.String createFromHost_Task(OfflineTypes.ConnectionSpec spec)
Offline
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
createFromHost_Task
in interface Offline
spec
- ConnectionSpec connection spec for the host.public java.lang.String createFromHost_Task(OfflineTypes.ConnectionSpec spec, InvocationConfig invocationConfig)
Offline
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
Use invocationConfig
to specify configuration for this particular invocation.
createFromHost_Task
in interface Offline
spec
- ConnectionSpec connection spec for the host.invocationConfig
- Configuration for the method invocation.public void createFromHost_Task(OfflineTypes.ConnectionSpec spec, AsyncCallback<java.lang.String> asyncCallback)
Offline
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
InvalidArgument
- If the OfflineTypes.HostCredentials.getHostName()
property of spec
is invalid.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
NotFound
- If there is no OfflineTypes.HostCredentials.getHostName()
property associated with host id in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
UnverifiedPeer
- If the SSL certificate of the target node cannot be validated by comparing with
the thumbprint provided in OfflineTypes.HostCredentials.getSslThumbPrint()
.
createFromHost_Task
in interface Offline
spec
- ConnectionSpec connection spec for the host.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void createFromHost_Task(OfflineTypes.ConnectionSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Offline
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
InvalidArgument
- If the OfflineTypes.HostCredentials.getHostName()
property of spec
is invalid.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
NotFound
- If there is no OfflineTypes.HostCredentials.getHostName()
property associated with host id in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
UnverifiedPeer
- If the SSL certificate of the target node cannot be validated by comparing with
the thumbprint provided in OfflineTypes.HostCredentials.getSslThumbPrint()
.
createFromHost_Task
in interface Offline
spec
- ConnectionSpec connection spec for the host.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.