public interface Apply extends Service, ApplyTypes
Apply
interface provides methods to configure the policies that will
impact how the software and configuration specification documents are applied to
ESXi clusters.ApplyTypes.ConfiguredPolicySpec, ApplyTypes.FailureAction, ApplyTypes.ParallelRemediationAction
_VAPI_SERVICE_ID
Modifier and Type | Method and Description |
---|---|
ApplyTypes.ConfiguredPolicySpec |
get()
Returns the configured policy that has been set.
|
void |
get(AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback)
Returns the configured policy that has been set.
|
void |
get(AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback,
InvocationConfig invocationConfig)
Returns the configured policy that has been set.
|
ApplyTypes.ConfiguredPolicySpec |
get(InvocationConfig invocationConfig)
Returns the configured policy that has been set.
|
void |
set(ApplyTypes.ConfiguredPolicySpec spec)
This API will set the configured policy specification.
|
void |
set(ApplyTypes.ConfiguredPolicySpec spec,
AsyncCallback<java.lang.Void> asyncCallback)
This API will set the configured policy specification.
|
void |
set(ApplyTypes.ConfiguredPolicySpec spec,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
This API will set the configured policy specification.
|
void |
set(ApplyTypes.ConfiguredPolicySpec spec,
InvocationConfig invocationConfig)
This API will set the configured policy specification.
|
ApplyTypes.ConfiguredPolicySpec get()
Synchronous method overload. Result of the invocation will be reported as a method return value.
Error
- If there is an unknown internal error. The accompanying error message will give
more details about the failure.ServiceUnavailable
- If the service is not available.Unauthenticated
- if the caller is not authenticated.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Read
. ApplyTypes.ConfiguredPolicySpec get(InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
invocationConfig
- Configuration for the method invocation.Error
- If there is an unknown internal error. The accompanying error message will give
more details about the failure.ServiceUnavailable
- If the service is not available.Unauthenticated
- if the caller is not authenticated.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Read
. void get(AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback)
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.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- if the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback, InvocationConfig invocationConfig)
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.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- if the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void set(ApplyTypes.ConfiguredPolicySpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
spec
- The policy that needs to be configured.Error
- If there is an unknown internal error. The accompanying error message will give
more details about the failure.InvalidArgument
- If invalid value is provided.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Write
. void set(ApplyTypes.ConfiguredPolicySpec spec, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
spec
- The policy that needs to be configured.invocationConfig
- Configuration for the method invocation.Error
- If there is an unknown internal error. The accompanying error message will give
more details about the failure.InvalidArgument
- If invalid value is provided.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Write
. void set(ApplyTypes.ConfiguredPolicySpec spec, AsyncCallback<java.lang.Void> asyncCallback)
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.
InvalidArgument
- If invalid value is provided.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Write
. spec
- The policy that needs to be configured.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void set(ApplyTypes.ConfiguredPolicySpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
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.
InvalidArgument
- If invalid value is provided.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Write
. spec
- The policy that needs to be configured.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.