com.vmware.nsx_policy.orgs.projects.aaa

Interface Roles

All Superinterfaces:

RolesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RolesStub

public interface Roles
extends com.vmware.vapi.bindings.Service, RolesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.orgs.projects.aaa.RolesTypes

_VAPI_SERVICE_ID, LIST_SCOPE_ORG, LIST_SCOPE_PROJECT, LIST_SCOPE_ROOT, LIST_SCOPE_VPC

Method Summary

Modifier and Type	Method and Description
RoleListResult	list(java.lang.String orgId, java.lang.String projectId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy) Get information about all roles
void	list(java.lang.String orgId, java.lang.String projectId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<RoleListResult> asyncCallback) Get information about all roles
void	list(java.lang.String orgId, java.lang.String projectId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<RoleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get information about all roles
RoleListResult	list(java.lang.String orgId, java.lang.String projectId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get information about all roles

Method Detail

list

RoleListResult list(java.lang.String orgId,
                    java.lang.String projectId,
                    java.lang.String cursor,
                    java.lang.String includedFields,
                    java.lang.Long pageSize,
                    java.lang.String scope,
                    java.lang.Boolean sortAscending,
                    java.lang.String sortBy)

Get information about all roles

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

Parameters:

orgId - (required)

projectId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

scope - List only the roles which are applicable for this scope. (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx_policy.model.RoleListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

RoleListResult list(java.lang.String orgId,
                    java.lang.String projectId,
                    java.lang.String cursor,
                    java.lang.String includedFields,
                    java.lang.Long pageSize,
                    java.lang.String scope,
                    java.lang.Boolean sortAscending,
                    java.lang.String sortBy,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get information about all roles

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:

orgId - (required)

projectId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

scope - List only the roles which are applicable for this scope. (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.RoleListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(java.lang.String orgId,
          java.lang.String projectId,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String scope,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<RoleListResult> asyncCallback)

Get information about all roles

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

Invocation Result:
com.vmware.nsx_policy.model.RoleListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

orgId - (required)

projectId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

scope - List only the roles which are applicable for this scope. (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

list

void list(java.lang.String orgId,
          java.lang.String projectId,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String scope,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<RoleListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get information about all roles

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:
com.vmware.nsx_policy.model.RoleListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

orgId - (required)

projectId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

scope - List only the roles which are applicable for this scope. (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

invocationConfig - Configuration for the method invocation.