Uses of Interface
com.vmware.vapi.bindings.Structure

Packages that use Structure

Package	Description
com.vmware.vapi.bindings
com.vmware.vapi.std	The com.vmware.vapi.std package provides standard types that can be used in the interface specification of any interface.
com.vmware.vapi.std.errors	The com.vmware.vapi.std.errors package provides the standard exceptions that can be included in the list of exceptions in the specification of methods to indicate that the method might report those exceptions.
com.vmware.vapi.std.interposition	The com.vmware.vapi.std.interposition package provides interfaces that TODO.
com.vmware.vapi.std.introspection	The com.vmware.vapi.std.introspection package provides interfaces that expose basic information about the vAPI interfaces registered with a vAPI provider.

Uses of Structure in com.vmware.vapi.bindings

Subinterfaces of Structure in com.vmware.vapi.bindings

Modifier and Type	Interface and Description
interface	DynamicStructure Interface representing a "dynamic structure".
interface	StaticStructure Interface implemented by all generated static bindings structures.

Classes in com.vmware.vapi.bindings that implement Structure

Modifier and Type	Class and Description
class	ApiError Common base class for all VMODL2 errors (standard and custom ones) in Java static language bindings.
class	DynamicStructureImpl DynamicStructure implementation backed by a StructValue.
class	UnresolvedError Concrete ApiError which represents a VMODL2 error that was reported but couldn't be resolved.

Methods in com.vmware.vapi.bindings with type parameters of type Structure

Modifier and Type	Method and Description
<T extends Structure> T	UnresolvedError._convertTo(Class<T> clazz)
<T extends Structure> T	Structure._convertTo(Class<T> clazz) Converts this structure into an instance of the provided class structure if possible.
<T extends Structure> T	DynamicStructureImpl._convertTo(Class<T> clazz)

Method parameters in com.vmware.vapi.bindings with type arguments of type Structure

Modifier and Type	Method and Description
boolean	UnresolvedError._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	Structure._hasTypeNameOf(Class<? extends Structure> clazz) Checks if the runtime type name of this structure matches the type represented by the specified binding class.
boolean	DynamicStructureImpl._hasTypeNameOf(Class<? extends Structure> clazz)

Uses of Structure in com.vmware.vapi.std

Classes in com.vmware.vapi.std that implement Structure

Modifier and Type	Class and Description
class	AuthenticationScheme The AuthenticationScheme class defines constants for authentication scheme identifiers for authentication mechanisms present in the vAPI infrastructure shipped by VMware.
class	DynamicID The DynamicID class represents an identifier for a resource of an arbitrary type.
class	LocalizableMessage The LocalizableMessage class represents localizable string and message template.
class	LocalizationParam This class holds a single message parameter and formatting settings for it.
class	NestedLocalizableMessage The NestedLocalizableMessage class represents a nested within a parameter localizable string or message template.

Methods in com.vmware.vapi.std with type parameters of type Structure

Modifier and Type	Method and Description
<T extends Structure> T	NestedLocalizableMessage._convertTo(Class<T> clazz)
<T extends Structure> T	LocalizationParam._convertTo(Class<T> clazz)
<T extends Structure> T	LocalizableMessage._convertTo(Class<T> clazz)
<T extends Structure> T	DynamicID._convertTo(Class<T> clazz)
<T extends Structure> T	AuthenticationScheme._convertTo(Class<T> clazz)

Method parameters in com.vmware.vapi.std with type arguments of type Structure

Modifier and Type	Method and Description
boolean	NestedLocalizableMessage._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	LocalizationParam._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	LocalizableMessage._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	DynamicID._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	AuthenticationScheme._hasTypeNameOf(Class<? extends Structure> clazz)

Uses of Structure in com.vmware.vapi.std.errors

Classes in com.vmware.vapi.std.errors that implement Structure

