com.vmware.vcenter.authorization

Class PrivilegeChecksStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.authorization.PrivilegeChecksStub

All Implemented Interfaces:

Service, PrivilegeChecks, PrivilegeChecksTypes

public class PrivilegeChecksStub
extends com.vmware.vapi.internal.bindings.Stub
implements PrivilegeChecks

Remote stub implementation of the PrivilegeChecks API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

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

PrivilegeChecksTypes.FilterSpec, PrivilegeChecksTypes.Info, PrivilegeChecksTypes.IterationSpec, PrivilegeChecksTypes.ListResult, PrivilegeChecksTypes.Principal

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.vcenter.authorization.PrivilegeChecksTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
PrivilegeChecksStub(ApiProvider apiProvider, StubConfigurationBase config)
PrivilegeChecksStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
PrivilegeChecksTypes.ListResult	list(PrivilegeChecksTypes.IterationSpec iteration, PrivilegeChecksTypes.FilterSpec filter) Queries the privilege checks matching given criteria.
void	list(PrivilegeChecksTypes.IterationSpec iteration, PrivilegeChecksTypes.FilterSpec filter, AsyncCallback<PrivilegeChecksTypes.ListResult> asyncCallback) Queries the privilege checks matching given criteria.
void	list(PrivilegeChecksTypes.IterationSpec iteration, PrivilegeChecksTypes.FilterSpec filter, AsyncCallback<PrivilegeChecksTypes.ListResult> asyncCallback, InvocationConfig invocationConfig) Queries the privilege checks matching given criteria.
PrivilegeChecksTypes.ListResult	list(PrivilegeChecksTypes.IterationSpec iteration, PrivilegeChecksTypes.FilterSpec filter, InvocationConfig invocationConfig) Queries the privilege checks matching given criteria.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PrivilegeChecksStub

public PrivilegeChecksStub(ApiProvider apiProvider,
                           com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                           StubConfigurationBase config)

PrivilegeChecksStub

public PrivilegeChecksStub(ApiProvider apiProvider,
                           StubConfigurationBase config)

Method Detail

list

public PrivilegeChecksTypes.ListResult list(PrivilegeChecksTypes.IterationSpec iteration,
                                            PrivilegeChecksTypes.FilterSpec filter)

Description copied from interface: PrivilegeChecks

Queries the privilege checks matching given criteria. This method was added in vSphere API 8.0.0.0.

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

Specified by:

list in interface PrivilegeChecks

Parameters:

iteration - Contains optional settings for pagination of the result. if unset, the oldest privilege checks recorded are returned, paged by the default page size.

The default page size can be changed from config.vpxd.privilegeChecks.pageSize advanced option.

filter - Contains optional settings by which the privilege checks should be filtered. if unset, recorded privilege checks matching the iteration spec are returned.

Returns:

Detailed information about the privileges collected so far.

list

public PrivilegeChecksTypes.ListResult list(PrivilegeChecksTypes.IterationSpec iteration,
                                            PrivilegeChecksTypes.FilterSpec filter,
                                            InvocationConfig invocationConfig)

Description copied from interface: PrivilegeChecks

Queries the privilege checks matching given criteria. This method was added in vSphere API 8.0.0.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.

Specified by:

list in interface PrivilegeChecks

Parameters:

iteration - Contains optional settings for pagination of the result. if unset, the oldest privilege checks recorded are returned, paged by the default page size.

The default page size can be changed from config.vpxd.privilegeChecks.pageSize advanced option.

filter - Contains optional settings by which the privilege checks should be filtered. if unset, recorded privilege checks matching the iteration spec are returned.

invocationConfig - Configuration for the method invocation.

Returns:

Detailed information about the privileges collected so far.

list

public void list(PrivilegeChecksTypes.IterationSpec iteration,
                 PrivilegeChecksTypes.FilterSpec filter,
                 AsyncCallback<PrivilegeChecksTypes.ListResult> asyncCallback)

Description copied from interface: PrivilegeChecks

Queries the privilege checks matching given criteria. This method was added in vSphere API 8.0.0.0.

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

Invocation Result:
Detailed information about the privileges collected so far.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if filter or iteration spec contain invalid values.
NotFound - if the iteration spec contains a marker that could not be found.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Sessions.CollectPrivilegeChecks.

Specified by:

list in interface PrivilegeChecks

Parameters:

iteration - Contains optional settings for pagination of the result. if unset, the oldest privilege checks recorded are returned, paged by the default page size.

The default page size can be changed from config.vpxd.privilegeChecks.pageSize advanced option.

filter - Contains optional settings by which the privilege checks should be filtered. if unset, recorded privilege checks matching the iteration spec are returned.

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

list

public void list(PrivilegeChecksTypes.IterationSpec iteration,
                 PrivilegeChecksTypes.FilterSpec filter,
                 AsyncCallback<PrivilegeChecksTypes.ListResult> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: PrivilegeChecks

Queries the privilege checks matching given criteria. This method was added in vSphere API 8.0.0.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:
Detailed information about the privileges collected so far.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if filter or iteration spec contain invalid values.
NotFound - if the iteration spec contains a marker that could not be found.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Sessions.CollectPrivilegeChecks.

Specified by:

list in interface PrivilegeChecks

Parameters:

iteration - Contains optional settings for pagination of the result. if unset, the oldest privilege checks recorded are returned, paged by the default page size.

The default page size can be changed from config.vpxd.privilegeChecks.pageSize advanced option.

filter - Contains optional settings by which the privilege checks should be filtered. if unset, recorded privilege checks matching the iteration spec are returned.

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

invocationConfig - Configuration for the method invocation.