com.vmware.nsx.edge_clusters

Interface State

All Superinterfaces:

com.vmware.vapi.bindings.Service, StateTypes

All Known Implementing Classes:

StateStub

public interface State
extends com.vmware.vapi.bindings.Service, StateTypes

Field Summary

Fields inherited from interface com.vmware.nsx.edge_clusters.StateTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
EdgeClusterState	get(java.lang.String edgeClusterId, java.lang.Long barrierId, java.lang.String requestId) Return realized state information of a edge cluster.
void	get(java.lang.String edgeClusterId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.AsyncCallback<EdgeClusterState> asyncCallback) Return realized state information of a edge cluster.
void	get(java.lang.String edgeClusterId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.AsyncCallback<EdgeClusterState> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return realized state information of a edge cluster.
EdgeClusterState	get(java.lang.String edgeClusterId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return realized state information of a edge cluster.

Method Detail

get

EdgeClusterState get(java.lang.String edgeClusterId,
                     java.lang.Long barrierId,
                     java.lang.String requestId)

Return realized state information of a edge cluster. Any configuration update that affects the edge cluster can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of edge cluster.

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

Parameters:

edgeClusterId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

Returns:

com.vmware.nsx.model.EdgeClusterState

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

EdgeClusterState get(java.lang.String edgeClusterId,
                     java.lang.Long barrierId,
                     java.lang.String requestId,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Return realized state information of a edge cluster. Any configuration update that affects the edge cluster can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of edge 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:

edgeClusterId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.EdgeClusterState

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 edgeClusterId,
         java.lang.Long barrierId,
         java.lang.String requestId,
         com.vmware.vapi.bindings.client.AsyncCallback<EdgeClusterState> asyncCallback)

Return realized state information of a edge cluster. Any configuration update that affects the edge cluster can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of edge cluster.

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

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

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

Parameters:

edgeClusterId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

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

get

void get(java.lang.String edgeClusterId,
         java.lang.Long barrierId,
         java.lang.String requestId,
         com.vmware.vapi.bindings.client.AsyncCallback<EdgeClusterState> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Return realized state information of a edge cluster. Any configuration update that affects the edge cluster can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of edge cluster.

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

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

Parameters:

edgeClusterId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

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

invocationConfig - Configuration for the method invocation.