com.vmware.nsx_policy.infra

Class GroupAssociationsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx_policy.infra.GroupAssociationsStub

All Implemented Interfaces:

GroupAssociations, GroupAssociationsTypes, com.vmware.vapi.bindings.Service

public class GroupAssociationsStub
extends com.vmware.vapi.internal.bindings.Stub
implements GroupAssociations

Remote stub implementation of the GroupAssociations 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.infra.GroupAssociationsTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
GroupAssociationsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
GroupAssociationsStub(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
PolicyResourceReferenceForEPListResult	list(java.lang.String intentPath, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Get policy groups for which the given object is a member.
void	list(java.lang.String intentPath, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PolicyResourceReferenceForEPListResult> asyncCallback) Get policy groups for which the given object is a member.
void	list(java.lang.String intentPath, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PolicyResourceReferenceForEPListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get policy groups for which the given object is a member.
PolicyResourceReferenceForEPListResult	list(java.lang.String intentPath, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get policy groups for which the given object is a member.

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

GroupAssociationsStub

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

GroupAssociationsStub

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

Method Detail

list

public PolicyResourceReferenceForEPListResult list(java.lang.String intentPath,
                                                   java.lang.String cursor,
                                                   java.lang.String enforcementPointPath,
                                                   java.lang.Boolean includeMarkForDeleteObjects,
                                                   java.lang.String includedFields,
                                                   java.lang.Long pageSize,
                                                   java.lang.Boolean sortAscending,
                                                   java.lang.String sortBy)

Description copied from interface: GroupAssociations

Get policy groups for which the given object is a member. In Federation environment, if the given object is a global entity (eg: global segment) and if the entity is not stretched to the site specified in the enforcement_point_path parameter,then the following is returned:- 1)If the entity is a member of any global group and that group is stretched to the enforcement_point_path site,then the API returns an empty list. 2)If the entity is not a member of any global group,this API returns an 'invalid path' error message. 3)If both the entity and its corresponding groups are stretched to the enforcement_point_path site , then the API returns the groups list.

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

Specified by:

list in interface GroupAssociations

Parameters:

intentPath - String path of the intent object (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)

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)

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

list

public PolicyResourceReferenceForEPListResult list(java.lang.String intentPath,
                                                   java.lang.String cursor,
                                                   java.lang.String enforcementPointPath,
                                                   java.lang.Boolean includeMarkForDeleteObjects,
                                                   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: GroupAssociations

Get policy groups for which the given object is a member. In Federation environment, if the given object is a global entity (eg: global segment) and if the entity is not stretched to the site specified in the enforcement_point_path parameter,then the following is returned:- 1)If the entity is a member of any global group and that group is stretched to the enforcement_point_path site,then the API returns an empty list. 2)If the entity is not a member of any global group,this API returns an 'invalid path' error message. 3)If both the entity and its corresponding groups are stretched to the enforcement_point_path site , then the API returns the groups list.

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 GroupAssociations

Parameters:

intentPath - String path of the intent object (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)

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)

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

list

public void list(java.lang.String intentPath,
                 java.lang.String cursor,
                 java.lang.String enforcementPointPath,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<PolicyResourceReferenceForEPListResult> asyncCallback)

Description copied from interface: GroupAssociations

Get policy groups for which the given object is a member. In Federation environment, if the given object is a global entity (eg: global segment) and if the entity is not stretched to the site specified in the enforcement_point_path parameter,then the following is returned:- 1)If the entity is a member of any global group and that group is stretched to the enforcement_point_path site,then the API returns an empty list. 2)If the entity is not a member of any global group,this API returns an 'invalid path' error message. 3)If both the entity and its corresponding groups are stretched to the enforcement_point_path site , then the API returns the groups list.

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

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

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

Specified by:

list in interface GroupAssociations

Parameters:

intentPath - String path of the intent object (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)

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)

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 intentPath,
                 java.lang.String cursor,
                 java.lang.String enforcementPointPath,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<PolicyResourceReferenceForEPListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: GroupAssociations

Get policy groups for which the given object is a member. In Federation environment, if the given object is a global entity (eg: global segment) and if the entity is not stretched to the site specified in the enforcement_point_path parameter,then the following is returned:- 1)If the entity is a member of any global group and that group is stretched to the enforcement_point_path site,then the API returns an empty list. 2)If the entity is not a member of any global group,this API returns an 'invalid path' error message. 3)If both the entity and its corresponding groups are stretched to the enforcement_point_path site , then the API returns the groups list.

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

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

Specified by:

list in interface GroupAssociations

Parameters:

intentPath - String path of the intent object (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)

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)

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.