com.vmware.nsx.fabric

Interface ScopeAssociations

All Superinterfaces:

ScopeAssociationsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ScopeAssociationsStub

public interface ScopeAssociations
extends com.vmware.vapi.bindings.Service, ScopeAssociationsTypes

Field Summary

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

_VAPI_SERVICE_ID, LIST_DISCOVERED_RESOURCE_TYPE_COMPUTECOLLECTION, LIST_DISCOVERED_RESOURCE_TYPE_VIRTUALMACHINE, LIST_SCOPE_TYPE_PROJECT, LIST_SCOPE_TYPE_VPC

Method Summary

Modifier and Type	Method and Description
void	add(ScopeAssociationList scopeAssociationList) Add scope associations for discovered resources
void	add(ScopeAssociationList scopeAssociationList, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Add scope associations for discovered resources
void	add(ScopeAssociationList scopeAssociationList, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add scope associations for discovered resources
void	add(ScopeAssociationList scopeAssociationList, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add scope associations for discovered resources
void	delete(ScopeAssociationList scopeAssociationList) Delete scope associations for discovered resources
void	delete(ScopeAssociationList scopeAssociationList, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete scope associations for discovered resources
void	delete(ScopeAssociationList scopeAssociationList, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete scope associations for discovered resources
void	delete(ScopeAssociationList scopeAssociationList, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete scope associations for discovered resources
ScopeAssociationListResult	list(java.lang.String cursor, java.lang.String discoveredResourceExternalId, java.lang.String discoveredResourceType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scopeId, java.lang.String scopeType, java.lang.Boolean sortAscending, java.lang.String sortBy) Retrieve scope associations for discovered resources
void	list(java.lang.String cursor, java.lang.String discoveredResourceExternalId, java.lang.String discoveredResourceType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scopeId, java.lang.String scopeType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ScopeAssociationListResult> asyncCallback) Retrieve scope associations for discovered resources
void	list(java.lang.String cursor, java.lang.String discoveredResourceExternalId, java.lang.String discoveredResourceType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scopeId, java.lang.String scopeType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ScopeAssociationListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Retrieve scope associations for discovered resources
ScopeAssociationListResult	list(java.lang.String cursor, java.lang.String discoveredResourceExternalId, java.lang.String discoveredResourceType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scopeId, java.lang.String scopeType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Retrieve scope associations for discovered resources

Method Detail

add

void add(ScopeAssociationList scopeAssociationList)

Add scope associations for discovered resources

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

Parameters:

scopeAssociationList - (required)

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

add

void add(ScopeAssociationList scopeAssociationList,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Add scope associations for discovered resources

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:

scopeAssociationList - (required)

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

add

void add(ScopeAssociationList scopeAssociationList,
         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Add scope associations for discovered resources

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:

scopeAssociationList - (required)

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

add

void add(ScopeAssociationList scopeAssociationList,
         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Add scope associations for discovered resources

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:

scopeAssociationList - (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(ScopeAssociationList scopeAssociationList)

Delete scope associations for discovered resources

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

Parameters:

scopeAssociationList - (required)

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

delete

void delete(ScopeAssociationList scopeAssociationList,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete scope associations for discovered resources

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:

scopeAssociationList - (required)

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

delete

void delete(ScopeAssociationList scopeAssociationList,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete scope associations for discovered resources

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:

scopeAssociationList - (required)

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

delete

void delete(ScopeAssociationList scopeAssociationList,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete scope associations for discovered resources

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:

scopeAssociationList - (required)

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

invocationConfig - Configuration for the method invocation.

list

ScopeAssociationListResult list(java.lang.String cursor,
                                java.lang.String discoveredResourceExternalId,
                                java.lang.String discoveredResourceType,
                                java.lang.String includedFields,
                                java.lang.Long pageSize,
                                java.lang.String scopeId,
                                java.lang.String scopeType,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy)

Retrieve scope associations for discovered resources

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

Parameters:

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

discoveredResourceExternalId - External id of the discovered resource (optional)

discoveredResourceType - Type of the discovered resource (optional)

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)

scopeId - Id of the associated scope (optional)

scopeType - Type of the associated scope (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.ScopeAssociationListResult

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

ScopeAssociationListResult list(java.lang.String cursor,
                                java.lang.String discoveredResourceExternalId,
                                java.lang.String discoveredResourceType,
                                java.lang.String includedFields,
                                java.lang.Long pageSize,
                                java.lang.String scopeId,
                                java.lang.String scopeType,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Retrieve scope associations for discovered resources

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:

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

discoveredResourceExternalId - External id of the discovered resource (optional)

discoveredResourceType - Type of the discovered resource (optional)

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)

scopeId - Id of the associated scope (optional)

scopeType - Type of the associated scope (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ScopeAssociationListResult

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 cursor,
          java.lang.String discoveredResourceExternalId,
          java.lang.String discoveredResourceType,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String scopeId,
          java.lang.String scopeType,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ScopeAssociationListResult> asyncCallback)

Retrieve scope associations for discovered resources

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

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

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

Parameters:

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

discoveredResourceExternalId - External id of the discovered resource (optional)

discoveredResourceType - Type of the discovered resource (optional)

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)

scopeId - Id of the associated scope (optional)

scopeType - Type of the associated scope (optional)

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 cursor,
          java.lang.String discoveredResourceExternalId,
          java.lang.String discoveredResourceType,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String scopeId,
          java.lang.String scopeType,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ScopeAssociationListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Retrieve scope associations for discovered resources

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

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

Parameters:

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

discoveredResourceExternalId - External id of the discovered resource (optional)

discoveredResourceType - Type of the discovered resource (optional)

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)

scopeId - Id of the associated scope (optional)

scopeType - Type of the associated scope (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.