com.vmware.nsx.fabric

Interface ComputeCollections

All Superinterfaces:

ComputeCollectionsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ComputeCollectionsStub

public interface ComputeCollections
extends com.vmware.vapi.bindings.Service, ComputeCollectionsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.fabric.ComputeCollectionsTypes

_VAPI_SERVICE_ID, CREATE_ACTION_NSX

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String ccExtId, java.lang.String action) Perform action specific to NSX on the compute-collection.
void	create(java.lang.String ccExtId, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Perform action specific to NSX on the compute-collection.
void	create(java.lang.String ccExtId, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Perform action specific to NSX on the compute-collection.
void	create(java.lang.String ccExtId, java.lang.String action, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Perform action specific to NSX on the compute-collection.
ComputeCollection	get(java.lang.String ccExtId) Returns information about a specific compute collection.
void	get(java.lang.String ccExtId, com.vmware.vapi.bindings.client.AsyncCallback<ComputeCollection> asyncCallback) Returns information about a specific compute collection.
void	get(java.lang.String ccExtId, com.vmware.vapi.bindings.client.AsyncCallback<ComputeCollection> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specific compute collection.
ComputeCollection	get(java.lang.String ccExtId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specific compute collection.
ComputeCollectionListResult	list(java.lang.String cmLocalId, java.lang.String cursor, java.lang.String discoveredNodeId, java.lang.String displayName, java.lang.String externalId, java.lang.String includedFields, java.lang.String nodeId, java.lang.String originId, java.lang.String originType, java.lang.String ownerId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about all compute collections.
void	list(java.lang.String cmLocalId, java.lang.String cursor, java.lang.String discoveredNodeId, java.lang.String displayName, java.lang.String externalId, java.lang.String includedFields, java.lang.String nodeId, java.lang.String originId, java.lang.String originType, java.lang.String ownerId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ComputeCollectionListResult> asyncCallback) Returns information about all compute collections.
void	list(java.lang.String cmLocalId, java.lang.String cursor, java.lang.String discoveredNodeId, java.lang.String displayName, java.lang.String externalId, java.lang.String includedFields, java.lang.String nodeId, java.lang.String originId, java.lang.String originType, java.lang.String ownerId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ComputeCollectionListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all compute collections.
ComputeCollectionListResult	list(java.lang.String cmLocalId, java.lang.String cursor, java.lang.String discoveredNodeId, java.lang.String displayName, java.lang.String externalId, java.lang.String includedFields, java.lang.String nodeId, java.lang.String originId, java.lang.String originType, java.lang.String ownerId, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all compute collections.

Method Detail

create

void create(java.lang.String ccExtId,
            java.lang.String action)

Perform action specific to NSX on the compute-collection. cc-ext-id should be of type VC_Cluster.

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

Parameters:

ccExtId - (required)

action - Supported actions on compute-collection (optional)

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

create

void create(java.lang.String ccExtId,
            java.lang.String action,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Perform action specific to NSX on the compute-collection. cc-ext-id should be of type VC_Cluster.

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:

ccExtId - (required)

action - Supported actions on compute-collection (optional)

invocationConfig - Configuration for the method invocation.

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

create

void create(java.lang.String ccExtId,
            java.lang.String action,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Perform action specific to NSX on the compute-collection. cc-ext-id should be of type VC_Cluster.

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

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

Parameters:

ccExtId - (required)

action - Supported actions on compute-collection (optional)

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

create

void create(java.lang.String ccExtId,
            java.lang.String action,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Perform action specific to NSX on the compute-collection. cc-ext-id should be of type VC_Cluster.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

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

Parameters:

ccExtId - (required)

action - Supported actions on compute-collection (optional)

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

invocationConfig - Configuration for the method invocation.

get

ComputeCollection get(java.lang.String ccExtId)

Returns information about a specific compute collection.

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

Parameters:

ccExtId - (required)

Returns:

com.vmware.nsx.model.ComputeCollection

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

get

ComputeCollection get(java.lang.String ccExtId,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specific compute collection.

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:

ccExtId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ComputeCollection

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

get

void get(java.lang.String ccExtId,
         com.vmware.vapi.bindings.client.AsyncCallback<ComputeCollection> asyncCallback)

Returns information about a specific compute collection.

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

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

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

Parameters:

ccExtId - (required)

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

get

void get(java.lang.String ccExtId,
         com.vmware.vapi.bindings.client.AsyncCallback<ComputeCollection> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specific compute collection.

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

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

Parameters:

ccExtId - (required)

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

invocationConfig - Configuration for the method invocation.

list

ComputeCollectionListResult list(java.lang.String cmLocalId,
                                 java.lang.String cursor,
                                 java.lang.String discoveredNodeId,
                                 java.lang.String displayName,
                                 java.lang.String externalId,
                                 java.lang.String includedFields,
                                 java.lang.String nodeId,
                                 java.lang.String originId,
                                 java.lang.String originType,
                                 java.lang.String ownerId,
                                 java.lang.Long pageSize,
                                 java.lang.Boolean sortAscending,
                                 java.lang.String sortBy)

Returns information about all compute collections.

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

Parameters:

cmLocalId - Local Id of the compute collection in the Compute Manager (optional)

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

discoveredNodeId - Id of the discovered node which belongs to this Compute Collection (optional)

displayName - Name of the ComputeCollection in source compute manager (optional)

externalId - External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC (optional)

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

nodeId - Id of the fabric node created from a discovered node belonging to this Compute Collection (optional)

originId - Id of the compute manager from where this Compute Collection was discovered (optional)

originType - ComputeCollection type like VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers (optional)

ownerId - Id of the owner of compute collection in the Compute Manager (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.ComputeCollectionListResult

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

ComputeCollectionListResult list(java.lang.String cmLocalId,
                                 java.lang.String cursor,
                                 java.lang.String discoveredNodeId,
                                 java.lang.String displayName,
                                 java.lang.String externalId,
                                 java.lang.String includedFields,
                                 java.lang.String nodeId,
                                 java.lang.String originId,
                                 java.lang.String originType,
                                 java.lang.String ownerId,
                                 java.lang.Long pageSize,
                                 java.lang.Boolean sortAscending,
                                 java.lang.String sortBy,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all compute collections.

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:

cmLocalId - Local Id of the compute collection in the Compute Manager (optional)

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

discoveredNodeId - Id of the discovered node which belongs to this Compute Collection (optional)

displayName - Name of the ComputeCollection in source compute manager (optional)

externalId - External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC (optional)

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

nodeId - Id of the fabric node created from a discovered node belonging to this Compute Collection (optional)

originId - Id of the compute manager from where this Compute Collection was discovered (optional)

originType - ComputeCollection type like VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers (optional)

ownerId - Id of the owner of compute collection in the Compute Manager (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.ComputeCollectionListResult

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

void list(java.lang.String cmLocalId,
          java.lang.String cursor,
          java.lang.String discoveredNodeId,
          java.lang.String displayName,
          java.lang.String externalId,
          java.lang.String includedFields,
          java.lang.String nodeId,
          java.lang.String originId,
          java.lang.String originType,
          java.lang.String ownerId,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ComputeCollectionListResult> asyncCallback)

Returns information about all compute collections.

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

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

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

Parameters:

cmLocalId - Local Id of the compute collection in the Compute Manager (optional)

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

discoveredNodeId - Id of the discovered node which belongs to this Compute Collection (optional)

displayName - Name of the ComputeCollection in source compute manager (optional)

externalId - External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC (optional)

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

nodeId - Id of the fabric node created from a discovered node belonging to this Compute Collection (optional)

originId - Id of the compute manager from where this Compute Collection was discovered (optional)

originType - ComputeCollection type like VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers (optional)

ownerId - Id of the owner of compute collection in the Compute Manager (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

void list(java.lang.String cmLocalId,
          java.lang.String cursor,
          java.lang.String discoveredNodeId,
          java.lang.String displayName,
          java.lang.String externalId,
          java.lang.String includedFields,
          java.lang.String nodeId,
          java.lang.String originId,
          java.lang.String originType,
          java.lang.String ownerId,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ComputeCollectionListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all compute collections.

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

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

Parameters:

cmLocalId - Local Id of the compute collection in the Compute Manager (optional)

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

discoveredNodeId - Id of the discovered node which belongs to this Compute Collection (optional)

displayName - Name of the ComputeCollection in source compute manager (optional)

externalId - External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC (optional)

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

nodeId - Id of the fabric node created from a discovered node belonging to this Compute Collection (optional)

originId - Id of the compute manager from where this Compute Collection was discovered (optional)

originType - ComputeCollection type like VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers (optional)

ownerId - Id of the owner of compute collection in the Compute Manager (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.