public interface Search extends com.vmware.vapi.bindings.Service, SearchTypes
_VAPI_SERVICE_ID
Modifier and Type | Method and Description |
---|---|
ScimSearchListResult |
create(java.lang.String id,
java.lang.String searchString,
java.lang.String cursor,
java.lang.String includedFields,
java.lang.Long pageSize,
java.lang.Boolean sortAscending,
java.lang.String sortBy)
Search the System for Cross-domain Identity Management (SCIM) source for users
and groups whose names match the search string.
|
void |
create(java.lang.String id,
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<ScimSearchListResult> asyncCallback)
Search the System for Cross-domain Identity Management (SCIM) source for users
and groups whose names match the search string.
|
void |
create(java.lang.String id,
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<ScimSearchListResult> asyncCallback,
com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Search the System for Cross-domain Identity Management (SCIM) source for users
and groups whose names match the search string.
|
ScimSearchListResult |
create(java.lang.String id,
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)
Search the System for Cross-domain Identity Management (SCIM) source for users
and groups whose names match the search string.
|
ScimSearchListResult create(java.lang.String id, java.lang.String searchString, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)
Synchronous method overload. Result of the invocation will be reported as a method return value.
id
- (required)searchString
- Search filter (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)com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundScimSearchListResult create(java.lang.String id, 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)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
id
- (required)searchString
- Search filter (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.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid create(java.lang.String id, 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<ScimSearchListResult> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
com.vmware.nsx.model.ScimSearchListResult
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
id
- (required)searchString
- Search filter (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.void create(java.lang.String id, 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<ScimSearchListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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.ScimSearchListResult
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
id
- (required)searchString
- Search filter (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.