Modifier and Type	Class and Description
class	AlreadyExists The AlreadyExists exception indicates that an attempt was made to create an entity but the entity already exists.
class	AlreadyInDesiredState The AlreadyInDesiredState exception indicates that an attempt to change the state of a resource or service had no effect because the resource or service is already in the desired state.
class	ArgumentLocations The ArgumentLocations class describes which part(s) of the input to the method caused the exception.
class	Canceled The Canceled exception indicates that the method canceled itself in response to an explicit request to do so.
class	ConcurrentChange The ConcurrentChange exception indicates that a data structure, entity, or resource has been modified since some earlier point in time.
class	Error The Error exception describes theproperties common to all standard exceptions.
class	FeatureInUse The FeatureInUse exception indicates that an action cannot be completed because a feature is in use.
class	FileLocations The FileLocations class identifies the file(s) that caused the method to report the exception.
class	InternalServerError The InternalServerError exception indicates that the server encounters an unexpected condition that prevented it from fulfilling the request.
class	InvalidArgument The InvalidArgument exception indicates that the values received for one or more parameters are not acceptable.
class	InvalidElementConfiguration The InvalidElementConfiguration exception indicates that an attempt to modify the configuration of an element or a group containing the element failed due to the configuraton of the element.
class	InvalidElementType The InvalidElementType exception indicates that the server was unable to fulfil the request because an element of a specific type cannot be a member of particular group.
class	InvalidRequest The InvalidRequest exception indicates that the request is malformed in such a way that the server is unable to process it.
class	NotAllowedInCurrentState The NotAllowedInCurrentState exception indicates that the requested method is not allowed with a resource or service in its current state.
class	NotFound The NotFound exception indicates that a specified element could not be found.
class	OperationNotFound The OperationNotFound exception indicates that the method specified in the request could not be found.
class	ResourceBusy The ResourceBusy exception indicates that the method could not be completed because a resource it needs is busy.
class	ResourceInaccessible The ResourceInaccessible exception indicates that the method could not be completed because an entity is not accessible.
class	ResourceInUse The ResourceInUse exception indicates that the method could not be completed because a resource is in use.
class	ServiceUnavailable The ServiceUnavailable exception indicates that the interface is unavailable.
class	TimedOut The TimedOut exception indicates that the method did not complete within the allowed amount of time.
class	TransientIndication The TransientIndication class indicates whether or not the exception is transient.
class	UnableToAllocateResource The UnableToAllocateResource exception indicates that the method failed because it was unable to allocate or acquire a required resource.
class	Unauthenticated The Unauthenticated exception indicates that the method requires authentication and the user is not authenticated.
class	Unauthorized The Unauthorized exception indicates that the user is not authorized to perform the method.
class	UnexpectedInput The UnexpectedInput exception indicates that the request contained a parameter or property whose name is not known by the server.
class	Unsupported The Unsupported exception indicates that the method is not supported by the interface.
class	UnverifiedPeer The UnverifiedPeer exception indicates that an attempt to connect to an unknown or not-yet-trusted endpoint failed because the system was unable to verify the identity of the endpoint.

Methods in com.vmware.vapi.std.errors with type parameters of type Structure

