com.vmware.nsx.ns_groups

Class ConsolidatedEffectiveIpAddressMembersStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.ns_groups.ConsolidatedEffectiveIpAddressMembersStub

All Implemented Interfaces:

ConsolidatedEffectiveIpAddressMembers, ConsolidatedEffectiveIpAddressMembersTypes, com.vmware.vapi.bindings.Service

public class ConsolidatedEffectiveIpAddressMembersStub
extends com.vmware.vapi.internal.bindings.Stub
implements ConsolidatedEffectiveIpAddressMembers

Remote stub implementation of the ConsolidatedEffectiveIpAddressMembers 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.ns_groups.ConsolidatedEffectiveIpAddressMembersTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
ConsolidatedEffectiveIpAddressMembersStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
ConsolidatedEffectiveIpAddressMembersStub(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
ConsolidatedEffectiveIPAddressMemberListResult	list(java.lang.String nsGroupId, java.lang.String cursor, java.lang.String includedFields, java.lang.String ipFilter, java.lang.Long pageSize, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns consolidated effective ip address members of the specified NSGroup.
void	list(java.lang.String nsGroupId, java.lang.String cursor, java.lang.String includedFields, java.lang.String ipFilter, java.lang.Long pageSize, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedEffectiveIPAddressMemberListResult> asyncCallback) Returns consolidated effective ip address members of the specified NSGroup.
void	list(java.lang.String nsGroupId, java.lang.String cursor, java.lang.String includedFields, java.lang.String ipFilter, java.lang.Long pageSize, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedEffectiveIPAddressMemberListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns consolidated effective ip address members of the specified NSGroup.
ConsolidatedEffectiveIPAddressMemberListResult	list(java.lang.String nsGroupId, java.lang.String cursor, java.lang.String includedFields, java.lang.String ipFilter, java.lang.Long pageSize, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns consolidated effective ip address members of the specified NSGroup.

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

ConsolidatedEffectiveIpAddressMembersStub

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

ConsolidatedEffectiveIpAddressMembersStub

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

Method Detail

list

public ConsolidatedEffectiveIPAddressMemberListResult list(java.lang.String nsGroupId,
                                                           java.lang.String cursor,
                                                           java.lang.String includedFields,
                                                           java.lang.String ipFilter,
                                                           java.lang.Long pageSize,
                                                           java.lang.String siteId,
                                                           java.lang.Boolean sortAscending,
                                                           java.lang.String sortBy)

Description copied from interface: ConsolidatedEffectiveIpAddressMembers

Returns consolidated effective ip address members of the specified NSGroup. Applicable in case of federated environment. The response contains site-wise list of consolidated effective IP address members. In the response, for the local-site, the list will contain static and dynamicaly translated IPs. For the remote sites, the list will contain only the dynamically translated IPs. The static IPs will not be seen in the response of this API. Hence, user can refer to the local-site Ip response in the API results or the group definition to see the static IP membership of the Group. This API is applicable only for NSGroups containing either VirtualMachine, VIF, LogicalSwitch, LogicalPort or IPSet member type. For NSGroups containing other member types,it returns an empty list. Use the cursor value in the response to fetch the next page. If there is no cursor value for a response, it implies the last page in the results for the query.

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

Specified by:

list in interface ConsolidatedEffectiveIpAddressMembers

Parameters:

nsGroupId - NSGroup Id (required)

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

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

ipFilter - IP address, range, or subnet (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

siteId - UUID of the site from which the effective IP addresses are to be fetched (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.ConsolidatedEffectiveIPAddressMemberListResult

list

public ConsolidatedEffectiveIPAddressMemberListResult list(java.lang.String nsGroupId,
                                                           java.lang.String cursor,
                                                           java.lang.String includedFields,
                                                           java.lang.String ipFilter,
                                                           java.lang.Long pageSize,
                                                           java.lang.String siteId,
                                                           java.lang.Boolean sortAscending,
                                                           java.lang.String sortBy,
                                                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ConsolidatedEffectiveIpAddressMembers

Returns consolidated effective ip address members of the specified NSGroup. Applicable in case of federated environment. The response contains site-wise list of consolidated effective IP address members. In the response, for the local-site, the list will contain static and dynamicaly translated IPs. For the remote sites, the list will contain only the dynamically translated IPs. The static IPs will not be seen in the response of this API. Hence, user can refer to the local-site Ip response in the API results or the group definition to see the static IP membership of the Group. This API is applicable only for NSGroups containing either VirtualMachine, VIF, LogicalSwitch, LogicalPort or IPSet member type. For NSGroups containing other member types,it returns an empty list. Use the cursor value in the response to fetch the next page. If there is no cursor value for a response, it implies the last page in the results for the query.

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 ConsolidatedEffectiveIpAddressMembers

Parameters:

nsGroupId - NSGroup Id (required)

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

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

ipFilter - IP address, range, or subnet (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

siteId - UUID of the site from which the effective IP addresses are to be fetched (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ConsolidatedEffectiveIPAddressMemberListResult

list

public void list(java.lang.String nsGroupId,
                 java.lang.String cursor,
                 java.lang.String includedFields,
                 java.lang.String ipFilter,
                 java.lang.Long pageSize,
                 java.lang.String siteId,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedEffectiveIPAddressMemberListResult> asyncCallback)

Description copied from interface: ConsolidatedEffectiveIpAddressMembers

Returns consolidated effective ip address members of the specified NSGroup. Applicable in case of federated environment. The response contains site-wise list of consolidated effective IP address members. In the response, for the local-site, the list will contain static and dynamicaly translated IPs. For the remote sites, the list will contain only the dynamically translated IPs. The static IPs will not be seen in the response of this API. Hence, user can refer to the local-site Ip response in the API results or the group definition to see the static IP membership of the Group. This API is applicable only for NSGroups containing either VirtualMachine, VIF, LogicalSwitch, LogicalPort or IPSet member type. For NSGroups containing other member types,it returns an empty list. Use the cursor value in the response to fetch the next page. If there is no cursor value for a response, it implies the last page in the results for the query.

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

Invocation Result:
com.vmware.nsx.model.ConsolidatedEffectiveIPAddressMemberListResult

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

Specified by:

list in interface ConsolidatedEffectiveIpAddressMembers

Parameters:

nsGroupId - NSGroup Id (required)

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

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

ipFilter - IP address, range, or subnet (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

siteId - UUID of the site from which the effective IP addresses are to be fetched (optional)

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 nsGroupId,
                 java.lang.String cursor,
                 java.lang.String includedFields,
                 java.lang.String ipFilter,
                 java.lang.Long pageSize,
                 java.lang.String siteId,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedEffectiveIPAddressMemberListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ConsolidatedEffectiveIpAddressMembers

Returns consolidated effective ip address members of the specified NSGroup. Applicable in case of federated environment. The response contains site-wise list of consolidated effective IP address members. In the response, for the local-site, the list will contain static and dynamicaly translated IPs. For the remote sites, the list will contain only the dynamically translated IPs. The static IPs will not be seen in the response of this API. Hence, user can refer to the local-site Ip response in the API results or the group definition to see the static IP membership of the Group. This API is applicable only for NSGroups containing either VirtualMachine, VIF, LogicalSwitch, LogicalPort or IPSet member type. For NSGroups containing other member types,it returns an empty list. Use the cursor value in the response to fetch the next page. If there is no cursor value for a response, it implies the last page in the results for the query.

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.model.ConsolidatedEffectiveIPAddressMemberListResult

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

Specified by:

list in interface ConsolidatedEffectiveIpAddressMembers

Parameters:

nsGroupId - NSGroup Id (required)

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

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

ipFilter - IP address, range, or subnet (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

siteId - UUID of the site from which the effective IP addresses are to be fetched (optional)

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.