Package com.vmware.nsx_policy.infra.identity_firewall_stores

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_policy.infra.identity_firewall_stores.UsersTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
IdentityFirewallStoreUserOrGrouptListResults	list(java.lang.String identityFirewallStoreId, 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)	Return all the users based on the user name.
void	list(java.lang.String identityFirewallStoreId, 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<IdentityFirewallStoreUserOrGrouptListResults> asyncCallback)	Return all the users based on the user name.
void	list(java.lang.String identityFirewallStoreId, 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<IdentityFirewallStoreUserOrGrouptListResults> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Return all the users based on the user name.
IdentityFirewallStoreUserOrGrouptListResults	list(java.lang.String identityFirewallStoreId, 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)	Return all the users based on the user name.

Method Detail

list

IdentityFirewallStoreUserOrGrouptListResults list(java.lang.String identityFirewallStoreId,
                                                  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)

Return all the users based on the user name.

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

Parameters:

identityFirewallStoreId - 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.IdentityFirewallStoreUserOrGrouptListResults

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

IdentityFirewallStoreUserOrGrouptListResults list(java.lang.String identityFirewallStoreId,
                                                  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)

Return all the users based on the user name.

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:

identityFirewallStoreId - 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.IdentityFirewallStoreUserOrGrouptListResults

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 identityFirewallStoreId,
          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<IdentityFirewallStoreUserOrGrouptListResults> asyncCallback)

Return all the users based on the user name.

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

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

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

Parameters:

identityFirewallStoreId - 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 identityFirewallStoreId,
          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<IdentityFirewallStoreUserOrGrouptListResults> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Return all the users based on the user name.

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

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

Parameters:

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