Modifier and Type	Method and Description
<T extends Structure> T	UnverifiedPeer._convertTo(Class<T> clazz)
<T extends Structure> T	Unsupported._convertTo(Class<T> clazz)
<T extends Structure> T	UnexpectedInput._convertTo(Class<T> clazz)
<T extends Structure> T	Unauthorized._convertTo(Class<T> clazz)
<T extends Structure> T	Unauthenticated._convertTo(Class<T> clazz)
<T extends Structure> T	UnableToAllocateResource._convertTo(Class<T> clazz)
<T extends Structure> T	TransientIndication._convertTo(Class<T> clazz)
<T extends Structure> T	TimedOut._convertTo(Class<T> clazz)
<T extends Structure> T	ServiceUnavailable._convertTo(Class<T> clazz)
<T extends Structure> T	ResourceInaccessible._convertTo(Class<T> clazz)
<T extends Structure> T	ResourceInUse._convertTo(Class<T> clazz)
<T extends Structure> T	ResourceBusy._convertTo(Class<T> clazz)
<T extends Structure> T	OperationNotFound._convertTo(Class<T> clazz)
<T extends Structure> T	NotFound._convertTo(Class<T> clazz)
<T extends Structure> T	NotAllowedInCurrentState._convertTo(Class<T> clazz)
<T extends Structure> T	InvalidRequest._convertTo(Class<T> clazz)
<T extends Structure> T	InvalidElementType._convertTo(Class<T> clazz)
<T extends Structure> T	InvalidElementConfiguration._convertTo(Class<T> clazz)
<T extends Structure> T	InvalidArgument._convertTo(Class<T> clazz)
<T extends Structure> T	InternalServerError._convertTo(Class<T> clazz)
<T extends Structure> T	FileLocations._convertTo(Class<T> clazz)
<T extends Structure> T	FeatureInUse._convertTo(Class<T> clazz)
<T extends Structure> T	Error._convertTo(Class<T> clazz)
<T extends Structure> T	ConcurrentChange._convertTo(Class<T> clazz)
<T extends Structure> T	AlreadyInDesiredState._convertTo(Class<T> clazz)
<T extends Structure> T	Canceled._convertTo(Class<T> clazz)
<T extends Structure> T	ArgumentLocations._convertTo(Class<T> clazz)
<T extends Structure> T	AlreadyExists._convertTo(Class<T> clazz)

Methods in com.vmware.vapi.std.errors that return Structure

Modifier and Type	Method and Description
Structure	Error.getData() Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

Methods in com.vmware.vapi.std.errors with parameters of type Structure

Modifier and Type	Method and Description
UnverifiedPeer.Builder	UnverifiedPeer.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
Unsupported.Builder	Unsupported.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
UnexpectedInput.Builder	UnexpectedInput.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
Unauthorized.Builder	Unauthorized.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
Unauthenticated.Builder	Unauthenticated.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
UnableToAllocateResource.Builder	UnableToAllocateResource.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
TimedOut.Builder	TimedOut.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
ServiceUnavailable.Builder	ServiceUnavailable.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
ResourceInaccessible.Builder	ResourceInaccessible.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
ResourceInUse.Builder	ResourceInUse.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
ResourceBusy.Builder	ResourceBusy.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
OperationNotFound.Builder	OperationNotFound.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
NotFound.Builder	NotFound.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
NotAllowedInCurrentState.Builder	NotAllowedInCurrentState.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
InvalidRequest.Builder	InvalidRequest.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
InvalidElementType.Builder	InvalidElementType.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
InvalidElementConfiguration.Builder	InvalidElementConfiguration.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
InvalidArgument.Builder	InvalidArgument.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
InternalServerError.Builder	InternalServerError.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
FeatureInUse.Builder	FeatureInUse.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
void	Error.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
Error.Builder	Error.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
ConcurrentChange.Builder	ConcurrentChange.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
AlreadyInDesiredState.Builder	AlreadyInDesiredState.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
Canceled.Builder	Canceled.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.
AlreadyExists.Builder	AlreadyExists.Builder.setData(Structure data) Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

Method parameters in com.vmware.vapi.std.errors with type arguments of type Structure

Modifier and Type	Method and Description
boolean	UnverifiedPeer._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	Unsupported._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	UnexpectedInput._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	Unauthorized._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	Unauthenticated._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	UnableToAllocateResource._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	TransientIndication._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	TimedOut._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	ServiceUnavailable._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	ResourceInaccessible._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	ResourceInUse._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	ResourceBusy._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	OperationNotFound._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	NotFound._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	NotAllowedInCurrentState._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	InvalidRequest._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	InvalidElementType._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	InvalidElementConfiguration._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	InvalidArgument._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	InternalServerError._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	FileLocations._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	FeatureInUse._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	Error._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	ConcurrentChange._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	AlreadyInDesiredState._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	Canceled._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	ArgumentLocations._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	AlreadyExists._hasTypeNameOf(Class<? extends Structure> clazz)

