com.vmware.vcenter.namespace_management.software

Class ClustersStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.namespace_management.software.ClustersStub

All Implemented Interfaces:

Service, Clusters, ClustersTypes

public class ClustersStub
extends com.vmware.vapi.internal.bindings.Stub
implements Clusters

Remote stub implementation of the Clusters API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.software.ClustersTypes

ClustersTypes.Info, ClustersTypes.Message, ClustersTypes.Result, ClustersTypes.State, ClustersTypes.Summary, ClustersTypes.UpgradeProgress, ClustersTypes.UpgradeSpec, ClustersTypes.UpgradeStatus

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.vcenter.namespace_management.software.ClustersTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ClustersTypes.Info	get(java.lang.String cluster) Returns upgrade related information of a specific cluster.
void	get(java.lang.String cluster, AsyncCallback<ClustersTypes.Info> asyncCallback) Returns upgrade related information of a specific cluster.
void	get(java.lang.String cluster, AsyncCallback<ClustersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns upgrade related information of a specific cluster.
ClustersTypes.Info	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns upgrade related information of a specific cluster.
java.util.List<ClustersTypes.Summary>	list() Returns upgrade related information about all WCP enabled clusters.
void	list(AsyncCallback<java.util.List<ClustersTypes.Summary>> asyncCallback) Returns upgrade related information about all WCP enabled clusters.
void	list(AsyncCallback<java.util.List<ClustersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns upgrade related information about all WCP enabled clusters.
java.util.List<ClustersTypes.Summary>	list(InvocationConfig invocationConfig) Returns upgrade related information about all WCP enabled clusters.
void	upgrade(java.lang.String cluster, ClustersTypes.UpgradeSpec spec) Upgrade the cluster to a specific version.
void	upgrade(java.lang.String cluster, ClustersTypes.UpgradeSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Upgrade the cluster to a specific version.
void	upgrade(java.lang.String cluster, ClustersTypes.UpgradeSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Upgrade the cluster to a specific version.
void	upgrade(java.lang.String cluster, ClustersTypes.UpgradeSpec spec, InvocationConfig invocationConfig) Upgrade the cluster to a specific version.
java.util.Map<java.lang.String,ClustersTypes.Result>	upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs) Upgrade a set of clusters to its corresponding specific version.
void	upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs, AsyncCallback<java.util.Map<java.lang.String,ClustersTypes.Result>> asyncCallback) Upgrade a set of clusters to its corresponding specific version.
void	upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs, AsyncCallback<java.util.Map<java.lang.String,ClustersTypes.Result>> asyncCallback, InvocationConfig invocationConfig) Upgrade a set of clusters to its corresponding specific version.
java.util.Map<java.lang.String,ClustersTypes.Result>	upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs, InvocationConfig invocationConfig) Upgrade a set of clusters to its corresponding specific version.

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

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ClustersStub

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

ClustersStub

public ClustersStub(ApiProvider apiProvider,
                    StubConfigurationBase config)

Method Detail

upgrade

public void upgrade(java.lang.String cluster,
                    ClustersTypes.UpgradeSpec spec)

Description copied from interface: Clusters

Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

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

Specified by:

upgrade in interface Clusters

Parameters:

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

spec - Specification for upgrading the cluster.

upgrade

public void upgrade(java.lang.String cluster,
                    ClustersTypes.UpgradeSpec spec,
                    InvocationConfig invocationConfig)

Description copied from interface: Clusters

Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

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:

upgrade in interface Clusters

Parameters:

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

spec - Specification for upgrading the cluster.

invocationConfig - Configuration for the method invocation.

upgrade

public void upgrade(java.lang.String cluster,
                    ClustersTypes.UpgradeSpec spec,
                    AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Clusters

Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

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.
Unsupported - if pre-check failed of the cluster.
NotFound - if cluster could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege.

Specified by:

upgrade in interface Clusters

Parameters:

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

spec - Specification for upgrading the cluster.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

upgrade

public void upgrade(java.lang.String cluster,
                    ClustersTypes.UpgradeSpec spec,
                    AsyncCallback<java.lang.Void> asyncCallback,
                    InvocationConfig invocationConfig)

Description copied from interface: Clusters

Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

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.
Unsupported - if pre-check failed of the cluster.
NotFound - if cluster could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege.

Specified by:

upgrade in interface Clusters

Parameters:

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

spec - Specification for upgrading the cluster.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

upgradeMultiple

public java.util.Map<java.lang.String,ClustersTypes.Result> upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs)

