com.vmware.vcenter.namespaces

Class InstancesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.namespaces.InstancesStub

All Implemented Interfaces:

Service, Instances, InstancesTypes

public class InstancesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Instances

Remote stub implementation of the Instances API service.

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

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 class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Constructor Summary

Constructors

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

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.

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

InstancesStub

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

InstancesStub

public InstancesStub(ApiProvider apiProvider,
                     StubConfigurationBase config)

Method Detail

create

public void create(InstancesTypes.CreateSpec spec)

Description copied from interface: Instances

Create namespace object in the cluster.

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

Specified by:

create in interface Instances

Parameters:

spec - Specification for setting up the namespace.

create

public void create(InstancesTypes.CreateSpec spec,
                   InvocationConfig invocationConfig)

Description copied from interface: Instances

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.

Specified by:

create in interface Instances

Parameters:

spec - Specification for setting up the namespace.

invocationConfig - Configuration for the method invocation.

create

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

Description copied from interface: Instances

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.

Specified by:

create in interface Instances

Parameters:

spec - Specification for setting up the namespace.

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

create

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

Description copied from interface: Instances

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.

Specified by:

create in interface Instances

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

public void delete(java.lang.String namespace)

Description copied from interface: Instances

Delete the namespace object in the cluster.

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

Specified by:

delete in interface Instances

Parameters:

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

delete

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

Description copied from interface: Instances

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.

Specified by:

delete in interface Instances

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.

delete

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

Description copied from interface: Instances

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.

Specified by:

delete in interface Instances

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

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

Description copied from interface: Instances

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.

Specified by:

delete in interface Instances

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

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

Description copied from interface: Instances

Returns information about a specific namespace.

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

Specified by:

get in interface Instances

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.

get

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

Description copied from interface: Instances

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.

Specified by:

get in interface Instances

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.

get

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

Description copied from interface: Instances

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.

Specified by:

get in interface Instances

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

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

Description copied from interface: Instances

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.

Specified by:

get in interface Instances

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

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

Description copied from interface: Instances

Returns the information about all namespaces on this vCenter.

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

Specified by:

list in interface Instances

Returns:

The list of summary of all namespaces.

list

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

Description copied from interface: Instances

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.

Specified by:

list in interface Instances

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

The list of summary of all namespaces.

list

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

Description copied from interface: Instances

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.

Specified by:

list in interface Instances

Parameters:

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

list

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

Description copied from interface: Instances

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.

Specified by:

list in interface Instances

Parameters:

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

invocationConfig - Configuration for the method invocation.

set

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

Description copied from interface: Instances

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.

Specified by:

set in interface Instances

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.

set

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

Description copied from interface: Instances

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.

Specified by:

set in interface Instances

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.

set

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

Description copied from interface: Instances

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.

Specified by:

set in interface Instances

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

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

Description copied from interface: Instances

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.

Specified by:

set in interface Instances

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

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

Description copied from interface: Instances

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.

Specified by:

update in interface Instances

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.

update

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

Description copied from interface: Instances

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.

Specified by:

update in interface Instances

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.

update

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

Description copied from interface: Instances

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.

Specified by:

update in interface Instances

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

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

Description copied from interface: Instances

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.

Specified by:

update in interface Instances

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.