com.vmware.vcenter.namespaces

Interface NamespaceTemplates

All Superinterfaces:

NamespaceTemplatesTypes, Service

All Known Implementing Classes:

NamespaceTemplatesStub

public interface NamespaceTemplates
extends Service, NamespaceTemplatesTypes

Nested Class Summary

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

NamespaceTemplatesTypes.CreateSpec, NamespaceTemplatesTypes.Info, NamespaceTemplatesTypes.Subject, NamespaceTemplatesTypes.Summary, NamespaceTemplatesTypes.UpdateSpec

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String cluster, NamespaceTemplatesTypes.CreateSpec spec) Creates a namespace template on a cluster on which vSphere Namespaces are enabled on this vCenter.
void	create(java.lang.String cluster, NamespaceTemplatesTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Creates a namespace template on a cluster on which vSphere Namespaces are enabled on this vCenter.
void	create(java.lang.String cluster, NamespaceTemplatesTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Creates a namespace template on a cluster on which vSphere Namespaces are enabled on this vCenter.
void	create(java.lang.String cluster, NamespaceTemplatesTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a namespace template on a cluster on which vSphere Namespaces are enabled on this vCenter.
NamespaceTemplatesTypes.Info	get(java.lang.String cluster, java.lang.String template) Get the information about a namespace template on given cluster.
void	get(java.lang.String cluster, java.lang.String template, AsyncCallback<NamespaceTemplatesTypes.Info> asyncCallback) Get the information about a namespace template on given cluster.
void	get(java.lang.String cluster, java.lang.String template, AsyncCallback<NamespaceTemplatesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get the information about a namespace template on given cluster.
NamespaceTemplatesTypes.Info	get(java.lang.String cluster, java.lang.String template, InvocationConfig invocationConfig) Get the information about a namespace template on given cluster.
java.util.List<NamespaceTemplatesTypes.Summary>	list(java.lang.String cluster) Returns information about all the namespace templates associated with a cluster on which vSphere Namespaces are enabled on this vCenter.
void	list(java.lang.String cluster, AsyncCallback<java.util.List<NamespaceTemplatesTypes.Summary>> asyncCallback) Returns information about all the namespace templates associated with a cluster on which vSphere Namespaces are enabled on this vCenter.
void	list(java.lang.String cluster, AsyncCallback<java.util.List<NamespaceTemplatesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about all the namespace templates associated with a cluster on which vSphere Namespaces are enabled on this vCenter.
java.util.List<NamespaceTemplatesTypes.Summary>	list(java.lang.String cluster, InvocationConfig invocationConfig) Returns information about all the namespace templates associated with a cluster on which vSphere Namespaces are enabled on this vCenter.
void	update(java.lang.String cluster, java.lang.String template, NamespaceTemplatesTypes.UpdateSpec spec) Updates a namespace template associated with a cluster on which vSphere Namespaces are enabled on this vCenter.
void	update(java.lang.String cluster, java.lang.String template, NamespaceTemplatesTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Updates a namespace template associated with a cluster on which vSphere Namespaces are enabled on this vCenter.
void	update(java.lang.String cluster, java.lang.String template, NamespaceTemplatesTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates a namespace template associated with a cluster on which vSphere Namespaces are enabled on this vCenter.
void	update(java.lang.String cluster, java.lang.String template, NamespaceTemplatesTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates a namespace template associated with a cluster on which vSphere Namespaces are enabled on this vCenter.

Method Detail

get

NamespaceTemplatesTypes.Info get(java.lang.String cluster,
                                 java.lang.String template)

Get the information about a namespace template on given cluster. This method was added in vSphere API 7.0.2.00100.

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

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

template - Name of the namespace template. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.

Returns:

Information about the namespace template.

Throws:

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

NotFound - if cluster doesn't exist or if template doesn't exist.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

NamespaceTemplatesTypes.Info get(java.lang.String cluster,
                                 java.lang.String template,
                                 InvocationConfig invocationConfig)

Get the information about a namespace template on given cluster. This method was added in vSphere API 7.0.2.00100.

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:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

template - Name of the namespace template. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the namespace template.

Throws:

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

NotFound - if cluster doesn't exist or if template doesn't exist.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

void get(java.lang.String cluster,
         java.lang.String template,
         AsyncCallback<NamespaceTemplatesTypes.Info> asyncCallback)

Get the information about a namespace template on given cluster. This method was added in vSphere API 7.0.2.00100.

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

Invocation Result:
Information about the namespace template.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if cluster doesn't exist or if template doesn't exist.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

template - Name of the namespace template. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.

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

get

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

Get the information about a namespace template on given cluster. This method was added in vSphere API 7.0.2.00100.

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 namespace template.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if cluster doesn't exist or if template doesn't exist.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

template - Name of the namespace template. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<NamespaceTemplatesTypes.Summary> list(java.lang.String cluster)

Returns information about all the namespace templates associated with a cluster on which vSphere Namespaces are enabled on this vCenter. This method was added in vSphere API 7.0.2.00100.

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

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

List of summary of all namespace templates associated with cluster with vSphere Namespaces enabled.

Throws:

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

NotFound - if cluster doesn't exist.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

java.util.List<NamespaceTemplatesTypes.Summary> list(java.lang.String cluster,
                                                     InvocationConfig invocationConfig)

Returns information about all the namespace templates associated with a cluster on which vSphere Namespaces are enabled on this vCenter. This method was added in vSphere API 7.0.2.00100.

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:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

List of summary of all namespace templates associated with cluster with vSphere Namespaces enabled.

Throws:

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

NotFound - if cluster doesn't exist.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

void list(java.lang.String cluster,
          AsyncCallback<java.util.List<NamespaceTemplatesTypes.Summary>> asyncCallback)

Returns information about all the namespace templates associated with a cluster on which vSphere Namespaces are enabled on this vCenter. This method was added in vSphere API 7.0.2.00100.

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

Invocation Result:
List of summary of all namespace templates associated with cluster with vSphere Namespaces enabled.

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

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

list

void list(java.lang.String cluster,
          AsyncCallback<java.util.List<NamespaceTemplatesTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about all the namespace templates associated with a cluster on which vSphere Namespaces are enabled on this vCenter. This method was added in vSphere API 7.0.2.00100.

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 summary of all namespace templates associated with cluster with vSphere Namespaces enabled.

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

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. 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.

create

void create(java.lang.String cluster,
            NamespaceTemplatesTypes.CreateSpec spec)

Creates a namespace template on a cluster on which vSphere Namespaces are enabled on this vCenter. This release supports creating a single namespace template, and the call fails if there is a request to make another one. This method was added in vSphere API 7.0.2.00100.

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

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for setting up the namespace template.

Throws:

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

NotFound - if cluster doesn't exist.

InvalidArgument - if spec contain any errors, or if {link CreateSpec#storageSpecs} is empty, or if {link CreateSpec#resourceSpec} is not set with {term memory_limit}, {term cpu_limit}, {term storage_request_limit}, or if {link CreateSpec#networks} is not set with networks if the {term cluster} hosting the namespaces uses VSPHERE_NETWORK as its network provider, or if {link CreateSpec#networks} is not empty if the {term cluster} hosting the namespaces uses NSXT_CONTAINER_PLUGIN as its network provider.

Unsupported - if a request arrives to create a second template.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.

AlreadyExists - if the namespace template with given name already exists.

create

void create(java.lang.String cluster,
            NamespaceTemplatesTypes.CreateSpec spec,
            InvocationConfig invocationConfig)

Creates a namespace template on a cluster on which vSphere Namespaces are enabled on this vCenter. This release supports creating a single namespace template, and the call fails if there is a request to make another one. This method was added in vSphere API 7.0.2.00100.

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:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for setting up the namespace template.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if cluster doesn't exist.

InvalidArgument - if spec contain any errors, or if {link CreateSpec#storageSpecs} is empty, or if {link CreateSpec#resourceSpec} is not set with {term memory_limit}, {term cpu_limit}, {term storage_request_limit}, or if {link CreateSpec#networks} is not set with networks if the {term cluster} hosting the namespaces uses VSPHERE_NETWORK as its network provider, or if {link CreateSpec#networks} is not empty if the {term cluster} hosting the namespaces uses NSXT_CONTAINER_PLUGIN as its network provider.

Unsupported - if a request arrives to create a second template.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.

AlreadyExists - if the namespace template with given name already exists.

create

void create(java.lang.String cluster,
            NamespaceTemplatesTypes.CreateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Creates a namespace template on a cluster on which vSphere Namespaces are enabled on this vCenter. This release supports creating a single namespace template, and the call fails if there is a request to make another one. This method was added in vSphere API 7.0.2.00100.

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 cluster doesn't exist.
InvalidArgument - if spec contain any errors, or if {link CreateSpec#storageSpecs} is empty, or if {link CreateSpec#resourceSpec} is not set with {term memory_limit}, {term cpu_limit}, {term storage_request_limit}, or if {link CreateSpec#networks} is not set with networks if the {term cluster} hosting the namespaces uses VSPHERE_NETWORK as its network provider, or if {link CreateSpec#networks} is not empty if the {term cluster} hosting the namespaces uses NSXT_CONTAINER_PLUGIN as its network provider.
Unsupported - if a request arrives to create a second template.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.
AlreadyExists - if the namespace template with given name already exists.

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for setting up the namespace template.

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

create

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

Creates a namespace template on a cluster on which vSphere Namespaces are enabled on this vCenter. This release supports creating a single namespace template, and the call fails if there is a request to make another one. This method was added in vSphere API 7.0.2.00100.

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 cluster doesn't exist.
InvalidArgument - if spec contain any errors, or if {link CreateSpec#storageSpecs} is empty, or if {link CreateSpec#resourceSpec} is not set with {term memory_limit}, {term cpu_limit}, {term storage_request_limit}, or if {link CreateSpec#networks} is not set with networks if the {term cluster} hosting the namespaces uses VSPHERE_NETWORK as its network provider, or if {link CreateSpec#networks} is not empty if the {term cluster} hosting the namespaces uses NSXT_CONTAINER_PLUGIN as its network provider.
Unsupported - if a request arrives to create a second template.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.
AlreadyExists - if the namespace template with given name already exists.

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for setting up the namespace template.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String cluster,
            java.lang.String template,
            NamespaceTemplatesTypes.UpdateSpec spec)

Updates a namespace template associated with a cluster on which vSphere Namespaces are enabled on this vCenter. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is. This method was added in vSphere API 7.0.2.00100.

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

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

template - Name of the namespace template. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.

spec - Specification for updating the namespace template.

Throws:

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

NotFound - if cluster doesn't exist or if template doesn't exist.

InvalidArgument - if spec contain any errors.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.

update

void update(java.lang.String cluster,
            java.lang.String template,
            NamespaceTemplatesTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Updates a namespace template associated with a cluster on which vSphere Namespaces are enabled on this vCenter. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is. This method was added in vSphere API 7.0.2.00100.

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:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

template - Name of the namespace template. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.

spec - Specification for updating the namespace template.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if cluster doesn't exist or if template doesn't exist.

InvalidArgument - if spec contain any errors.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.

update

void update(java.lang.String cluster,
            java.lang.String template,
            NamespaceTemplatesTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Updates a namespace template associated with a cluster on which vSphere Namespaces are enabled on this vCenter. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is. This method was added in vSphere API 7.0.2.00100.

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 cluster doesn't exist or if template doesn't exist.
InvalidArgument - if spec contain any errors.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

template - Name of the namespace template. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.

spec - Specification for updating the namespace template.

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

update

void update(java.lang.String cluster,
            java.lang.String template,
            NamespaceTemplatesTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Updates a namespace template associated with a cluster on which vSphere Namespaces are enabled on this vCenter. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is. This method was added in vSphere API 7.0.2.00100.

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 cluster doesn't exist or if template doesn't exist.
InvalidArgument - if spec contain any errors.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

template - Name of the namespace template. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.

spec - Specification for updating the namespace template.

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

invocationConfig - Configuration for the method invocation.