com.vmware.nsx_policy.global_infra.tier_0s

Class GroupsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx_policy.global_infra.tier_0s.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_policy.global_infra.tier_0s.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
Group	get(java.lang.String tier0Id, java.lang.String groupId) Read Tier-0 Group
void	get(java.lang.String tier0Id, java.lang.String groupId, com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback) Read Tier-0 Group
void	get(java.lang.String tier0Id, java.lang.String groupId, com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read Tier-0 Group
Group	get(java.lang.String tier0Id, java.lang.String groupId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read Tier-0 Group
GroupListResult	list(java.lang.String tier0Id, 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) Paginated list of all Groups for Tier-0.
void	list(java.lang.String tier0Id, 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) Paginated list of all Groups for Tier-0.
void	list(java.lang.String tier0Id, 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) Paginated list of all Groups for Tier-0.
GroupListResult	list(java.lang.String tier0Id, 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) Paginated list of all Groups for Tier-0.

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

get

public Group get(java.lang.String tier0Id,
                 java.lang.String groupId)

Description copied from interface: Groups

Read Tier-0 Group

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

Specified by:

get in interface Groups

Parameters:

tier0Id - (required)

groupId - (required)

Returns:

com.vmware.nsx_policy.model.Group

get

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

Description copied from interface: Groups

Read Tier-0 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.

Specified by:

get in interface Groups

Parameters:

tier0Id - (required)

groupId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.Group

get

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

Description copied from interface: Groups

Read Tier-0 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

Specified by:

get in interface Groups

Parameters:

tier0Id - (required)

groupId - (required)

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

get

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

Description copied from interface: Groups

Read Tier-0 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

Specified by:

get in interface Groups

Parameters:

tier0Id - (required)

groupId - (required)

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

invocationConfig - Configuration for the method invocation.

list

public GroupListResult list(java.lang.String tier0Id,
                            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)

Description copied from interface: Groups

Paginated list of all Groups for Tier-0.

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

Specified by:

list in interface Groups

Parameters:

tier0Id - (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

list

public GroupListResult list(java.lang.String tier0Id,
                            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)

Description copied from interface: Groups

Paginated list of all Groups for Tier-0.

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:

tier0Id - (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

list

public void list(java.lang.String tier0Id,
                 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)

Description copied from interface: Groups

Paginated list of all Groups for Tier-0.

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

Specified by:

list in interface Groups

Parameters:

tier0Id - (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

public void list(java.lang.String tier0Id,
                 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)

Description copied from interface: Groups

Paginated list of all Groups for Tier-0.

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

Specified by:

list in interface Groups

Parameters:

tier0Id - (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.