com.vmware.nsx.directory.domains

Class GroupsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.directory.domains.GroupsStub

All Implemented Interfaces:

Groups, GroupsTypes, com.vmware.vapi.bindings.Service

public class GroupsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Groups

Remote stub implementation of the Groups 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.directory.domains.GroupsTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
GroupsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
GroupsStub(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
DirectoryGroupListResults	list(java.lang.String domainId, java.lang.String filterValue, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Search for directory groups within a domain based on the substring of a distinguished name.
void	list(java.lang.String domainId, java.lang.String filterValue, 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<DirectoryGroupListResults> asyncCallback) Search for directory groups within a domain based on the substring of a distinguished name.
void	list(java.lang.String domainId, java.lang.String filterValue, 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<DirectoryGroupListResults> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Search for directory groups within a domain based on the substring of a distinguished name.
DirectoryGroupListResults	list(java.lang.String domainId, java.lang.String filterValue, 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 for directory groups within a domain based on the substring of a distinguished name.

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

GroupsStub

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

GroupsStub

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

Method Detail

list

public DirectoryGroupListResults list(java.lang.String domainId,
                                      java.lang.String filterValue,
                                      java.lang.String cursor,
                                      java.lang.String includedFields,
                                      java.lang.Long pageSize,
                                      java.lang.Boolean sortAscending,
                                      java.lang.String sortBy)

Description copied from interface: Groups

Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//groups

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

Specified by:

list in interface Groups

Parameters:

domainId - Directory domain identifier (required)

filterValue - Name search filter value (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.DirectoryGroupListResults

list

public DirectoryGroupListResults list(java.lang.String domainId,
                                      java.lang.String filterValue,
                                      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: Groups

Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//groups

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 Groups

Parameters:

domainId - Directory domain identifier (required)

filterValue - Name search filter value (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.DirectoryGroupListResults

list

public void list(java.lang.String domainId,
                 java.lang.String filterValue,
                 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<DirectoryGroupListResults> asyncCallback)

Description copied from interface: Groups

Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//groups

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

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

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

Specified by:

list in interface Groups

Parameters:

domainId - Directory domain identifier (required)

filterValue - Name search filter value (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

public void list(java.lang.String domainId,
                 java.lang.String filterValue,
                 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<DirectoryGroupListResults> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Groups

Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)

Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores//groups

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.DirectoryGroupListResults

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

Specified by:

list in interface Groups

Parameters:

domainId - Directory domain identifier (required)

filterValue - Name search filter value (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.