com.vmware.nsx_policy.global_infra.domains

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.global_infra.domains.GroupsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
Group	get(java.lang.String domainId, java.lang.String groupId) Read group
void	get(java.lang.String domainId, java.lang.String groupId, com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback) Read group
void	get(java.lang.String domainId, java.lang.String groupId, com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read group
Group	get(java.lang.String domainId, java.lang.String groupId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read group
GroupListResult	list(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.String memberTypes, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) List Groups for a domain.
void	list(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.String memberTypes, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<GroupListResult> asyncCallback) List Groups for a domain.
void	list(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.String memberTypes, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<GroupListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List Groups for a domain.
GroupListResult	list(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.String memberTypes, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List Groups for a domain.

Method Detail

get

Group get(java.lang.String domainId,
          java.lang.String groupId)

Read group

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

Parameters:

domainId - Domain ID (required)

groupId - Group ID (required)

Returns:

com.vmware.nsx_policy.model.Group

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

get

Group get(java.lang.String domainId,
          java.lang.String groupId,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read group

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:

domainId - Domain ID (required)

groupId - Group ID (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.Group

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

get

void get(java.lang.String domainId,
         java.lang.String groupId,
         com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback)

Read group

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

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

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

Parameters:

domainId - Domain ID (required)

groupId - Group ID (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String domainId,
         java.lang.String groupId,
         com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read group

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

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

Parameters:

domainId - Domain ID (required)

groupId - Group ID (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

GroupListResult list(java.lang.String domainId,
                     java.lang.String cursor,
                     java.lang.Boolean includeMarkForDeleteObjects,
                     java.lang.String includedFields,
                     java.lang.String memberTypes,
                     java.lang.Long pageSize,
                     java.lang.Boolean sortAscending,
                     java.lang.String sortBy)

List Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types.

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

Parameters:

domainId - Domain ID (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

memberTypes - Comma Separated Member types (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.GroupListResult

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

GroupListResult list(java.lang.String domainId,
                     java.lang.String cursor,
                     java.lang.Boolean includeMarkForDeleteObjects,
                     java.lang.String includedFields,
                     java.lang.String memberTypes,
                     java.lang.Long pageSize,
                     java.lang.Boolean sortAscending,
                     java.lang.String sortBy,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types.

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:

domainId - Domain ID (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

memberTypes - Comma Separated Member types (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.GroupListResult

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 domainId,
          java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.String memberTypes,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<GroupListResult> asyncCallback)

List Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types.

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

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

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

Parameters:

domainId - Domain ID (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

memberTypes - Comma Separated Member types (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 domainId,
          java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.String memberTypes,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<GroupListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types.

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

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

Parameters:

domainId - Domain ID (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

memberTypes - Comma Separated Member types (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.