com.vmware.vcenter.authorization.vt_containers

Interface Mappings

All Superinterfaces:

MappingsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

MappingsStub

public interface Mappings
extends com.vmware.vapi.bindings.Service, MappingsTypes

The Mappings interface can be used to manage the relationship between containerized objects and vTContainer instances. A containerized object is any data object that is associated with a vTContainer instance, and can be of any resource type.

Each vTContainer instance can hold any number of containerized objects, but there is a service defined limit to the number of vTContainer instances that can be associated with a single containerized object.

When a containerized object is deleted, its mappings to vTContainer instances are automatically removed. However, a vTContainer instance cannot be deleted until all mappings to it have been removed.

. This interface was added in vSphere API 8.0.3.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.authorization.vt_containers.MappingsTypes

MappingsTypes.CreateSpec, MappingsTypes.FilterSpec, MappingsTypes.Info, MappingsTypes.IterationSpec, MappingsTypes.ListItem, MappingsTypes.ListResult

Field Summary

Fields inherited from interface com.vmware.vcenter.authorization.vt_containers.MappingsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(MappingsTypes.CreateSpec spec) Creates a new mapping that associates an object with a vTContainer instance.
void	create(MappingsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Creates a new mapping that associates an object with a vTContainer instance.
void	create(MappingsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a new mapping that associates an object with a vTContainer instance.
java.lang.String	create(MappingsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a new mapping that associates an object with a vTContainer instance.
void	delete(java.lang.String mapping) Removes a mapping.
void	delete(java.lang.String mapping, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Removes a mapping.
void	delete(java.lang.String mapping, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Removes a mapping.
void	delete(java.lang.String mapping, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Removes a mapping.
MappingsTypes.Info	get(java.lang.String mapping) Returns information about a single mapping indicating the containerized object and its associated vTContainer instance.
void	get(java.lang.String mapping, com.vmware.vapi.bindings.client.AsyncCallback<MappingsTypes.Info> asyncCallback) Returns information about a single mapping indicating the containerized object and its associated vTContainer instance.
void	get(java.lang.String mapping, com.vmware.vapi.bindings.client.AsyncCallback<MappingsTypes.Info> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a single mapping indicating the containerized object and its associated vTContainer instance.
MappingsTypes.Info	get(java.lang.String mapping, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a single mapping indicating the containerized object and its associated vTContainer instance.
MappingsTypes.ListResult	list(MappingsTypes.FilterSpec filter, MappingsTypes.IterationSpec iterate) Returns the list of mappings indicating the containerized objects and their associated vTContainer instances.
void	list(MappingsTypes.FilterSpec filter, MappingsTypes.IterationSpec iterate, com.vmware.vapi.bindings.client.AsyncCallback<MappingsTypes.ListResult> asyncCallback) Returns the list of mappings indicating the containerized objects and their associated vTContainer instances.
void	list(MappingsTypes.FilterSpec filter, MappingsTypes.IterationSpec iterate, com.vmware.vapi.bindings.client.AsyncCallback<MappingsTypes.ListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the list of mappings indicating the containerized objects and their associated vTContainer instances.
MappingsTypes.ListResult	list(MappingsTypes.FilterSpec filter, MappingsTypes.IterationSpec iterate, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the list of mappings indicating the containerized objects and their associated vTContainer instances.

Method Detail

create

java.lang.String create(MappingsTypes.CreateSpec spec)

Creates a new mapping that associates an object with a vTContainer instance. This method was added in vSphere API 8.0.3.0.

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

Parameters:

spec - The specification of a new mapping.

Returns:

The identifier of the new mapping. The return value will be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

Throws:

AlreadyExists - if the configuration already exists.

Error - if there is a generic error.

InvalidArgument - if the inputs are not valid.

NotAllowedInCurrentState - if the limit of mappings for the specified object has been reached.

NotFound - if the vTContainer or the object does not exist.

Unsupported - if the object type does not support containerization.

Unauthenticated - if the caller cannot be authenticated.

Unauthorized - if the caller does not have the Authorization.ModifyPermissions privilege on the specified object.

Unauthorized - if the caller does not have privilege to access objects in the specified vTContainer.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Authorization.ModifyVTContainerMappings.

create

java.lang.String create(MappingsTypes.CreateSpec spec,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Creates a new mapping that associates an object with a vTContainer instance. This method was added in vSphere API 8.0.3.0.

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 - The specification of a new mapping.

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the new mapping. The return value will be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

Throws:

AlreadyExists - if the configuration already exists.

Error - if there is a generic error.

InvalidArgument - if the inputs are not valid.

NotAllowedInCurrentState - if the limit of mappings for the specified object has been reached.

NotFound - if the vTContainer or the object does not exist.

Unsupported - if the object type does not support containerization.

Unauthenticated - if the caller cannot be authenticated.

Unauthorized - if the caller does not have the Authorization.ModifyPermissions privilege on the specified object.

Unauthorized - if the caller does not have privilege to access objects in the specified vTContainer.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Authorization.ModifyVTContainerMappings.

create

void create(MappingsTypes.CreateSpec spec,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Creates a new mapping that associates an object with a vTContainer instance. This method was added in vSphere API 8.0.3.0.

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

Invocation Result:
The identifier of the new mapping. The return value will be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

Operation Errors:
AlreadyExists - if the configuration already exists.
Error - if there is a generic error.
InvalidArgument - if the inputs are not valid.
NotAllowedInCurrentState - if the limit of mappings for the specified object has been reached.
NotFound - if the vTContainer or the object does not exist.
Unsupported - if the object type does not support containerization.
Unauthenticated - if the caller cannot be authenticated.
Unauthorized - if the caller does not have the Authorization.ModifyPermissions privilege on the specified object.
Unauthorized - if the caller does not have privilege to access objects in the specified vTContainer.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Authorization.ModifyVTContainerMappings.

Parameters:

spec - The specification of a new mapping.

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

create

void create(MappingsTypes.CreateSpec spec,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Creates a new mapping that associates an object with a vTContainer instance. This method was added in vSphere API 8.0.3.0.

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 identifier of the new mapping. The return value will be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

Operation Errors:
AlreadyExists - if the configuration already exists.
Error - if there is a generic error.
InvalidArgument - if the inputs are not valid.
NotAllowedInCurrentState - if the limit of mappings for the specified object has been reached.
NotFound - if the vTContainer or the object does not exist.
Unsupported - if the object type does not support containerization.
Unauthenticated - if the caller cannot be authenticated.
Unauthorized - if the caller does not have the Authorization.ModifyPermissions privilege on the specified object.
Unauthorized - if the caller does not have privilege to access objects in the specified vTContainer.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Authorization.ModifyVTContainerMappings.

Parameters:

spec - The specification of a new mapping.

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

invocationConfig - Configuration for the method invocation.

list

MappingsTypes.ListResult list(MappingsTypes.FilterSpec filter,
                              MappingsTypes.IterationSpec iterate)

Returns the list of mappings indicating the containerized objects and their associated vTContainer instances. This method was added in vSphere API 8.0.3.0.

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

Parameters:

filter - The specification of matching mappings to be retrieved. If null all mappings will be returned.

iterate - The specification of a page to be retrieved. if null the first set of items will be returned.

Returns:

A list of mappings.

Throws:

Error - if there is a generic error.

InvalidArgument - if the inputs are not valid.

Unauthenticated - if the caller cannot be authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

list

MappingsTypes.ListResult list(MappingsTypes.FilterSpec filter,
                              MappingsTypes.IterationSpec iterate,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the list of mappings indicating the containerized objects and their associated vTContainer instances. This method was added in vSphere API 8.0.3.0.

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:

filter - The specification of matching mappings to be retrieved. If null all mappings will be returned.

iterate - The specification of a page to be retrieved. if null the first set of items will be returned.

invocationConfig - Configuration for the method invocation.

Returns:

A list of mappings.

Throws:

Error - if there is a generic error.

InvalidArgument - if the inputs are not valid.

Unauthenticated - if the caller cannot be authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

list

void list(MappingsTypes.FilterSpec filter,
          MappingsTypes.IterationSpec iterate,
          com.vmware.vapi.bindings.client.AsyncCallback<MappingsTypes.ListResult> asyncCallback)

Returns the list of mappings indicating the containerized objects and their associated vTContainer instances. This method was added in vSphere API 8.0.3.0.

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

Invocation Result:
A list of mappings.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the inputs are not valid.
Unauthenticated - if the caller cannot be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

filter - The specification of matching mappings to be retrieved. If null all mappings will be returned.

iterate - The specification of a page to be retrieved. if null the first set of items will be returned.

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

list

void list(MappingsTypes.FilterSpec filter,
          MappingsTypes.IterationSpec iterate,
          com.vmware.vapi.bindings.client.AsyncCallback<MappingsTypes.ListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the list of mappings indicating the containerized objects and their associated vTContainer instances. This method was added in vSphere API 8.0.3.0.

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:
A list of mappings.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the inputs are not valid.
Unauthenticated - if the caller cannot be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

filter - The specification of matching mappings to be retrieved. If null all mappings will be returned.

iterate - The specification of a page to be retrieved. if null the first set of items will be returned.

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

invocationConfig - Configuration for the method invocation.

get

MappingsTypes.Info get(java.lang.String mapping)

Returns information about a single mapping indicating the containerized object and its associated vTContainer instance. This method was added in vSphere API 8.0.3.0.

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

Parameters:

mapping - The mapping identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

Returns:

The mapping information.

Throws:

Error - if there is a generic error.

NotFound - if the mapping is not found.

Unauthenticated - if the caller cannot be authenticated.

Unauthorized - if the caller does not have privilege to access objects in the vTContainer that is associated with the mapping.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

get

MappingsTypes.Info get(java.lang.String mapping,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a single mapping indicating the containerized object and its associated vTContainer instance. This method was added in vSphere API 8.0.3.0.

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:

mapping - The mapping identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

invocationConfig - Configuration for the method invocation.

Returns:

The mapping information.

Throws:

Error - if there is a generic error.

NotFound - if the mapping is not found.

Unauthenticated - if the caller cannot be authenticated.

Unauthorized - if the caller does not have privilege to access objects in the vTContainer that is associated with the mapping.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

get

void get(java.lang.String mapping,
         com.vmware.vapi.bindings.client.AsyncCallback<MappingsTypes.Info> asyncCallback)

Returns information about a single mapping indicating the containerized object and its associated vTContainer instance. This method was added in vSphere API 8.0.3.0.

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

Invocation Result:
The mapping information.

Operation Errors:
Error - if there is a generic error.
NotFound - if the mapping is not found.
Unauthenticated - if the caller cannot be authenticated.
Unauthorized - if the caller does not have privilege to access objects in the vTContainer that is associated with the mapping.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

mapping - The mapping identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

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

get

void get(java.lang.String mapping,
         com.vmware.vapi.bindings.client.AsyncCallback<MappingsTypes.Info> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a single mapping indicating the containerized object and its associated vTContainer instance. This method was added in vSphere API 8.0.3.0.

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 mapping information.

Operation Errors:
Error - if there is a generic error.
NotFound - if the mapping is not found.
Unauthenticated - if the caller cannot be authenticated.
Unauthorized - if the caller does not have privilege to access objects in the vTContainer that is associated with the mapping.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

mapping - The mapping identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String mapping)

Removes a mapping. The related object will no longer be associated with the vTContainer instance. This method was added in vSphere API 8.0.3.0.

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

Parameters:

mapping - The mapping identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

Throws:

Error - if there is a generic error.

NotFound - if the mapping is not found.

Unauthenticated - if the caller cannot be authenticated.

Unauthorized - if the caller does not have the Authorization.ModifyPermissions privilege on the object that is associated with the mapping.

Unauthorized - if the caller does not have privilege to access objects in the vTContainer that is associated with the mapping.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Authorization.ModifyVTContainerMappings.

delete

void delete(java.lang.String mapping,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Removes a mapping. The related object will no longer be associated with the vTContainer instance. This method was added in vSphere API 8.0.3.0.

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:

mapping - The mapping identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if there is a generic error.

NotFound - if the mapping is not found.

Unauthenticated - if the caller cannot be authenticated.

Unauthorized - if the caller does not have the Authorization.ModifyPermissions privilege on the object that is associated with the mapping.

Unauthorized - if the caller does not have privilege to access objects in the vTContainer that is associated with the mapping.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Authorization.ModifyVTContainerMappings.

delete

void delete(java.lang.String mapping,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Removes a mapping. The related object will no longer be associated with the vTContainer instance. This method was added in vSphere API 8.0.3.0.

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

Operation Errors:
Error - if there is a generic error.
NotFound - if the mapping is not found.
Unauthenticated - if the caller cannot be authenticated.
Unauthorized - if the caller does not have the Authorization.ModifyPermissions privilege on the object that is associated with the mapping.
Unauthorized - if the caller does not have privilege to access objects in the vTContainer that is associated with the mapping.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Authorization.ModifyVTContainerMappings.

Parameters:

mapping - The mapping identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

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

delete

void delete(java.lang.String mapping,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Removes a mapping. The related object will no longer be associated with the vTContainer instance. This method was added in vSphere API 8.0.3.0.

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 there is a generic error.
NotFound - if the mapping is not found.
Unauthenticated - if the caller cannot be authenticated.
Unauthorized - if the caller does not have the Authorization.ModifyPermissions privilege on the object that is associated with the mapping.
Unauthorized - if the caller does not have privilege to access objects in the vTContainer that is associated with the mapping.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Authorization.ModifyVTContainerMappings.

Parameters:

mapping - The mapping identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.authorization.vt_containers.Mapping.

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

invocationConfig - Configuration for the method invocation.