com.vmware.appliance

Class ServicesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.ServicesStub

All Implemented Interfaces:

Services, ServicesTypes, Service

public class ServicesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Services

Remote stub implementation of the Services API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.ServicesTypes

ServicesTypes.Info, ServicesTypes.State

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.appliance.ServicesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
ServicesStub(ApiProvider apiProvider, StubConfigurationBase config)
ServicesStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
ServicesTypes.Info	get(java.lang.String service) Returns the state of a service.
void	get(java.lang.String service, AsyncCallback<ServicesTypes.Info> asyncCallback) Returns the state of a service.
void	get(java.lang.String service, AsyncCallback<ServicesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the state of a service.
ServicesTypes.Info	get(java.lang.String service, InvocationConfig invocationConfig) Returns the state of a service.
java.util.Map<java.lang.String,ServicesTypes.Info>	list() Lists details of vCenter services.
void	list(AsyncCallback<java.util.Map<java.lang.String,ServicesTypes.Info>> asyncCallback) Lists details of vCenter services.
void	list(AsyncCallback<java.util.Map<java.lang.String,ServicesTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Lists details of vCenter services.
java.util.Map<java.lang.String,ServicesTypes.Info>	list(InvocationConfig invocationConfig) Lists details of vCenter services.
void	restart(java.lang.String service) Restarts a service.
void	restart(java.lang.String service, AsyncCallback<java.lang.Void> asyncCallback) Restarts a service.
void	restart(java.lang.String service, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Restarts a service.
void	restart(java.lang.String service, InvocationConfig invocationConfig) Restarts a service.
void	start(java.lang.String service) Starts a service.
void	start(java.lang.String service, AsyncCallback<java.lang.Void> asyncCallback) Starts a service.
void	start(java.lang.String service, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Starts a service.
void	start(java.lang.String service, InvocationConfig invocationConfig) Starts a service.
void	stop(java.lang.String service) Stops a service.
void	stop(java.lang.String service, AsyncCallback<java.lang.Void> asyncCallback) Stops a service.
void	stop(java.lang.String service, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Stops a service.
void	stop(java.lang.String service, InvocationConfig invocationConfig) Stops a service.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServicesStub

public ServicesStub(ApiProvider apiProvider,
                    com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                    StubConfigurationBase config)

ServicesStub

public ServicesStub(ApiProvider apiProvider,
                    StubConfigurationBase config)

Method Detail

start

public void start(java.lang.String service)

Description copied from interface: Services

Starts a service. This method was added in vSphere API 6.7.

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

Specified by:

start in interface Services

Parameters:

service - identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.services.

start

public void start(java.lang.String service,
                  InvocationConfig invocationConfig)

Description copied from interface: Services

Starts a service. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

start in interface Services

Parameters:

service - identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.services.

invocationConfig - Configuration for the method invocation.

start

public void start(java.lang.String service,
                  AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Services

Starts a service. This method was added in vSphere API 6.7.

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

Operation Errors:
NotFound - if the service associated with service does not exist.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.
NotAllowedInCurrentState - if start operation is issued on a service which has startup type StartupType#DISABLED.
TimedOut - if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.
Error - if any other error occurs during the execution of the operation.

Specified by:

start in interface Services

Parameters:

service - identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.services.

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

start

public void start(java.lang.String service,
                  AsyncCallback<java.lang.Void> asyncCallback,
                  InvocationConfig invocationConfig)

Description copied from interface: Services

Starts a service. This method was added in vSphere API 6.7.

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:
NotFound - if the service associated with service does not exist.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.
NotAllowedInCurrentState - if start operation is issued on a service which has startup type StartupType#DISABLED.
TimedOut - if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.
Error - if any other error occurs during the execution of the operation.

Specified by:

start in interface Services

Parameters:

service - identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.services.

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

invocationConfig - Configuration for the method invocation.

stop

public void stop(java.lang.String service)

Description copied from interface: Services

Stops a service. This method was added in vSphere API 6.7.

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

Specified by:

stop in interface Services

Parameters:

service - identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.services.

stop

public void stop(java.lang.String service,
                 InvocationConfig invocationConfig)

Description copied from interface: Services

Stops a service. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

stop in interface Services

Parameters:

service - identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.services.

invocationConfig - Configuration for the method invocation.

stop

public void stop(java.lang.String service,
                 AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Services

Stops a service. This method was added in vSphere API 6.7.

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

Operation Errors:
NotFound - if the service associated with service does not exist.
Error - if any other error occurs during the execution of the operation.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

Specified by:

stop in interface Services

Parameters:

service - identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.services.

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

stop

public void stop(java.lang.String service,
                 AsyncCallback<java.lang.Void> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Services

Stops a service. This method was added in vSphere API 6.7.

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:
NotFound - if the service associated with service does not exist.
Error - if any other error occurs during the execution of the operation.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

Specified by:

stop in interface Services

Parameters:

service - identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.services.

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

invocationConfig - Configuration for the method invocation.

restart

public void restart(java.lang.String service)

Description copied from interface: Services

Restarts a service. This method was added in vSphere API 6.7.

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

Specified by:

restart in interface Services

Parameters:

service - identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.services.

restart

public void restart(java.lang.String service,
                    InvocationConfig invocationConfig)

Description copied from interface: Services

Restarts a service. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

restart in interface Services

Parameters:

service - identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.services.

invocationConfig - Configuration for the method invocation.

restart

public void restart(java.lang.String service,
                    AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Services

Restarts a service. This method was added in vSphere API 6.7.

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

Operation Errors:
NotFound - if the service associated with service does not exist.
TimedOut - if any timeout occurs during the execution of the restart operation.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.
NotAllowedInCurrentState - if a restart operation is issued on a service which has startup type StartupType#DISABLED
Error - if any other error occurs during the execution of the operation.

Specified by:

restart in interface Services

Parameters:

service - identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.services.

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

restart

public void restart(java.lang.String service,
                    AsyncCallback<java.lang.Void> asyncCallback,
                    InvocationConfig invocationConfig)

Description copied from interface: Services

Restarts a service. This method was added in vSphere API 6.7.

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:
NotFound - if the service associated with service does not exist.
TimedOut - if any timeout occurs during the execution of the restart operation.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.
NotAllowedInCurrentState - if a restart operation is issued on a service which has startup type StartupType#DISABLED
Error - if any other error occurs during the execution of the operation.

Specified by:

restart in interface Services

Parameters:

service - identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.services.

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

invocationConfig - Configuration for the method invocation.

get

public ServicesTypes.Info get(java.lang.String service)

Description copied from interface: Services

Returns the state of a service. This method was added in vSphere API 6.7.

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

Specified by:

get in interface Services

Parameters:

service - identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.services.

Returns:

Service Info structure.

get

public ServicesTypes.Info get(java.lang.String service,
                              InvocationConfig invocationConfig)

Description copied from interface: Services

Returns the state of a service. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Services

Parameters:

service - identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.services.

invocationConfig - Configuration for the method invocation.

Returns:

Service Info structure.

get

public void get(java.lang.String service,
                AsyncCallback<ServicesTypes.Info> asyncCallback)

Description copied from interface: Services

Returns the state of a service. This method was added in vSphere API 6.7.

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

Invocation Result:
Service Info structure.

Operation Errors:
NotFound - if the service associated with service does not exist.
Error - if any other error occurs during the execution of the operation.

Specified by:

get in interface Services

Parameters:

service - identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.services.

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

get

public void get(java.lang.String service,
                AsyncCallback<ServicesTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Services

Returns the state of a service. This method was added in vSphere API 6.7.

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:
Service Info structure.

Operation Errors:
NotFound - if the service associated with service does not exist.
Error - if any other error occurs during the execution of the operation.

Specified by:

get in interface Services

Parameters:

service - identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.services.

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

invocationConfig - Configuration for the method invocation.

list

public java.util.Map<java.lang.String,ServicesTypes.Info> list()

Description copied from interface: Services

Lists details of vCenter services. This method was added in vSphere API 6.7.

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

Specified by:

list in interface Services

Returns:

Map of service identifiers to service Info structures. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.services.

list

public java.util.Map<java.lang.String,ServicesTypes.Info> list(InvocationConfig invocationConfig)

Description copied from interface: Services

Lists details of vCenter services. This method was added in vSphere API 6.7.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

list in interface Services

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Map of service identifiers to service Info structures. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.services.

list

public void list(AsyncCallback<java.util.Map<java.lang.String,ServicesTypes.Info>> asyncCallback)

Description copied from interface: Services

Lists details of vCenter services. This method was added in vSphere API 6.7.

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

Invocation Result:
Map of service identifiers to service Info structures. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.services.

Operation Errors:
Error - if any error occurs during the execution of the operation.

Specified by:

list in interface Services

Parameters:

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

list

public void list(AsyncCallback<java.util.Map<java.lang.String,ServicesTypes.Info>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Services

Lists details of vCenter services. This method was added in vSphere API 6.7.

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:
Map of service identifiers to service Info structures. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.services.

Operation Errors:
Error - if any error occurs during the execution of the operation.

Specified by:

list in interface Services

Parameters:

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

invocationConfig - Configuration for the method invocation.