com.vmware.nsx.aaa.vidm

Interface Users

All Superinterfaces:

com.vmware.vapi.bindings.Service, UsersTypes

All Known Implementing Classes:

UsersStub

public interface Users
extends com.vmware.vapi.bindings.Service, UsersTypes

Field Summary

Fields inherited from interface com.vmware.nsx.aaa.vidm.UsersTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
VidmInfoListResult	list(java.lang.String searchString, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively.
void	list(java.lang.String searchString, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<VidmInfoListResult> asyncCallback) Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively.
void	list(java.lang.String searchString, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<VidmInfoListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively.
VidmInfoListResult	list(java.lang.String searchString, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively.

Method Detail

list

VidmInfoListResult list(java.lang.String searchString,
                        java.lang.String cursor,
                        java.lang.String includedFields,
                        java.lang.Long pageSize,
                        java.lang.Boolean sortAscending,
                        java.lang.String sortBy)

Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.

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

Parameters:

searchString - Search string to search for. (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)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.VidmInfoListResult

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

VidmInfoListResult list(java.lang.String searchString,
                        java.lang.String cursor,
                        java.lang.String includedFields,
                        java.lang.Long pageSize,
                        java.lang.Boolean sortAscending,
                        java.lang.String sortBy,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.

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:

searchString - Search string to search for. (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)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.VidmInfoListResult

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 searchString,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<VidmInfoListResult> asyncCallback)

Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.

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

Invocation Result:
com.vmware.nsx.model.VidmInfoListResult

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

Parameters:

searchString - Search string to search for. (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)

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 searchString,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<VidmInfoListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.

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.model.VidmInfoListResult

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

Parameters:

searchString - Search string to search for. (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)

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.