com.vmware.nsx.fabric

Interface CloudNativeServiceInstances

All Superinterfaces:

CloudNativeServiceInstancesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

CloudNativeServiceInstancesStub

public interface CloudNativeServiceInstances
extends com.vmware.vapi.bindings.Service, CloudNativeServiceInstancesTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
CloudNativeServiceInstance	get(java.lang.String externalId) Returns information about a particular cloud native service instance by external-id.
void	get(java.lang.String externalId, com.vmware.vapi.bindings.client.AsyncCallback<CloudNativeServiceInstance> asyncCallback) Returns information about a particular cloud native service instance by external-id.
void	get(java.lang.String externalId, com.vmware.vapi.bindings.client.AsyncCallback<CloudNativeServiceInstance> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a particular cloud native service instance by external-id.
CloudNativeServiceInstance	get(java.lang.String externalId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a particular cloud native service instance by external-id.
CloudNativeServiceInstanceListResult	list(java.lang.String cursor, java.lang.String displayName, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String serviceType, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source) Returns information about all cloud native service instances.
void	list(java.lang.String cursor, java.lang.String displayName, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String serviceType, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<CloudNativeServiceInstanceListResult> asyncCallback) Returns information about all cloud native service instances.
void	list(java.lang.String cursor, java.lang.String displayName, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String serviceType, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<CloudNativeServiceInstanceListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all cloud native service instances.
CloudNativeServiceInstanceListResult	list(java.lang.String cursor, java.lang.String displayName, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String serviceType, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all cloud native service instances.

Method Detail

get

CloudNativeServiceInstance get(java.lang.String externalId)

Returns information about a particular cloud native service instance by external-id.

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

Parameters:

externalId - (required)

Returns:

com.vmware.nsx.model.CloudNativeServiceInstance

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

CloudNativeServiceInstance get(java.lang.String externalId,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a particular cloud native service instance by external-id.

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:

externalId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.CloudNativeServiceInstance

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 externalId,
         com.vmware.vapi.bindings.client.AsyncCallback<CloudNativeServiceInstance> asyncCallback)

Returns information about a particular cloud native service instance by external-id.

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

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

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

Parameters:

externalId - (required)

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

get

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

Returns information about a particular cloud native service instance by external-id.

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

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

Parameters:

externalId - (required)

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

invocationConfig - Configuration for the method invocation.

list

CloudNativeServiceInstanceListResult list(java.lang.String cursor,
                                          java.lang.String displayName,
                                          java.lang.String includedFields,
                                          java.lang.Long pageSize,
                                          java.lang.String serviceType,
                                          java.lang.Boolean sortAscending,
                                          java.lang.String sortBy,
                                          java.lang.String source)

Returns information about all cloud native service instances.

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)

displayName - Display Name of the cloud native service instance (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)

serviceType - Type of cloud native service; possible values are ELB, RDS (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - NSX node id of the public cloud gateway that reported the service instance (optional)

Returns:

com.vmware.nsx.model.CloudNativeServiceInstanceListResult

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

CloudNativeServiceInstanceListResult list(java.lang.String cursor,
                                          java.lang.String displayName,
                                          java.lang.String includedFields,
                                          java.lang.Long pageSize,
                                          java.lang.String serviceType,
                                          java.lang.Boolean sortAscending,
                                          java.lang.String sortBy,
                                          java.lang.String source,
                                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all cloud native service instances.

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)

displayName - Display Name of the cloud native service instance (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)

serviceType - Type of cloud native service; possible values are ELB, RDS (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - NSX node id of the public cloud gateway that reported the service instance (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.CloudNativeServiceInstanceListResult

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 displayName,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String serviceType,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String source,
          com.vmware.vapi.bindings.client.AsyncCallback<CloudNativeServiceInstanceListResult> asyncCallback)

Returns information about all cloud native service instances.

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

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

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)

displayName - Display Name of the cloud native service instance (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)

serviceType - Type of cloud native service; possible values are ELB, RDS (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - NSX node id of the public cloud gateway that reported the service instance (optional)

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

list

void list(java.lang.String cursor,
          java.lang.String displayName,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String serviceType,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String source,
          com.vmware.vapi.bindings.client.AsyncCallback<CloudNativeServiceInstanceListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all cloud native service instances.

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

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)

displayName - Display Name of the cloud native service instance (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)

serviceType - Type of cloud native service; possible values are ELB, RDS (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - NSX node id of the public cloud gateway that reported the service instance (optional)

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

invocationConfig - Configuration for the method invocation.