com.vmware.nsx.cluster

Interface ApiService

All Superinterfaces:

ApiServiceTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ApiServiceStub

public interface ApiService
extends com.vmware.vapi.bindings.Service, ApiServiceTypes

Field Summary

Fields inherited from interface com.vmware.nsx.cluster.ApiServiceTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ApiServiceConfig	get() Read the configuration of the NSX API service.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback) Read the configuration of the NSX API service.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read the configuration of the NSX API service.
ApiServiceConfig	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read the configuration of the NSX API service.
ApiServiceConfig	update(ApiServiceConfig apiServiceConfig) Read the configuration of the NSX API service.
void	update(ApiServiceConfig apiServiceConfig, com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback) Read the configuration of the NSX API service.
void	update(ApiServiceConfig apiServiceConfig, com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read the configuration of the NSX API service.
ApiServiceConfig	update(ApiServiceConfig apiServiceConfig, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read the configuration of the NSX API service.

Method Detail

get

ApiServiceConfig get()

Read the configuration of the NSX API service.

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

Returns:

com.vmware.nsx.model.ApiServiceConfig

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

ApiServiceConfig get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read the configuration of the NSX API service.

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:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ApiServiceConfig

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(com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback)

Read the configuration of the NSX API service.

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

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

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

Parameters:

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

get

void get(com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read the configuration of the NSX API service.

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

update

ApiServiceConfig update(ApiServiceConfig apiServiceConfig)

Read the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.

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

Parameters:

apiServiceConfig - (required)

Returns:

com.vmware.nsx.model.ApiServiceConfig

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

update

ApiServiceConfig update(ApiServiceConfig apiServiceConfig,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.

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:

apiServiceConfig - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ApiServiceConfig

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

update

void update(ApiServiceConfig apiServiceConfig,
            com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback)

Read the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.

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

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

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

Parameters:

apiServiceConfig - (required)

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

update

void update(ApiServiceConfig apiServiceConfig,
            com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.

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

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

Parameters:

apiServiceConfig - (required)

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

invocationConfig - Configuration for the method invocation.