com.vmware.nsx.serviceinsertion

Interface ServiceInstances

All Superinterfaces:

com.vmware.vapi.bindings.Service, ServiceInstancesTypes

All Known Implementing Classes:

ServiceInstancesStub

public interface ServiceInstances
extends com.vmware.vapi.bindings.Service, ServiceInstancesTypes

Field Summary

Fields inherited from interface com.vmware.nsx.serviceinsertion.ServiceInstancesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ServiceInstanceListResult	list(java.lang.String deployedTo, java.lang.String serviceDeploymentId) Returns all Service-Instance(s) of all Services present in system.
void	list(java.lang.String deployedTo, java.lang.String serviceDeploymentId, com.vmware.vapi.bindings.client.AsyncCallback<ServiceInstanceListResult> asyncCallback) Returns all Service-Instance(s) of all Services present in system.
void	list(java.lang.String deployedTo, java.lang.String serviceDeploymentId, com.vmware.vapi.bindings.client.AsyncCallback<ServiceInstanceListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns all Service-Instance(s) of all Services present in system.
ServiceInstanceListResult	list(java.lang.String deployedTo, java.lang.String serviceDeploymentId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns all Service-Instance(s) of all Services present in system.

Method Detail

list

ServiceInstanceListResult list(java.lang.String deployedTo,
                               java.lang.String serviceDeploymentId)

Returns all Service-Instance(s) of all Services present in system. When request parameter (deployed_to or service_deployment_id) is provided as a part of request, it will filter out Service-Instances accordingly.

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

Parameters:

deployedTo - Deployed_to referenced by service instances present in system (optional)

serviceDeploymentId - Service Deployment Id using which the instances were deployed (optional)

Returns:

com.vmware.nsx.model.ServiceInstanceListResult

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

ServiceInstanceListResult list(java.lang.String deployedTo,
                               java.lang.String serviceDeploymentId,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns all Service-Instance(s) of all Services present in system. When request parameter (deployed_to or service_deployment_id) is provided as a part of request, it will filter out Service-Instances accordingly.

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:

deployedTo - Deployed_to referenced by service instances present in system (optional)

serviceDeploymentId - Service Deployment Id using which the instances were deployed (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ServiceInstanceListResult

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 deployedTo,
          java.lang.String serviceDeploymentId,
          com.vmware.vapi.bindings.client.AsyncCallback<ServiceInstanceListResult> asyncCallback)

Returns all Service-Instance(s) of all Services present in system. When request parameter (deployed_to or service_deployment_id) is provided as a part of request, it will filter out Service-Instances accordingly.

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

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

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

Parameters:

deployedTo - Deployed_to referenced by service instances present in system (optional)

serviceDeploymentId - Service Deployment Id using which the instances were deployed (optional)

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

list

void list(java.lang.String deployedTo,
          java.lang.String serviceDeploymentId,
          com.vmware.vapi.bindings.client.AsyncCallback<ServiceInstanceListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns all Service-Instance(s) of all Services present in system. When request parameter (deployed_to or service_deployment_id) is provided as a part of request, it will filter out Service-Instances accordingly.

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

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

Parameters:

deployedTo - Deployed_to referenced by service instances present in system (optional)

serviceDeploymentId - Service Deployment Id using which the instances were deployed (optional)

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

invocationConfig - Configuration for the method invocation.