com.vmware.vcenter.storage.policies

Interface Compliance

All Superinterfaces:

ComplianceTypes, Service

All Known Implementing Classes:

ComplianceStub

public interface Compliance
extends Service, ComplianceTypes

The Compliance interface provides methods related to all the associated entities of given compliance statuses. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.storage.policies.ComplianceTypes

ComplianceTypes.FilterSpec, ComplianceTypes.Status, ComplianceTypes.Summary

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ComplianceTypes.Summary>	list(ComplianceTypes.FilterSpec filter) Returns compliance information about entities matching the filter ComplianceTypes.FilterSpec.
void	list(ComplianceTypes.FilterSpec filter, AsyncCallback<java.util.List<ComplianceTypes.Summary>> asyncCallback) Returns compliance information about entities matching the filter ComplianceTypes.FilterSpec.
void	list(ComplianceTypes.FilterSpec filter, AsyncCallback<java.util.List<ComplianceTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns compliance information about entities matching the filter ComplianceTypes.FilterSpec.
java.util.List<ComplianceTypes.Summary>	list(ComplianceTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns compliance information about entities matching the filter ComplianceTypes.FilterSpec.

Method Detail

list

java.util.List<ComplianceTypes.Summary> list(ComplianceTypes.FilterSpec filter)

Returns compliance information about entities matching the filter ComplianceTypes.FilterSpec. Entities without storage policy association are not returned. This method was added in vSphere API 6.7.

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

Parameters:

filter - compliance status of matching entities for which information should be returned.

Returns:

compliance information about entities matching the filter ComplianceTypes.FilterSpec.

Throws:

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

InvalidArgument - if the ComplianceTypes.FilterSpec.getStatus() property contains a value that is not supported by the server.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

list

java.util.List<ComplianceTypes.Summary> list(ComplianceTypes.FilterSpec filter,
                                           InvocationConfig invocationConfig)

Returns compliance information about entities matching the filter ComplianceTypes.FilterSpec. Entities without storage policy association are not returned. This method was added in vSphere API 6.7.

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 - compliance status of matching entities for which information should be returned.

invocationConfig - Configuration for the method invocation.

Returns:

compliance information about entities matching the filter ComplianceTypes.FilterSpec.

Throws:

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

InvalidArgument - if the ComplianceTypes.FilterSpec.getStatus() property contains a value that is not supported by the server.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

list

void list(ComplianceTypes.FilterSpec filter,
        AsyncCallback<java.util.List<ComplianceTypes.Summary>> asyncCallback)

Returns compliance information about entities matching the filter ComplianceTypes.FilterSpec. Entities without storage policy association are not returned. This method was added in vSphere API 6.7.

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

Operation Result:
compliance information about entities matching the filter ComplianceTypes.FilterSpec.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the ComplianceTypes.FilterSpec.getStatus() property contains a value that is not supported by the server.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

filter - compliance status of matching entities for which information should be returned.

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

list

void list(ComplianceTypes.FilterSpec filter,
        AsyncCallback<java.util.List<ComplianceTypes.Summary>> asyncCallback,
        InvocationConfig invocationConfig)

Returns compliance information about entities matching the filter ComplianceTypes.FilterSpec. Entities without storage policy association are not returned. This method was added in vSphere API 6.7.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
compliance information about entities matching the filter ComplianceTypes.FilterSpec.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the ComplianceTypes.FilterSpec.getStatus() property contains a value that is not supported by the server.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

filter - compliance status of matching entities for which information should be returned.

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

invocationConfig - Configuration for the method invocation.