com.vmware.nsx.aaa.vidm

Class SearchStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.aaa.vidm.SearchStub

All Implemented Interfaces:

Search, SearchTypes, com.vmware.vapi.bindings.Service

public class SearchStub
extends com.vmware.vapi.internal.bindings.Stub
implements Search

Remote stub implementation of the Search API service.

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

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

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

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
VidmInfoListResult	create(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 and groups from vIDM matching the search key case insensitively.
void	create(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 and groups from vIDM matching the search key case insensitively.
void	create(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 and groups from vIDM matching the search key case insensitively.
VidmInfoListResult	create(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 and groups from vIDM matching the search key case insensitively.

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

SearchStub

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

SearchStub

public SearchStub(com.vmware.vapi.core.ApiProvider apiProvider,
                  com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

create

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

Description copied from interface: Search

Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. 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/group of interest more characters need to be entered.

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

Specified by:

create in interface Search

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

create

public VidmInfoListResult create(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)

Description copied from interface: Search

Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. 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/group 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.

Specified by:

create in interface Search

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

create

public void create(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)

Description copied from interface: Search

Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. 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/group 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

Specified by:

create in interface Search

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.

create

public void create(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)

Description copied from interface: Search

Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. 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/group 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

Specified by:

create in interface Search

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.