com.vmware.vstats

Interface AcqSpecs

All Superinterfaces:

AcqSpecsTypes, Service

All Known Implementing Classes:

AcqSpecsStub

public interface AcqSpecs
extends Service, AcqSpecsTypes

The AcqSpecs interface provides methods to perform acquisition specification related operations. An acquisition specification defines the statistical data that should be collected at desired sampling rates from the underlying providers. It designates the resources and their counters which should be sampled, and a desired sampling rate. 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.AcqSpecsTypes

AcqSpecsTypes.CounterSpec, AcqSpecsTypes.CreateSpec, AcqSpecsTypes.FilterSpec, AcqSpecsTypes.Info, AcqSpecsTypes.ListResult, AcqSpecsTypes.Status, AcqSpecsTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.vstats.AcqSpecsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(AcqSpecsTypes.CreateSpec acqSpec) Create a new acquisition specification record.
void	create(AcqSpecsTypes.CreateSpec acqSpec, AsyncCallback<java.lang.String> asyncCallback) Create a new acquisition specification record.
void	create(AcqSpecsTypes.CreateSpec acqSpec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Create a new acquisition specification record.
java.lang.String	create(AcqSpecsTypes.CreateSpec acqSpec, InvocationConfig invocationConfig) Create a new acquisition specification record.
void	delete(java.lang.String id) Delete an acquisition specification.
void	delete(java.lang.String id, AsyncCallback<java.lang.Void> asyncCallback) Delete an acquisition specification.
void	delete(java.lang.String id, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Delete an acquisition specification.
void	delete(java.lang.String id, InvocationConfig invocationConfig) Delete an acquisition specification.
AcqSpecsTypes.Info	get(java.lang.String id) Returns information about a specific acquisition specification.
void	get(java.lang.String id, AsyncCallback<AcqSpecsTypes.Info> asyncCallback) Returns information about a specific acquisition specification.
void	get(java.lang.String id, AsyncCallback<AcqSpecsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a specific acquisition specification.
AcqSpecsTypes.Info	get(java.lang.String id, InvocationConfig invocationConfig) Returns information about a specific acquisition specification.
AcqSpecsTypes.ListResult	list(AcqSpecsTypes.FilterSpec filter) Returns information about all acquisition specifications.
void	list(AcqSpecsTypes.FilterSpec filter, AsyncCallback<AcqSpecsTypes.ListResult> asyncCallback) Returns information about all acquisition specifications.
void	list(AcqSpecsTypes.FilterSpec filter, AsyncCallback<AcqSpecsTypes.ListResult> asyncCallback, InvocationConfig invocationConfig) Returns information about all acquisition specifications.
AcqSpecsTypes.ListResult	list(AcqSpecsTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about all acquisition specifications.
void	update(java.lang.String id, AcqSpecsTypes.UpdateSpec acqSpec) Update an existing acquisition specification.
void	update(java.lang.String id, AcqSpecsTypes.UpdateSpec acqSpec, AsyncCallback<java.lang.Void> asyncCallback) Update an existing acquisition specification.
void	update(java.lang.String id, AcqSpecsTypes.UpdateSpec acqSpec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Update an existing acquisition specification.
void	update(java.lang.String id, AcqSpecsTypes.UpdateSpec acqSpec, InvocationConfig invocationConfig) Update an existing acquisition specification.

Method Detail

create

java.lang.String create(AcqSpecsTypes.CreateSpec acqSpec)

Create a new acquisition specification record. 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:

acqSpec - Specification for the acquisition of stats data.

Returns:

Identifier of the newly created acquisition specification. The return value will be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

Throws:

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

InvalidArgument - if acqSpec contain any errors.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

create

java.lang.String create(AcqSpecsTypes.CreateSpec acqSpec,
                        InvocationConfig invocationConfig)

Create a new acquisition specification record. 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:

acqSpec - Specification for the acquisition of stats data.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the newly created acquisition specification. The return value will be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

Throws:

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

InvalidArgument - if acqSpec contain any errors.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

create

void create(AcqSpecsTypes.CreateSpec acqSpec,
            AsyncCallback<java.lang.String> asyncCallback)

Create a new acquisition specification record. 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:
Identifier of the newly created acquisition specification. The return value will be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if acqSpec contain any errors.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

acqSpec - Specification for the acquisition of stats data.

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

create

void create(AcqSpecsTypes.CreateSpec acqSpec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Create a new acquisition specification record. 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:
Identifier of the newly created acquisition specification. The return value will be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if acqSpec contain any errors.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have sufficient privileges.

Parameters:

acqSpec - Specification for the acquisition of stats data.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String id)

Delete an acquisition specification. 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 - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

Throws:

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

InvalidArgument - if id is invalid.

NotFound - if acquisition specification could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

delete

void delete(java.lang.String id,
            InvocationConfig invocationConfig)

Delete an acquisition specification. 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 - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

invocationConfig - Configuration for the method invocation.

Throws:

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

InvalidArgument - if id is invalid.

NotFound - if acquisition specification could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

delete

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

Delete an acquisition specification. 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.

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

Parameters:

id - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

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

delete

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

Delete an acquisition specification. 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.

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

Parameters:

id - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

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

invocationConfig - Configuration for the method invocation.

list

AcqSpecsTypes.ListResult list(AcqSpecsTypes.FilterSpec filter)

Returns information about all acquisition specifications. 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. When Set filtering will be applied to the result.

Returns:

List of acquisition specification records.

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

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

Returns information about all acquisition specifications. 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. When Set filtering will be applied to the result.

invocationConfig - Configuration for the method invocation.

Returns:

List of acquisition specification records.

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(AcqSpecsTypes.FilterSpec filter,
          AsyncCallback<AcqSpecsTypes.ListResult> asyncCallback)

Returns information about all acquisition specifications. 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:
List of acquisition specification records.

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. When Set filtering will be applied to the result.

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

list

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

Returns information about all acquisition specifications. 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:
List of acquisition specification records.

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. When Set filtering will be applied to the result.

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

invocationConfig - Configuration for the method invocation.

get

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

Returns information about a specific acquisition specification. 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 - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

Returns:

Information about the desired acquisition specification.

Throws:

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

InvalidArgument - if id is invalid.

NotFound - acquisition specification could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

get

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

Returns information about a specific acquisition specification. 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 - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the desired acquisition specification.

Throws:

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

InvalidArgument - if id is invalid.

NotFound - acquisition specification 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<AcqSpecsTypes.Info> asyncCallback)

Returns information about a specific acquisition specification. 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 acquisition specification.

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

Parameters:

id - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

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

get

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

Returns information about a specific acquisition specification. 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 acquisition specification.

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

Parameters:

id - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String id,
            AcqSpecsTypes.UpdateSpec acqSpec)

Update an existing acquisition specification. 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 - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

acqSpec - Updated acquisition specification.

Throws:

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

InvalidArgument - if any of the specified parameters are invalid.

NotFound - acquisition specification could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

update

void update(java.lang.String id,
            AcqSpecsTypes.UpdateSpec acqSpec,
            InvocationConfig invocationConfig)

Update an existing acquisition specification. 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 - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

acqSpec - Updated acquisition specification.

invocationConfig - Configuration for the method invocation.

Throws:

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

InvalidArgument - if any of the specified parameters are invalid.

NotFound - acquisition specification could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have sufficient privileges.

update

void update(java.lang.String id,
            AcqSpecsTypes.UpdateSpec acqSpec,
            AsyncCallback<java.lang.Void> asyncCallback)

Update an existing acquisition specification. 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.

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

Parameters:

id - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

acqSpec - Updated acquisition specification.

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

update

void update(java.lang.String id,
            AcqSpecsTypes.UpdateSpec acqSpec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Update an existing acquisition specification. 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.

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

Parameters:

id - Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

acqSpec - Updated acquisition specification.

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

invocationConfig - Configuration for the method invocation.