public class SoftwareStub extends com.vmware.vapi.internal.bindings.Stub implements Software
Software
API service.
WARNING: Internal class, subject to change in future versions.
SoftwareTypes._VAPI_OPERATIONS, SoftwareTypes.CheckResult, SoftwareTypes.CheckSpec, SoftwareTypes.CheckType, SoftwareTypes.EnableSpec, SoftwareTypes.Info
apiProvider, converter, ifaceId, retryPolicy, securityContext
_VAPI_SERVICE_ID
Constructor and Description |
---|
SoftwareStub(ApiProvider apiProvider,
StubConfigurationBase config) |
SoftwareStub(ApiProvider apiProvider,
com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
StubConfigurationBase config) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
check_Task(java.lang.String cluster,
SoftwareTypes.CheckSpec spec)
Checks the possibility to manage the cluster with a single software
specification.
|
void |
check_Task(java.lang.String cluster,
SoftwareTypes.CheckSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Checks the possibility to manage the cluster with a single software
specification.
|
void |
check_Task(java.lang.String cluster,
SoftwareTypes.CheckSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Checks the possibility to manage the cluster with a single software
specification.
|
java.lang.String |
check_Task(java.lang.String cluster,
SoftwareTypes.CheckSpec spec,
InvocationConfig invocationConfig)
Checks the possibility to manage the cluster with a single software
specification.
|
java.lang.String |
enable_Task(java.lang.String cluster,
SoftwareTypes.EnableSpec spec)
Enables the feature which manages the cluster with a single software
specification.
|
void |
enable_Task(java.lang.String cluster,
SoftwareTypes.EnableSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Enables the feature which manages the cluster with a single software
specification.
|
void |
enable_Task(java.lang.String cluster,
SoftwareTypes.EnableSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Enables the feature which manages the cluster with a single software
specification.
|
java.lang.String |
enable_Task(java.lang.String cluster,
SoftwareTypes.EnableSpec spec,
InvocationConfig invocationConfig)
Enables the feature which manages the cluster with a single software
specification.
|
SoftwareTypes.Info |
get(java.lang.String cluster)
Returns whether the given cluster is managed with a single software
specification.
|
void |
get(java.lang.String cluster,
AsyncCallback<SoftwareTypes.Info> asyncCallback)
Returns whether the given cluster is managed with a single software
specification.
|
void |
get(java.lang.String cluster,
AsyncCallback<SoftwareTypes.Info> asyncCallback,
InvocationConfig invocationConfig)
Returns whether the given cluster is managed with a single software
specification.
|
SoftwareTypes.Info |
get(java.lang.String cluster,
InvocationConfig invocationConfig)
Returns whether the given cluster is managed with a single software
specification.
|
public SoftwareStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)
public SoftwareStub(ApiProvider apiProvider, StubConfigurationBase config)
public SoftwareTypes.Info get(java.lang.String cluster)
Software
Synchronous method overload. Result of the invocation will be reported as a method return value.
public SoftwareTypes.Info get(java.lang.String cluster, InvocationConfig invocationConfig)
Software
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 void get(java.lang.String cluster, AsyncCallback<SoftwareTypes.Info> asyncCallback)
Software
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Information about the feature enablement.
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
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.lifecycleSettings.Read
. ClusterComputeResource
referenced by the parameter cluster
requires VcIntegrity.lifecycleSettings.Read
. public void get(java.lang.String cluster, AsyncCallback<SoftwareTypes.Info> asyncCallback, InvocationConfig invocationConfig)
Software
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 feature enablement.
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
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.lifecycleSettings.Read
. ClusterComputeResource
referenced by the parameter cluster
requires VcIntegrity.lifecycleSettings.Read
. get
in interface Software
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public java.lang.String check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec)
Software
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
check_Task
in interface Software
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- Check specification.
If null
, all checks are performed.public java.lang.String check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec, InvocationConfig invocationConfig)
Software
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.
check_Task
in interface Software
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- Check specification.
If null
, all checks are performed.invocationConfig
- Configuration for the method invocation.public void check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec, AsyncCallback<java.lang.String> asyncCallback)
Software
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:
Error
- If there is some unknown error. The accompanying error message will give more
details about the failure.
NotAllowedInCurrentState
- If the feature is already enabled for the given cluster.
NotFound
- If there is no cluster associated with cluster
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
check_Task
in interface Software
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- Check specification.
If null
, all checks are performed.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Software
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:
Error
- If there is some unknown error. The accompanying error message will give more
details about the failure.
NotAllowedInCurrentState
- If the feature is already enabled for the given cluster.
NotFound
- If there is no cluster associated with cluster
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
check_Task
in interface Software
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- Check specification.
If null
, all checks are performed.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public java.lang.String enable_Task(java.lang.String cluster, SoftwareTypes.EnableSpec spec)
Software
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
enable_Task
in interface Software
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- Enablement specification.
If null
, all checks are performed.public java.lang.String enable_Task(java.lang.String cluster, SoftwareTypes.EnableSpec spec, InvocationConfig invocationConfig)
Software
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.
enable_Task
in interface Software
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- Enablement specification.
If null
, all checks are performed.invocationConfig
- Configuration for the method invocation.public void enable_Task(java.lang.String cluster, SoftwareTypes.EnableSpec spec, AsyncCallback<java.lang.String> asyncCallback)
Software
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:
Error
- If feature enablement failed for the given cluster. The value of the data
property of Error
will be a class that
contains all the properties defined in SoftwareTypes.CheckResult
.
NotAllowedInCurrentState
- If the feature is already enabled for the given cluster.
NotFound
- If there is no cluster associated with cluster
in the system
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
enable_Task
in interface Software
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- Enablement specification.
If null
, all checks are performed.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void enable_Task(java.lang.String cluster, SoftwareTypes.EnableSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Software
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:
Error
- If feature enablement failed for the given cluster. The value of the data
property of Error
will be a class that
contains all the properties defined in SoftwareTypes.CheckResult
.
NotAllowedInCurrentState
- If the feature is already enabled for the given cluster.
NotFound
- If there is no cluster associated with cluster
in the system
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
enable_Task
in interface Software
cluster
- Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- Enablement specification.
If null
, all checks are performed.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.