com.vmware.esx.settings.hosts.policies.apply

Class EffectiveStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.settings.hosts.policies.apply.EffectiveStub

All Implemented Interfaces:

Effective, EffectiveTypes, Service

public class EffectiveStub
extends com.vmware.vapi.internal.bindings.Stub
implements Effective

Remote stub implementation of the Effective 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.apply.EffectiveTypes

EffectiveTypes.EffectivePolicySpec, EffectiveTypes.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.apply.EffectiveTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EffectiveTypes.EffectivePolicySpec	get(java.lang.String host) Returns the effective policy based on system defaults and what has been configured for the ESXi host.
void	get(java.lang.String host, AsyncCallback<EffectiveTypes.EffectivePolicySpec> asyncCallback) Returns the effective policy based on system defaults and what has been configured for the ESXi host.
void	get(java.lang.String host, AsyncCallback<EffectiveTypes.EffectivePolicySpec> asyncCallback, InvocationConfig invocationConfig) Returns the effective policy based on system defaults and what has been configured for the ESXi host.
EffectiveTypes.EffectivePolicySpec	get(java.lang.String host, InvocationConfig invocationConfig) Returns the effective policy based on system defaults and what has been configured for the 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

EffectiveStub

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

EffectiveStub

public EffectiveStub(ApiProvider apiProvider,
                     StubConfigurationBase config)

Method Detail

get

public EffectiveTypes.EffectivePolicySpec get(java.lang.String host)

Description copied from interface: Effective

Returns the effective policy based on system defaults and what has been configured 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 Effective

Parameters:

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

Returns:

The effective policies that impact the apply method

get

public EffectiveTypes.EffectivePolicySpec get(java.lang.String host,
                                              InvocationConfig invocationConfig)

Description copied from interface: Effective

Returns the effective policy based on system defaults and what has been configured 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 Effective

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

The effective policies that impact the apply method

get

public void get(java.lang.String host,
                AsyncCallback<EffectiveTypes.EffectivePolicySpec> asyncCallback)

Description copied from interface: Effective

Returns the effective policy based on system defaults and what has been configured 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 effective 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 Effective

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<EffectiveTypes.EffectivePolicySpec> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Effective

Returns the effective policy based on system defaults and what has been configured 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 effective 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 Effective

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.