com.vmware.esx.hosts

Class SoftwareStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.hosts.SoftwareStub

All Implemented Interfaces:

Software, SoftwareTypes, Service

public class SoftwareStub
extends com.vmware.vapi.internal.bindings.Stub
implements Software

Remote stub implementation of the Software API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.hosts.SoftwareTypes

SoftwareTypes.ConnectionSpec, SoftwareTypes.HostCredentials, SoftwareTypes.Info

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.esx.hosts.SoftwareTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SoftwareTypes.Info	get(SoftwareTypes.ConnectionSpec spec) Returns details about the current software specification applied to the host.
void	get(SoftwareTypes.ConnectionSpec spec, AsyncCallback<SoftwareTypes.Info> asyncCallback) Returns details about the current software specification applied to the host.
void	get(SoftwareTypes.ConnectionSpec spec, AsyncCallback<SoftwareTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns details about the current software specification applied to the host.
SoftwareTypes.Info	get(SoftwareTypes.ConnectionSpec spec, InvocationConfig invocationConfig) Returns details about the current software specification applied to the host.

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

SoftwareStub

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

SoftwareStub

public SoftwareStub(ApiProvider apiProvider,
                    StubConfigurationBase config)

Method Detail

get

public SoftwareTypes.Info get(SoftwareTypes.ConnectionSpec spec)

Description copied from interface: Software

Returns details about the current software specification applied to the host. This method was added in vSphere API 7.0.2.0.

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

Specified by:

get in interface Software

Parameters:

spec - ConnectionSpec connection spec for the host.

Returns:

Info details about the current software specification applied to the host.

get

public SoftwareTypes.Info get(SoftwareTypes.ConnectionSpec spec,
                              InvocationConfig invocationConfig)

Description copied from interface: Software

Returns details about the current software specification applied to the host. This method was added in vSphere API 7.0.2.0.

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 Software

Parameters:

spec - ConnectionSpec connection spec for the host.

invocationConfig - Configuration for the method invocation.

Returns:

Info details about the current software specification applied to the host.

get

public void get(SoftwareTypes.ConnectionSpec spec,
                AsyncCallback<SoftwareTypes.Info> asyncCallback)

Description copied from interface: Software

Returns details about the current software specification applied to the host. This method was added in vSphere API 7.0.2.0.

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

Invocation Result:
Info details about the current software specification applied to the host.

Operation Errors:
InvalidArgument - if the ConnectionSpec.HostCredentials#hostName property of spec is invalid.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no ConnectionSpec.HostCredentials#hostName property associated with host id in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
UnverifiedPeer - If the SSL certificate of the target node cannot be validated by comparing with the thumbprint provided in ConnectionSpec.HostCredentials#sslThumbPrint.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Specified by:

get in interface Software

Parameters:

spec - ConnectionSpec connection spec for the host.

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

get

public void get(SoftwareTypes.ConnectionSpec spec,
                AsyncCallback<SoftwareTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Software

Returns details about the current software specification applied to the host. This method was added in vSphere API 7.0.2.0.

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:
Info details about the current software specification applied to the host.

Operation Errors:
InvalidArgument - if the ConnectionSpec.HostCredentials#hostName property of spec is invalid.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no ConnectionSpec.HostCredentials#hostName property associated with host id in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
UnverifiedPeer - If the SSL certificate of the target node cannot be validated by comparing with the thumbprint provided in ConnectionSpec.HostCredentials#sslThumbPrint.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Specified by:

get in interface Software

Parameters:

spec - ConnectionSpec connection spec for the host.

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

invocationConfig - Configuration for the method invocation.