Package com.vmware.nsx_policy.infra.firewall_identity_stores

Interface Groups

All Superinterfaces:

GroupsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

GroupsStub

public interface Groups
extends com.vmware.vapi.bindings.Service, GroupsTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.firewall_identity_stores.GroupsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
DirectoryGroupListResults	list(java.lang.String firewallIdentityStoreId, java.lang.String filterValue, java.lang.String cursor, java.lang.String enforcementPointPath, 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 firewallIdentityStoreId, java.lang.String filterValue, java.lang.String cursor, java.lang.String enforcementPointPath, 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 firewallIdentityStoreId, java.lang.String filterValue, java.lang.String cursor, java.lang.String enforcementPointPath, 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 firewallIdentityStoreId, java.lang.String filterValue, java.lang.String cursor, java.lang.String enforcementPointPath, 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.

Method Detail

list

DirectoryGroupListResults list(java.lang.String firewallIdentityStoreId,
                               java.lang.String filterValue,
                               java.lang.String cursor,
                               java.lang.String enforcementPointPath,
                               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. (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)

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

Parameters:

firewallIdentityStoreId - Firewall Identity store 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)

enforcementPointPath - String Path of the enforcement point (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_policy.model.DirectoryGroupListResults

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

DirectoryGroupListResults list(java.lang.String firewallIdentityStoreId,
                               java.lang.String filterValue,
                               java.lang.String cursor,
                               java.lang.String enforcementPointPath,
                               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. (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)

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:

firewallIdentityStoreId - Firewall Identity store 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)

enforcementPointPath - String Path of the enforcement point (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_policy.model.DirectoryGroupListResults

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 firewallIdentityStoreId,
          java.lang.String filterValue,
          java.lang.String cursor,
          java.lang.String enforcementPointPath,
          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. (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)

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

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

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

Parameters:

firewallIdentityStoreId - Firewall Identity store 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)

enforcementPointPath - String Path of the enforcement point (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 firewallIdentityStoreId,
          java.lang.String filterValue,
          java.lang.String cursor,
          java.lang.String enforcementPointPath,
          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. (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)

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

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

Parameters:

firewallIdentityStoreId - Firewall Identity store 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)

enforcementPointPath - String Path of the enforcement point (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.