Constructors in com.vmware.vapi.std.errors with parameters of type Structure

Constructor and Description
AlreadyExists(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
AlreadyInDesiredState(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
Canceled(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
ConcurrentChange(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
Error(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
FeatureInUse(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
InternalServerError(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
InvalidArgument(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
InvalidElementConfiguration(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
InvalidElementType(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
InvalidRequest(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
NotAllowedInCurrentState(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
NotFound(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
OperationNotFound(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
ResourceBusy(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
ResourceInaccessible(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
ResourceInUse(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
ServiceUnavailable(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
TimedOut(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
UnableToAllocateResource(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
Unauthenticated(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
Unauthorized(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
UnexpectedInput(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
Unsupported(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.
UnverifiedPeer(List<LocalizableMessage> messages, Structure data) This constructor is provided for backwards compatibility purposes only.

Uses of Structure in com.vmware.vapi.std.interposition

Classes in com.vmware.vapi.std.interposition that implement Structure

Modifier and Type	Class and Description
class	InvocationRequest Information about an interposed request for operation invocation.
class	InvocationResult Information about the result from an interposed operation invocation.
class	SecurityPrincipal VMODL equivalent of com.vmware.vapi.security.PrincipalId.

Methods in com.vmware.vapi.std.interposition with type parameters of type Structure

Modifier and Type	Method and Description
<T extends Structure> T	SecurityPrincipal._convertTo(Class<T> clazz)
<T extends Structure> T	InvocationResult._convertTo(Class<T> clazz)
<T extends Structure> T	InvocationRequest._convertTo(Class<T> clazz)

Methods in com.vmware.vapi.std.interposition that return Structure

Modifier and Type	Method and Description
Structure	InvocationResult.getError() Error result value.

Methods in com.vmware.vapi.std.interposition with parameters of type Structure

Modifier and Type	Method and Description
void	InvocationResult.setError(Structure error) Error result value.
InvocationResult.Builder	InvocationResult.Builder.setError(Structure error) Error result value.

Method parameters in com.vmware.vapi.std.interposition with type arguments of type Structure

Modifier and Type	Method and Description
boolean	SecurityPrincipal._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	InvocationResult._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	InvocationRequest._hasTypeNameOf(Class<? extends Structure> clazz)

Constructors in com.vmware.vapi.std.interposition with parameters of type Structure

Constructor and Description
InvocationResult(InvocationResult.ResultType resultType, DataValue output, Structure error) This constructor is provided for backwards compatibility purposes only.

Uses of Structure in com.vmware.vapi.std.introspection

Classes in com.vmware.vapi.std.introspection that implement Structure

Modifier and Type	Class and Description
static class	OperationTypes.DataDefinition The OperationTypes.DataDefinition structure describes a vAPI data type.
static class	OperationTypes.Info Information about a vAPI operation.
static class	ProviderTypes.Info Information about a vAPI provider
static class	ServiceTypes.Info Information about a vAPI service

Methods in com.vmware.vapi.std.introspection with type parameters of type Structure

Modifier and Type	Method and Description
<T extends Structure> T	ServiceTypes.Info._convertTo(Class<T> clazz)
<T extends Structure> T	ProviderTypes.Info._convertTo(Class<T> clazz)
<T extends Structure> T	OperationTypes.DataDefinition._convertTo(Class<T> clazz)
<T extends Structure> T	OperationTypes.Info._convertTo(Class<T> clazz)

Method parameters in com.vmware.vapi.std.introspection with type arguments of type Structure

Modifier and Type	Method and Description
boolean	ServiceTypes.Info._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	ProviderTypes.Info._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	OperationTypes.DataDefinition._hasTypeNameOf(Class<? extends Structure> clazz)
boolean	OperationTypes.Info._hasTypeNameOf(Class<? extends Structure> clazz)