com.vmware.appliance.update

Interface Policy

All Superinterfaces:

PolicyTypes, Service

All Known Implementing Classes:

PolicyStub

public interface Policy
extends Service, PolicyTypes

The Policy interface provides methods to set/get background check for the new updates. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.update.PolicyTypes

PolicyTypes.Config, PolicyTypes.DayOfWeek, PolicyTypes.Info, PolicyTypes.Time

Method Summary

Methods

Modifier and Type	Method and Description
PolicyTypes.Info	get() Gets the automatic update checking and staging policy.
void	get(AsyncCallback<PolicyTypes.Info> asyncCallback) Gets the automatic update checking and staging policy.
void	get(AsyncCallback<PolicyTypes.Info> asyncCallback, InvocationConfig invocationConfig) Gets the automatic update checking and staging policy.
PolicyTypes.Info	get(InvocationConfig invocationConfig) Gets the automatic update checking and staging policy.
void	set(PolicyTypes.Config policy) Sets the automatic update checking and staging policy.
void	set(PolicyTypes.Config policy, AsyncCallback<java.lang.Void> asyncCallback) Sets the automatic update checking and staging policy.
void	set(PolicyTypes.Config policy, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Sets the automatic update checking and staging policy.
void	set(PolicyTypes.Config policy, InvocationConfig invocationConfig) Sets the automatic update checking and staging policy.

Method Detail

get

PolicyTypes.Info get()

Gets the automatic update checking and staging policy. This method was added in vSphere API 6.7.

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

Returns:

Structure containing the policy for the appliance update.

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

get

PolicyTypes.Info get(InvocationConfig invocationConfig)

Gets the automatic update checking and staging policy. 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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Structure containing the policy for the appliance update.

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

get

void get(AsyncCallback<PolicyTypes.Info> asyncCallback)

Gets the automatic update checking and staging policy. This method was added in vSphere API 6.7.

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

Operation Result:
Structure containing the policy for the appliance update.

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Parameters:

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

get

void get(AsyncCallback<PolicyTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Gets the automatic update checking and staging policy. 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 Result:
Structure containing the policy for the appliance update.

Operation Errors:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Parameters:

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

invocationConfig - Configuration for the method invocation.

set

void set(PolicyTypes.Config policy)

Sets the automatic update checking and staging policy. This method was added in vSphere API 6.7.

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

Parameters:

policy - Info structure containing the policy for the appliance update.

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

set

void set(PolicyTypes.Config policy,
       InvocationConfig invocationConfig)

Sets the automatic update checking and staging policy. 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.

Parameters:

policy - Info structure containing the policy for the appliance update.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

Unauthenticated - session is not authenticated

Unauthorized - session is not authorized to perform this operation

set

void set(PolicyTypes.Config policy,
       AsyncCallback<java.lang.Void> asyncCallback)

Sets the automatic update checking and staging policy. 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:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Parameters:

policy - Info structure containing the policy for the appliance update.

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

set

void set(PolicyTypes.Config policy,
       AsyncCallback<java.lang.Void> asyncCallback,
       InvocationConfig invocationConfig)

Sets the automatic update checking and staging policy. 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:
Error - Generic error
Unauthenticated - session is not authenticated
Unauthorized - session is not authorized to perform this operation

Parameters:

policy - Info structure containing the policy for the appliance update.

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

invocationConfig - Configuration for the method invocation.