com.vmware.nsx

Interface Associations

All Superinterfaces:

AssociationsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

AssociationsStub

public interface Associations
extends com.vmware.vapi.bindings.Service, AssociationsTypes

Field Summary

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

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) Deprecated.
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) Deprecated.
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) Deprecated.
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) Deprecated.

Method Detail

list

@Deprecated
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)

Deprecated.

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

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

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

@Deprecated
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)

Deprecated.

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:

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

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

@Deprecated
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)

Deprecated.

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

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

@Deprecated
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)

Deprecated.

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

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.