com.vmware.nsx

Class AssociationsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.AssociationsStub

All Implemented Interfaces:

Associations, AssociationsTypes, com.vmware.vapi.bindings.Service

public class AssociationsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Associations

Remote stub implementation of the Associations 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.AssociationsTypes

_VAPI_SERVICE_ID, LIST_ASSOCIATED_RESOURCE_TYPE_NSGROUP, LIST_RESOURCE_TYPE_CLOUDNATIVESERVICEINSTANCE, LIST_RESOURCE_TYPE_DIRECTORYGROUP, LIST_RESOURCE_TYPE_IPADDRESS, LIST_RESOURCE_TYPE_IPSET, LIST_RESOURCE_TYPE_LOGICALPORT, LIST_RESOURCE_TYPE_LOGICALSWITCH, LIST_RESOURCE_TYPE_MACSET, LIST_RESOURCE_TYPE_NSGROUP, LIST_RESOURCE_TYPE_PHYSICALSERVER, LIST_RESOURCE_TYPE_TRANSPORTNODE, LIST_RESOURCE_TYPE_VIRTUALMACHINE, LIST_RESOURCE_TYPE_VIRTUALNETWORKINTERFACE

Constructor Summary

Constructors

Constructor and Description
AssociationsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
AssociationsStub(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
AssociationListResult	list(java.lang.String associatedResourceType, java.lang.String resourceId, java.lang.String resourceType, java.lang.String cursor, java.lang.Boolean fetchAncestors, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Synchronous method overload.
void	list(java.lang.String associatedResourceType, java.lang.String resourceId, java.lang.String resourceType, java.lang.String cursor, java.lang.Boolean fetchAncestors, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<AssociationListResult> asyncCallback) Asynchronous method overload.
void	list(java.lang.String associatedResourceType, java.lang.String resourceId, java.lang.String resourceType, java.lang.String cursor, java.lang.Boolean fetchAncestors, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<AssociationListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Asynchronous method overload.
AssociationListResult	list(java.lang.String associatedResourceType, java.lang.String resourceId, java.lang.String resourceType, java.lang.String cursor, java.lang.Boolean fetchAncestors, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Synchronous method overload.

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

AssociationsStub

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

AssociationsStub

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

Method Detail

list

public AssociationListResult list(java.lang.String associatedResourceType,
                                  java.lang.String resourceId,
                                  java.lang.String resourceType,
                                  java.lang.String cursor,
                                  java.lang.Boolean fetchAncestors,
                                  java.lang.String includedFields,
                                  java.lang.Long pageSize,
                                  java.lang.Boolean sortAscending,
                                  java.lang.String sortBy)

Description copied from interface: Associations

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

Specified by:

list in interface Associations

Parameters:

associatedResourceType - Resource type valid for use as target in association API (required)

resourceId - The resource for which associated resources are to be fetched (required)

resourceType - Resource type valid for use as source in association API (required)

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

fetchAncestors - Fetch complete list of associated resources considering containment and nesting (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.model.AssociationListResult

list

public AssociationListResult list(java.lang.String associatedResourceType,
                                  java.lang.String resourceId,
                                  java.lang.String resourceType,
                                  java.lang.String cursor,
                                  java.lang.Boolean fetchAncestors,
                                  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: Associations

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 Associations

Parameters:

associatedResourceType - Resource type valid for use as target in association API (required)

resourceId - The resource for which associated resources are to be fetched (required)

resourceType - Resource type valid for use as source in association API (required)

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

fetchAncestors - Fetch complete list of associated resources considering containment and nesting (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.model.AssociationListResult

list

public void list(java.lang.String associatedResourceType,
                 java.lang.String resourceId,
                 java.lang.String resourceType,
                 java.lang.String cursor,
                 java.lang.Boolean fetchAncestors,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<AssociationListResult> asyncCallback)

Description copied from interface: Associations

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

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

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

Specified by:

list in interface Associations

Parameters:

associatedResourceType - Resource type valid for use as target in association API (required)

resourceId - The resource for which associated resources are to be fetched (required)

resourceType - Resource type valid for use as source in association API (required)

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

fetchAncestors - Fetch complete list of associated resources considering containment and nesting (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 associatedResourceType,
                 java.lang.String resourceId,
                 java.lang.String resourceType,
                 java.lang.String cursor,
                 java.lang.Boolean fetchAncestors,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<AssociationListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Associations

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

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

Specified by:

list in interface Associations

Parameters:

associatedResourceType - Resource type valid for use as target in association API (required)

resourceId - The resource for which associated resources are to be fetched (required)

resourceType - Resource type valid for use as source in association API (required)

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

fetchAncestors - Fetch complete list of associated resources considering containment and nesting (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.