com.vmware.esx.settings.hosts.policies

Class ApplyStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.settings.hosts.policies.ApplyStub

All Implemented Interfaces:

Apply, ApplyTypes, Service

public class ApplyStub
extends com.vmware.vapi.internal.bindings.Stub
implements Apply

Remote stub implementation of the Apply API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.hosts.policies.ApplyTypes

ApplyTypes.ConfiguredPolicySpec, ApplyTypes.FailureAction

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.esx.settings.hosts.policies.ApplyTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ApplyTypes.ConfiguredPolicySpec	get(java.lang.String host) Returns the configured policy that has been set for the ESXi host.
void	get(java.lang.String host, AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback) Returns the configured policy that has been set for the ESXi host.
void	get(java.lang.String host, AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback, InvocationConfig invocationConfig) Returns the configured policy that has been set for the ESXi host.
ApplyTypes.ConfiguredPolicySpec	get(java.lang.String host, InvocationConfig invocationConfig) Returns the configured policy that has been set for the ESXi host.
void	set(java.lang.String host, ApplyTypes.ConfiguredPolicySpec spec) This API will set the configured policy for an ESXi host.
void	set(java.lang.String host, ApplyTypes.ConfiguredPolicySpec spec, AsyncCallback<java.lang.Void> asyncCallback) This API will set the configured policy for an ESXi host.
void	set(java.lang.String host, ApplyTypes.ConfiguredPolicySpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) This API will set the configured policy for an ESXi host.
void	set(java.lang.String host, ApplyTypes.ConfiguredPolicySpec spec, InvocationConfig invocationConfig) This API will set the configured policy for an ESXi 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

ApplyStub

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

ApplyStub

public ApplyStub(ApiProvider apiProvider,
                 StubConfigurationBase config)

Method Detail

get

public ApplyTypes.ConfiguredPolicySpec get(java.lang.String host)

Description copied from interface: Apply

Returns the configured policy that has been set for the ESXi host. This method was added in vSphere API 8.0.0.1.

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

Specified by:

get in interface Apply

Parameters:

host - The host identifier. The parameter must be an identifier for the resource type: HostSystem.

Returns:

The configured policies that impact the apply method

get

public ApplyTypes.ConfiguredPolicySpec get(java.lang.String host,
                                           InvocationConfig invocationConfig)

Description copied from interface: Apply

Returns the configured policy that has been set for the ESXi host. This method was added in vSphere API 8.0.0.1.

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 Apply

Parameters:

host - The host identifier. The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Returns:

The configured policies that impact the apply method

get

public void get(java.lang.String host,
                AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback)

Description copied from interface: Apply

Returns the configured policy that has been set for the ESXi host. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
The configured policies that impact the apply method

Operation Errors:
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no host associated with host in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

Specified by:

get in interface Apply

Parameters:

host - The host identifier. The parameter must be an identifier for the resource type: HostSystem.

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

get

public void get(java.lang.String host,
                AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Apply

Returns the configured policy that has been set for the ESXi host. This method was added in vSphere API 8.0.0.1.

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:
The configured policies that impact the apply method

Operation Errors:
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no host associated with host in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

Specified by:

get in interface Apply

Parameters:

host - The host identifier. The parameter must be an identifier for the resource type: HostSystem.

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

invocationConfig - Configuration for the method invocation.

set

public void set(java.lang.String host,
                ApplyTypes.ConfiguredPolicySpec spec)

Description copied from interface: Apply

This API will set the configured policy for an ESXi host. This method was added in vSphere API 8.0.0.1.

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

Specified by:

set in interface Apply

Parameters:

host - The host identifier. The parameter must be an identifier for the resource type: HostSystem.

spec - The policy specification.

set

public void set(java.lang.String host,
                ApplyTypes.ConfiguredPolicySpec spec,
                InvocationConfig invocationConfig)

Description copied from interface: Apply

This API will set the configured policy for an ESXi host. This method was added in vSphere API 8.0.0.1.

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:

set in interface Apply

Parameters:

host - The host identifier. The parameter must be an identifier for the resource type: HostSystem.

spec - The policy specification.

invocationConfig - Configuration for the method invocation.

set

public void set(java.lang.String host,
                ApplyTypes.ConfiguredPolicySpec spec,
                AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Apply

This API will set the configured policy for an ESXi host. This method was added in vSphere API 8.0.0.1.

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

Operation Errors:
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no host associated with host in the system.
InvalidArgument - If invalid value is provided.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

Specified by:

set in interface Apply

Parameters:

host - The host identifier. The parameter must be an identifier for the resource type: HostSystem.

spec - The policy specification.

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

set

public void set(java.lang.String host,
                ApplyTypes.ConfiguredPolicySpec spec,
                AsyncCallback<java.lang.Void> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Apply

This API will set the configured policy for an ESXi host. This method was added in vSphere API 8.0.0.1.

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:
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no host associated with host in the system.
InvalidArgument - If invalid value is provided.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

Specified by:

set in interface Apply

Parameters:

host - The host identifier. The parameter must be an identifier for the resource type: HostSystem.

spec - The policy specification.

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

invocationConfig - Configuration for the method invocation.