Description copied from interface: Clusters

Upgrade a set of clusters to its corresponding specific version.

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

Specified by:

upgradeMultiple in interface Clusters

Parameters:

specs - Specifications for upgrading selected clusters. The key in the parameter Map must be an identifier for the resource type: ClusterComputeResource.

Returns:

Pre-check result when invoking upgrade for each cluster. The key in the return value Map will be an identifier for the resource type: ClusterComputeResource.

upgradeMultiple

public java.util.Map<java.lang.String,ClustersTypes.Result> upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs,
                                                                            InvocationConfig invocationConfig)

Description copied from interface: Clusters

Upgrade a set of clusters to its corresponding specific version.

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:

upgradeMultiple in interface Clusters

Parameters:

specs - Specifications for upgrading selected clusters. The key in the parameter Map must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Pre-check result when invoking upgrade for each cluster. The key in the return value Map will be an identifier for the resource type: ClusterComputeResource.

upgradeMultiple

public void upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs,
                            AsyncCallback<java.util.Map<java.lang.String,ClustersTypes.Result>> asyncCallback)

Description copied from interface: Clusters

Upgrade a set of clusters to its corresponding specific version.

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

Invocation Result:
Pre-check result when invoking upgrade for each cluster. The key in the return value Map will be an identifier for the resource type: ClusterComputeResource.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege on all specified clusters.

Specified by:

upgradeMultiple in interface Clusters

Parameters:

specs - Specifications for upgrading selected clusters. The key in the parameter Map must be an identifier for the resource type: ClusterComputeResource.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

upgradeMultiple

public void upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs,
                            AsyncCallback<java.util.Map<java.lang.String,ClustersTypes.Result>> asyncCallback,
                            InvocationConfig invocationConfig)

Description copied from interface: Clusters

Upgrade a set of clusters to its corresponding specific version.

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:
Pre-check result when invoking upgrade for each cluster. The key in the return value Map will be an identifier for the resource type: ClusterComputeResource.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege on all specified clusters.

Specified by:

upgradeMultiple in interface Clusters

Parameters:

specs - Specifications for upgrading selected clusters. The key in the parameter Map 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.

get

public ClustersTypes.Info get(java.lang.String cluster)

Description copied from interface: Clusters

Returns upgrade related information of a specific cluster.

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

Specified by:

get in interface Clusters

Parameters:

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

Returns:

Information about the upgrade of the specified WCP enabled cluster.

get

public ClustersTypes.Info get(java.lang.String cluster,
                              InvocationConfig invocationConfig)

Description copied from interface: Clusters

Returns upgrade related information of a specific cluster.

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 Clusters

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

Information about the upgrade of the specified WCP enabled cluster.

get

public void get(java.lang.String cluster,
                AsyncCallback<ClustersTypes.Info> asyncCallback)

Description copied from interface: Clusters

Returns upgrade related information of a specific cluster.

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

Invocation Result:
Information about the upgrade of the specified WCP enabled cluster.

Operation Errors:
NotFound - if cluster could not be located.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Specified by:

get in interface Clusters

Parameters:

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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

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

Description copied from interface: Clusters

Returns upgrade related information of a specific cluster.

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 upgrade of the specified WCP enabled cluster.

Operation Errors:
NotFound - if cluster could not be located.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Specified by:

get in interface Clusters

Parameters:

cluster - Identifier for the cluster which will be upgraded. 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.

list

public java.util.List<ClustersTypes.Summary> list()

Description copied from interface: Clusters

Returns upgrade related information about all WCP enabled clusters.

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

Specified by:

list in interface Clusters

Returns:

List of upgrade summary of all WCP enabled clusters.

list

public java.util.List<ClustersTypes.Summary> list(InvocationConfig invocationConfig)

Description copied from interface: Clusters

Returns upgrade related information about all WCP enabled clusters.

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 Clusters

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

List of upgrade summary of all WCP enabled clusters.

list

public void list(AsyncCallback<java.util.List<ClustersTypes.Summary>> asyncCallback)

Description copied from interface: Clusters

Returns upgrade related information about all WCP enabled clusters.

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

Invocation Result:
List of upgrade summary of all WCP enabled clusters.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Specified by:

list in interface Clusters

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

public void list(AsyncCallback<java.util.List<ClustersTypes.Summary>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Clusters

Returns upgrade related information about all WCP enabled clusters.

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:
List of upgrade summary of all WCP enabled clusters.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Specified by:

list in interface Clusters

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.