com.vmware.vcenter.namespaces

Interface Instances

All Superinterfaces:

InstancesTypes, Service

All Known Implementing Classes:

InstancesStub

public interface Instances
extends Service, InstancesTypes

The Instances interface provides methods to create and delete a namespace object. In this version, an Instance is an abstraction around a Kubernetes namespace.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespaces.InstancesTypes

InstancesTypes.Access, InstancesTypes.ConfigStatus, InstancesTypes.CreateSpec, InstancesTypes.Info, InstancesTypes.Message, InstancesTypes.SetSpec, InstancesTypes.Stats, InstancesTypes.StorageSpec, InstancesTypes.Summary, InstancesTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.namespaces.InstancesTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
void	create(InstancesTypes.CreateSpec spec) Create namespace object in the cluster.
void	create(InstancesTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Create namespace object in the cluster.
void	create(InstancesTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Create namespace object in the cluster.
void	create(InstancesTypes.CreateSpec spec, InvocationConfig invocationConfig) Create namespace object in the cluster.
void	delete(java.lang.String namespace) Delete the namespace object in the cluster.
void	delete(java.lang.String namespace, AsyncCallback<java.lang.Void> asyncCallback) Delete the namespace object in the cluster.
void	delete(java.lang.String namespace, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Delete the namespace object in the cluster.
void	delete(java.lang.String namespace, InvocationConfig invocationConfig) Delete the namespace object in the cluster.
InstancesTypes.Info	get(java.lang.String namespace) Returns information about a specific namespace.
void	get(java.lang.String namespace, AsyncCallback<InstancesTypes.Info> asyncCallback) Returns information about a specific namespace.
void	get(java.lang.String namespace, AsyncCallback<InstancesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a specific namespace.
InstancesTypes.Info	get(java.lang.String namespace, InvocationConfig invocationConfig) Returns information about a specific namespace.
java.util.List<InstancesTypes.Summary>	list() Returns the information about all namespaces on this vCenter.
void	list(AsyncCallback<java.util.List<InstancesTypes.Summary>> asyncCallback) Returns the information about all namespaces on this vCenter.
void	list(AsyncCallback<java.util.List<InstancesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns the information about all namespaces on this vCenter.
java.util.List<InstancesTypes.Summary>	list(InvocationConfig invocationConfig) Returns the information about all namespaces on this vCenter.
void	set(java.lang.String namespace, InstancesTypes.SetSpec spec) Set a new configuration on the namespace object.
void	set(java.lang.String namespace, InstancesTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Set a new configuration on the namespace object.
void	set(java.lang.String namespace, InstancesTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set a new configuration on the namespace object.
void	set(java.lang.String namespace, InstancesTypes.SetSpec spec, InvocationConfig invocationConfig) Set a new configuration on the namespace object.
void	update(java.lang.String namespace, InstancesTypes.UpdateSpec spec) Update the namespace object.
void	update(java.lang.String namespace, InstancesTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Update the namespace object.
void	update(java.lang.String namespace, InstancesTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Update the namespace object.
void	update(java.lang.String namespace, InstancesTypes.UpdateSpec spec, InvocationConfig invocationConfig) Update the namespace object.

Method Detail

create

void create(InstancesTypes.CreateSpec spec)

Create namespace object in the cluster.

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

Parameters:

spec - Specification for setting up the namespace.

Throws:

AlreadyExists - if a namespace with the same name exists in vCenter server.

Error - if the system reports an error while responding to the request.

InvalidArgument - if spec contain any errors or if an invalid name is specified.

NotAllowedInCurrentState - if the associated cluster is deing disabled.

NotFound - if InstancesTypes.CreateSpec.getCluster() is not registered on this vCenter server.

Unsupported - if InstancesTypes.CreateSpec.getCluster() is not enabled for Namespaces, or if the networks field is set when the InstancesTypes.CreateSpec.getCluster() hosting the namespace uses NSXT_CONTAINER_PLUGIN as its network provider.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

create

void create(InstancesTypes.CreateSpec spec,
            InvocationConfig invocationConfig)

Create namespace object in the 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.

Parameters:

spec - Specification for setting up the namespace.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if a namespace with the same name exists in vCenter server.

Error - if the system reports an error while responding to the request.

InvalidArgument - if spec contain any errors or if an invalid name is specified.

NotAllowedInCurrentState - if the associated cluster is deing disabled.

NotFound - if InstancesTypes.CreateSpec.getCluster() is not registered on this vCenter server.

Unsupported - if InstancesTypes.CreateSpec.getCluster() is not enabled for Namespaces, or if the networks field is set when the InstancesTypes.CreateSpec.getCluster() hosting the namespace uses NSXT_CONTAINER_PLUGIN as its network provider.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

create

void create(InstancesTypes.CreateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Create namespace object in the cluster.

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

Operation Errors:
AlreadyExists - if a namespace with the same name exists in vCenter server.
Error - if the system reports an error while responding to the request.
InvalidArgument - if spec contain any errors or if an invalid name is specified.
NotAllowedInCurrentState - if the associated cluster is deing disabled.
NotFound - if InstancesTypes.CreateSpec.getCluster() is not registered on this vCenter server.
Unsupported - if InstancesTypes.CreateSpec.getCluster() is not enabled for Namespaces, or if the networks field is set when the InstancesTypes.CreateSpec.getCluster() hosting the namespace uses NSXT_CONTAINER_PLUGIN as its network provider.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

spec - Specification for setting up the namespace.

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

create

void create(InstancesTypes.CreateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Create namespace object in the cluster.

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:
AlreadyExists - if a namespace with the same name exists in vCenter server.
Error - if the system reports an error while responding to the request.
InvalidArgument - if spec contain any errors or if an invalid name is specified.
NotAllowedInCurrentState - if the associated cluster is deing disabled.
NotFound - if InstancesTypes.CreateSpec.getCluster() is not registered on this vCenter server.
Unsupported - if InstancesTypes.CreateSpec.getCluster() is not enabled for Namespaces, or if the networks field is set when the InstancesTypes.CreateSpec.getCluster() hosting the namespace uses NSXT_CONTAINER_PLUGIN as its network provider.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

spec - Specification for setting up the namespace.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String namespace)

Delete the namespace object in the cluster.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the specified namespace could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

delete

void delete(java.lang.String namespace,
            InvocationConfig invocationConfig)

Delete the namespace object in the 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.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the specified namespace could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

delete

void delete(java.lang.String namespace,
            AsyncCallback<java.lang.Void> asyncCallback)

Delete the namespace object in the cluster.

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.
NotFound - if the specified namespace could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

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

delete

void delete(java.lang.String namespace,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Delete the namespace object in the cluster.

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.
NotFound - if the specified namespace could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

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

invocationConfig - Configuration for the method invocation.

get

InstancesTypes.Info get(java.lang.String namespace)

Returns information about a specific namespace.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

Returns:

Information about the desired state of the specified namespace.

Throws:

NotFound - if namespace 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.

get

InstancesTypes.Info get(java.lang.String namespace,
                        InvocationConfig invocationConfig)

Returns information about a specific namespace.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the desired state of the specified namespace.

Throws:

NotFound - if namespace 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.

get

void get(java.lang.String namespace,
         AsyncCallback<InstancesTypes.Info> asyncCallback)

Returns information about a specific namespace.

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

Invocation Result:
Information about the desired state of the specified namespace.

Operation Errors:
NotFound - if namespace 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.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

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

get

void get(java.lang.String namespace,
         AsyncCallback<InstancesTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information about a specific namespace.

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 desired state of the specified namespace.

Operation Errors:
NotFound - if namespace 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.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<InstancesTypes.Summary> list()

Returns the information about all namespaces on this vCenter.

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

Returns:

The list of summary of all namespaces.

Throws:

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.

list

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

Returns the information about all namespaces on this vCenter.

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

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

The list of summary of all namespaces.

Throws:

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.

list

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

Returns the information about all namespaces on this vCenter.

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

Invocation Result:
The list of summary of all namespaces.

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.

Parameters:

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

list

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

Returns the information about all namespaces on this vCenter.

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:
The list of summary of all namespaces.

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

set

void set(java.lang.String namespace,
         InstancesTypes.SetSpec spec)

Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

spec - New specification for the namespace.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if spec contain any errors.

NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.

NotFound - if namespace with the name namespace could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

set

void set(java.lang.String namespace,
         InstancesTypes.SetSpec spec,
         InvocationConfig invocationConfig)

Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

spec - New specification for the namespace.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if spec contain any errors.

NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.

NotFound - if namespace with the name namespace could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

set

void set(java.lang.String namespace,
         InstancesTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.

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.
InvalidArgument - if spec contain any errors.
NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.
NotFound - if namespace with the name namespace could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

spec - New specification for the namespace.

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

set

void set(java.lang.String namespace,
         InstancesTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.

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.
InvalidArgument - if spec contain any errors.
NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.
NotFound - if namespace with the name namespace could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

spec - New specification for the namespace.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String namespace,
            InstancesTypes.UpdateSpec spec)

Update the namespace object. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

spec - Specification for updating the namespace.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if spec contain any errors.

NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.

NotFound - if namespace with the name namespace could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

update

void update(java.lang.String namespace,
            InstancesTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Update the namespace object. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

spec - Specification for updating the namespace.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if spec contain any errors.

NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.

NotFound - if namespace with the name namespace could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

update

void update(java.lang.String namespace,
            InstancesTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Update the namespace object. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is.

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.
InvalidArgument - if spec contain any errors.
NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.
NotFound - if namespace with the name namespace could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

spec - Specification for updating the namespace.

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

update

void update(java.lang.String namespace,
            InstancesTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Update the namespace object. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is.

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.
InvalidArgument - if spec contain any errors.
NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.
NotFound - if namespace with the name namespace could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

spec - Specification for updating the namespace.

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

invocationConfig - Configuration for the method invocation.