public class ComponentsStub extends com.vmware.vapi.internal.bindings.Stub implements Components
Components
API service.
WARNING: Internal class, subject to change in future versions.
ComponentsTypes.UpdateSpec
apiProvider, converter, ifaceId, securityContext
_VAPI_SERVICE_ID, RESOURCE_TYPE
Constructor and Description |
---|
ComponentsStub(ApiProvider apiProvider,
StubConfigurationBase config) |
ComponentsStub(ApiProvider apiProvider,
com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
StubConfigurationBase config) |
Modifier and Type | Method and Description |
---|---|
void |
delete(java.lang.String cluster,
java.lang.String draft,
java.lang.String component)
Deletes the given component from the software draft.
|
void |
delete(java.lang.String cluster,
java.lang.String draft,
java.lang.String component,
AsyncCallback<java.lang.Void> asyncCallback)
Deletes the given component from the software draft.
|
void |
delete(java.lang.String cluster,
java.lang.String draft,
java.lang.String component,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Deletes the given component from the software draft.
|
void |
delete(java.lang.String cluster,
java.lang.String draft,
java.lang.String component,
InvocationConfig invocationConfig)
Deletes the given component from the software draft.
|
ComponentInfo |
get(java.lang.String cluster,
java.lang.String draft,
java.lang.String component)
Returns the component version for the given component in the software draft.
|
void |
get(java.lang.String cluster,
java.lang.String draft,
java.lang.String component,
AsyncCallback<ComponentInfo> asyncCallback)
Returns the component version for the given component in the software draft.
|
void |
get(java.lang.String cluster,
java.lang.String draft,
java.lang.String component,
AsyncCallback<ComponentInfo> asyncCallback,
InvocationConfig invocationConfig)
Returns the component version for the given component in the software draft.
|
ComponentInfo |
get(java.lang.String cluster,
java.lang.String draft,
java.lang.String component,
InvocationConfig invocationConfig)
Returns the component version for the given component in the software draft.
|
java.util.Map<java.lang.String,ComponentInfo> |
list(java.lang.String cluster,
java.lang.String draft)
Returns the components that comprise the software draft.
|
void |
list(java.lang.String cluster,
java.lang.String draft,
AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback)
Returns the components that comprise the software draft.
|
void |
list(java.lang.String cluster,
java.lang.String draft,
AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback,
InvocationConfig invocationConfig)
Returns the components that comprise the software draft.
|
java.util.Map<java.lang.String,ComponentInfo> |
list(java.lang.String cluster,
java.lang.String draft,
InvocationConfig invocationConfig)
Returns the components that comprise the software draft.
|
void |
set(java.lang.String cluster,
java.lang.String draft,
java.lang.String component,
java.lang.String version)
Set the component version for a given component in the software draft.
|
void |
set(java.lang.String cluster,
java.lang.String draft,
java.lang.String component,
java.lang.String version,
AsyncCallback<java.lang.Void> asyncCallback)
Set the component version for a given component in the software draft.
|
void |
set(java.lang.String cluster,
java.lang.String draft,
java.lang.String component,
java.lang.String version,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Set the component version for a given component in the software draft.
|
void |
set(java.lang.String cluster,
java.lang.String draft,
java.lang.String component,
java.lang.String version,
InvocationConfig invocationConfig)
Set the component version for a given component in the software draft.
|
void |
update(java.lang.String cluster,
java.lang.String draft,
ComponentsTypes.UpdateSpec spec)
Updates the list of components in a given draft.
|
void |
update(java.lang.String cluster,
java.lang.String draft,
ComponentsTypes.UpdateSpec spec,
AsyncCallback<java.lang.Void> asyncCallback)
Updates the list of components in a given draft.
|
void |
update(java.lang.String cluster,
java.lang.String draft,
ComponentsTypes.UpdateSpec spec,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Updates the list of components in a given draft.
|
void |
update(java.lang.String cluster,
java.lang.String draft,
ComponentsTypes.UpdateSpec spec,
InvocationConfig invocationConfig)
Updates the list of components in a given draft.
|
public ComponentsStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)
public ComponentsStub(ApiProvider apiProvider, StubConfigurationBase config)
public ComponentInfo get(java.lang.String cluster, java.lang.String draft, java.lang.String component)
Components
Synchronous method overload. Result of the invocation will be reported as a method return value.
get
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.null
then version will be chosen based on the constraints in the
system.public ComponentInfo get(java.lang.String cluster, java.lang.String draft, java.lang.String component, InvocationConfig invocationConfig)
Components
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 Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.invocationConfig
- Configuration for the method invocation.null
then version will be chosen based on the constraints in the
system.public void get(java.lang.String cluster, java.lang.String draft, java.lang.String component, AsyncCallback<ComponentInfo> asyncCallback)
Components
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Information about component version.
If null
then version will be chosen based on the constraints in the
system.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no cluster associated with cluster
or no draft associated
with draft
or no component associated with component
in the
system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- if the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
ClusterComputeResource
referenced by the
parameter cluster
requires VcIntegrity.lifecycleSoftwareSpecification.Read
. get
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void get(java.lang.String cluster, java.lang.String draft, java.lang.String component, AsyncCallback<ComponentInfo> asyncCallback, InvocationConfig invocationConfig)
Components
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 component version.
If null
then version will be chosen based on the constraints in the
system.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no cluster associated with cluster
or no draft associated
with draft
or no component associated with component
in the
system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- if the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
ClusterComputeResource
referenced by the
parameter cluster
requires VcIntegrity.lifecycleSoftwareSpecification.Read
. get
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void set(java.lang.String cluster, java.lang.String draft, java.lang.String component, java.lang.String version)
Components
Synchronous method overload. Result of the invocation will be reported as a method return value.
set
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.version
- Component version.
This property is currently required. In the future,if this property is null
then version is chosen based on the constraints in the system.public void set(java.lang.String cluster, java.lang.String draft, java.lang.String component, java.lang.String version, InvocationConfig invocationConfig)
Components
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
set
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.version
- Component version.
This property is currently required. In the future,if this property is null
then version is chosen based on the constraints in the system.invocationConfig
- Configuration for the method invocation.public void set(java.lang.String cluster, java.lang.String draft, java.lang.String component, java.lang.String version, AsyncCallback<java.lang.Void> asyncCallback)
Components
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no cluster associated with cluster
or no draft associated
with draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
ClusterComputeResource
referenced by the
parameter cluster
requires VcIntegrity.lifecycleSoftwareSpecification.Write
. set
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.version
- Component version.
This property is currently required. In the future,if this property is null
then version is chosen based on the constraints in the system.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void set(java.lang.String cluster, java.lang.String draft, java.lang.String component, java.lang.String version, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Components
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 there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no cluster associated with cluster
or no draft associated
with draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
ClusterComputeResource
referenced by the
parameter cluster
requires VcIntegrity.lifecycleSoftwareSpecification.Write
. set
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.version
- Component version.
This property is currently required. In the future,if this property is null
then version is chosen based on the constraints in the system.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void delete(java.lang.String cluster, java.lang.String draft, java.lang.String component)
Components
Synchronous method overload. Result of the invocation will be reported as a method return value.
delete
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.public void delete(java.lang.String cluster, java.lang.String draft, java.lang.String component, InvocationConfig invocationConfig)
Components
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 Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.invocationConfig
- Configuration for the method invocation.public void delete(java.lang.String cluster, java.lang.String draft, java.lang.String component, AsyncCallback<java.lang.Void> asyncCallback)
Components
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no cluster associated with cluster
or no draft associated
with draft
or no component associated with component
in the
system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- if the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
ClusterComputeResource
referenced by the
parameter cluster
requires VcIntegrity.lifecycleSoftwareSpecification.Write
. delete
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void delete(java.lang.String cluster, java.lang.String draft, java.lang.String component, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Components
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 there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no cluster associated with cluster
or no draft associated
with draft
or no component associated with component
in the
system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- if the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
ClusterComputeResource
referenced by the
parameter cluster
requires VcIntegrity.lifecycleSoftwareSpecification.Write
. delete
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void update(java.lang.String cluster, java.lang.String draft, ComponentsTypes.UpdateSpec spec)
Components
Synchronous method overload. Result of the invocation will be reported as a method return value.
update
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.spec
- Update specification containing list of components to add and/or delete.public void update(java.lang.String cluster, java.lang.String draft, ComponentsTypes.UpdateSpec spec, InvocationConfig invocationConfig)
Components
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 Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.spec
- Update specification containing list of components to add and/or delete.invocationConfig
- Configuration for the method invocation.public void update(java.lang.String cluster, java.lang.String draft, ComponentsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback)
Components
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
NotFound
- If there is no cluster associated with cluster
or no draft associated
with draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
ClusterComputeResource
referenced by the
parameter cluster
requires VcIntegrity.lifecycleSoftwareSpecification.Write
. update
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.spec
- Update specification containing list of components to add and/or delete.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void update(java.lang.String cluster, java.lang.String draft, ComponentsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Components
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 there is some unknown internal error. The accompanying error message will
give more details about the failure.
NotFound
- If there is no cluster associated with cluster
or no draft associated
with draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
ClusterComputeResource
referenced by the
parameter cluster
requires VcIntegrity.lifecycleSoftwareSpecification.Write
. update
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.spec
- Update specification containing list of components to add and/or delete.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,ComponentInfo> list(java.lang.String cluster, java.lang.String draft)
Components
Synchronous method overload. Result of the invocation will be reported as a method return value.
list
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.Map
will be an identifier for the
resource type: com.vmware.esx.settings.component
.public java.util.Map<java.lang.String,ComponentInfo> list(java.lang.String cluster, java.lang.String draft, InvocationConfig invocationConfig)
Components
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 Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.invocationConfig
- Configuration for the method invocation.Map
will be an identifier for the
resource type: com.vmware.esx.settings.component
.public void list(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback)
Components
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Map of component version information keyed by the component identifier.
The key in the return value Map
will be an identifier for the
resource type: com.vmware.esx.settings.component
.
Operation Errors:
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
NotFound
- If there is no cluster associated with cluster
or no draft associated
with draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
ClusterComputeResource
referenced by the
parameter cluster
requires VcIntegrity.lifecycleSoftwareSpecification.Read
. list
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void list(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback, InvocationConfig invocationConfig)
Components
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 component version information keyed by the component identifier.
The key in the return value Map
will be an identifier for the
resource type: com.vmware.esx.settings.component
.
Operation Errors:
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
NotFound
- If there is no cluster associated with cluster
or no draft associated
with draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
ClusterComputeResource
referenced by the
parameter cluster
requires VcIntegrity.lifecycleSoftwareSpecification.Read
. list
in interface Components
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.draft
- Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.