com.vmware.vstats

Interface ResourceAddresses

All Superinterfaces:

ResourceAddressesTypes, Service

All Known Implementing Classes:

ResourceAddressesStub

public interface ResourceAddresses
extends Service, ResourceAddressesTypes

The ResourceAddresses interface provides methods to perform resource addressing queries. Warning: This interface is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vstats.ResourceAddressesTypes

ResourceAddressesTypes.FilterSpec, ResourceAddressesTypes.Info, ResourceAddressesTypes.ListResult

Field Summary

Fields inherited from interface com.vmware.vstats.ResourceAddressesTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
ResourceAddressesTypes.Info	get(java.lang.String id) Returns information about a specific Resource Address.
void	get(java.lang.String id, AsyncCallback<ResourceAddressesTypes.Info> asyncCallback) Returns information about a specific Resource Address.
void	get(java.lang.String id, AsyncCallback<ResourceAddressesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a specific Resource Address.
ResourceAddressesTypes.Info	get(java.lang.String id, InvocationConfig invocationConfig) Returns information about a specific Resource Address.
ResourceAddressesTypes.ListResult	list(ResourceAddressesTypes.FilterSpec filter) Returns the list of Resource Addresses matching the filter parameters.
void	list(ResourceAddressesTypes.FilterSpec filter, AsyncCallback<ResourceAddressesTypes.ListResult> asyncCallback) Returns the list of Resource Addresses matching the filter parameters.
void	list(ResourceAddressesTypes.FilterSpec filter, AsyncCallback<ResourceAddressesTypes.ListResult> asyncCallback, InvocationConfig invocationConfig) Returns the list of Resource Addresses matching the filter parameters.
ResourceAddressesTypes.ListResult	list(ResourceAddressesTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns the list of Resource Addresses matching the filter parameters.

Method Detail

list

ResourceAddressesTypes.ListResult list(ResourceAddressesTypes.FilterSpec filter)

Returns the list of Resource Addresses matching the filter parameters. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Parameters:

filter - Criteria for selecting records to return. If null all records will be returned.

Returns:

Matching resource addresses.

Throws:

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

InvalidArgument - if any of the specified parameters are invalid.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

list

ResourceAddressesTypes.ListResult list(ResourceAddressesTypes.FilterSpec filter,
                                       InvocationConfig invocationConfig)

Returns the list of Resource Addresses matching the filter parameters. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 - Criteria for selecting records to return. If null all records will be returned.

invocationConfig - Configuration for the method invocation.

Returns:

Matching resource addresses.

Throws:

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

InvalidArgument - if any of the specified parameters are invalid.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

list

void list(ResourceAddressesTypes.FilterSpec filter,
          AsyncCallback<ResourceAddressesTypes.ListResult> asyncCallback)

Returns the list of Resource Addresses matching the filter parameters. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Invocation Result:
Matching resource addresses.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are invalid.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

filter - Criteria for selecting records to return. If null all records will be returned.

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

list

void list(ResourceAddressesTypes.FilterSpec filter,
          AsyncCallback<ResourceAddressesTypes.ListResult> asyncCallback,
          InvocationConfig invocationConfig)

Returns the list of Resource Addresses matching the filter parameters. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:
Matching resource addresses.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are invalid.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

filter - Criteria for selecting records to return. If null all records will be returned.

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

invocationConfig - Configuration for the method invocation.

get

ResourceAddressesTypes.Info get(java.lang.String id)

Returns information about a specific Resource Address. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Parameters:

id - Resource Address ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.RsrcAddr.

Returns:

Information about the desired Resource Address.

Throws:

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

InvalidArgument - if id is invalid.

NotFound - if Resource Address could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

get

ResourceAddressesTypes.Info get(java.lang.String id,
                                InvocationConfig invocationConfig)

Returns information about a specific Resource Address. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

id - Resource Address ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.RsrcAddr.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the desired Resource Address.

Throws:

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

InvalidArgument - if id is invalid.

NotFound - if Resource Address could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

get

void get(java.lang.String id,
         AsyncCallback<ResourceAddressesTypes.Info> asyncCallback)

Returns information about a specific Resource Address. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Invocation Result:
Information about the desired Resource Address.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if id is invalid.
NotFound - if Resource Address could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

id - Resource Address ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.RsrcAddr.

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

get

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

Returns information about a specific Resource Address. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 Resource Address.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if id is invalid.
NotFound - if Resource Address could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

id - Resource Address ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.RsrcAddr.

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

invocationConfig - Configuration for the method invocation.