com.vmware.esx.settings.clusters.software

Class ComponentsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.settings.clusters.software.ComponentsStub

All Implemented Interfaces:

Components, ComponentsTypes, Service

public class ComponentsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Components

Remote stub implementation of the Components API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.esx.settings.clusters.software.ComponentsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Constructor Summary

Constructors

Constructor and Description
ComponentsStub(ApiProvider apiProvider, StubConfigurationBase config)
ComponentsStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
ComponentInfo	get(java.lang.String cluster, java.lang.String component) Returns the component version for the given component in the desired software specification.
void	get(java.lang.String cluster, java.lang.String component, AsyncCallback<ComponentInfo> asyncCallback) Returns the component version for the given component in the desired software specification.
void	get(java.lang.String cluster, java.lang.String component, AsyncCallback<ComponentInfo> asyncCallback, InvocationConfig invocationConfig) Returns the component version for the given component in the desired software specification.
ComponentInfo	get(java.lang.String cluster, java.lang.String component, InvocationConfig invocationConfig) Returns the component version for the given component in the desired software specification.
java.util.Map<java.lang.String,ComponentInfo>	list(java.lang.String cluster) Returns a list of components in the desired software specification.
void	list(java.lang.String cluster, AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback) Returns a list of components in the desired software specification.
void	list(java.lang.String cluster, AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback, InvocationConfig invocationConfig) Returns a list of components in the desired software specification.
java.util.Map<java.lang.String,ComponentInfo>	list(java.lang.String cluster, InvocationConfig invocationConfig) Returns a list of components in the desired software specification.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ComponentsStub

public ComponentsStub(ApiProvider apiProvider,
                      com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                      StubConfigurationBase config)

ComponentsStub

public ComponentsStub(ApiProvider apiProvider,
                      StubConfigurationBase config)

Method Detail

get

public ComponentInfo get(java.lang.String cluster,
                         java.lang.String component)

Description copied from interface: Components

Returns the component version for the given component in the desired software specification.

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

Specified by:

get in interface Components

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

component - Identifier of the component. The parameter must be an identifier for the resource type: com.vmware.esx.settings.component.

Returns:

Details about the component version. If null then version is supposed to be chosen based on the constraints in the system.

get

public ComponentInfo get(java.lang.String cluster,
                         java.lang.String component,
                         InvocationConfig invocationConfig)

Description copied from interface: Components

Returns the component version for the given component in the desired software specification.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Components

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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.

Returns:

Details about the component version. If null then version is supposed to be chosen based on the constraints in the system.

get

public void get(java.lang.String cluster,
                java.lang.String component,
                AsyncCallback<ComponentInfo> asyncCallback)

Description copied from interface: Components

Returns the component version for the given component in the desired software specification.

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

Invocation Result:
Details about the component version. If null then version is supposed to 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.
InvalidArgument - If invalid component name is provided.
NotFound - If there is no cluster associated with cluster in the system or 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:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Specified by:

get in interface Components

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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.

get

public void get(java.lang.String cluster,
                java.lang.String component,
                AsyncCallback<ComponentInfo> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Components

Returns the component version for the given component in the desired software specification.

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:
Details about the component version. If null then version is supposed to 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.
InvalidArgument - If invalid component name is provided.
NotFound - If there is no cluster associated with cluster in the system or 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:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Specified by:

get in interface Components

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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.

list

public java.util.Map<java.lang.String,ComponentInfo> list(java.lang.String cluster)

Description copied from interface: Components

Returns a list of components in the desired software specification.

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

Specified by:

list in interface Components

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

Map of ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then ComponentInfo will not be present for that component. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.component.

list

public java.util.Map<java.lang.String,ComponentInfo> list(java.lang.String cluster,
                                                          InvocationConfig invocationConfig)

Description copied from interface: Components

Returns a list of components in the desired software specification.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

list in interface Components

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Map of ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then ComponentInfo will not be present for that component. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.component.

list

public void list(java.lang.String cluster,
                 AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback)

Description copied from interface: Components

Returns a list of components in the desired software specification.

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

Invocation Result:
Map of ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then ComponentInfo will not be present for that component. 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 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:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Specified by:

list in interface Components

Parameters:

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.

list

public void list(java.lang.String cluster,
                 AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Components

Returns a list of components in the desired software specification.

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 ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then ComponentInfo will not be present for that component. 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 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:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Specified by:

list in interface Components

Parameters:

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.