public class PendingStub extends com.vmware.vapi.internal.bindings.Stub implements Pending
Pending
API service.
WARNING: Internal class, subject to change in future versions.
PendingTypes.Info, PendingTypes.PrecheckResult, PendingTypes.Question, PendingTypes.SourceType
apiProvider, converter, ifaceId, retryPolicy, securityContext
_VAPI_SERVICE_ID
Constructor and Description |
---|
PendingStub(ApiProvider apiProvider,
StubConfigurationBase config) |
PendingStub(ApiProvider apiProvider,
com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
StubConfigurationBase config) |
Modifier and Type | Method and Description |
---|---|
PendingTypes.Info |
get(java.lang.String version)
Gets update information.
|
void |
get(java.lang.String version,
AsyncCallback<PendingTypes.Info> asyncCallback)
Gets update information.
|
void |
get(java.lang.String version,
AsyncCallback<PendingTypes.Info> asyncCallback,
InvocationConfig invocationConfig)
Gets update information.
|
PendingTypes.Info |
get(java.lang.String version,
InvocationConfig invocationConfig)
Gets update information.
|
void |
install(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData)
Starts operation of installing the appliance update.
|
void |
install(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData,
AsyncCallback<java.lang.Void> asyncCallback)
Starts operation of installing the appliance update.
|
void |
install(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Starts operation of installing the appliance update.
|
void |
install(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData,
InvocationConfig invocationConfig)
Starts operation of installing the appliance update.
|
java.util.List<Summary> |
list(PendingTypes.SourceType sourceType,
java.lang.String url)
Checks if new updates are available.
|
void |
list(PendingTypes.SourceType sourceType,
java.lang.String url,
AsyncCallback<java.util.List<Summary>> asyncCallback)
Checks if new updates are available.
|
void |
list(PendingTypes.SourceType sourceType,
java.lang.String url,
AsyncCallback<java.util.List<Summary>> asyncCallback,
InvocationConfig invocationConfig)
Checks if new updates are available.
|
java.util.List<Summary> |
list(PendingTypes.SourceType sourceType,
java.lang.String url,
InvocationConfig invocationConfig)
Checks if new updates are available.
|
PendingTypes.PrecheckResult |
precheck(java.lang.String version)
Runs update precheck.
|
void |
precheck(java.lang.String version,
AsyncCallback<PendingTypes.PrecheckResult> asyncCallback)
Runs update precheck.
|
void |
precheck(java.lang.String version,
AsyncCallback<PendingTypes.PrecheckResult> asyncCallback,
InvocationConfig invocationConfig)
Runs update precheck.
|
PendingTypes.PrecheckResult |
precheck(java.lang.String version,
InvocationConfig invocationConfig)
Runs update precheck.
|
void |
stage(java.lang.String version)
Starts staging the appliance update.
|
void |
stage(java.lang.String version,
AsyncCallback<java.lang.Void> asyncCallback)
Starts staging the appliance update.
|
void |
stage(java.lang.String version,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Starts staging the appliance update.
|
void |
stage(java.lang.String version,
InvocationConfig invocationConfig)
Starts staging the appliance update.
|
void |
stageAndInstall(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData)
Starts operation of installing the appliance update.
|
void |
stageAndInstall(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData,
AsyncCallback<java.lang.Void> asyncCallback)
Starts operation of installing the appliance update.
|
void |
stageAndInstall(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Starts operation of installing the appliance update.
|
void |
stageAndInstall(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData,
InvocationConfig invocationConfig)
Starts operation of installing the appliance update.
|
Notifications |
validate(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData)
Validates the user provided data before the update installation.
|
void |
validate(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData,
AsyncCallback<Notifications> asyncCallback)
Validates the user provided data before the update installation.
|
void |
validate(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData,
AsyncCallback<Notifications> asyncCallback,
InvocationConfig invocationConfig)
Validates the user provided data before the update installation.
|
Notifications |
validate(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> userData,
InvocationConfig invocationConfig)
Validates the user provided data before the update installation.
|
public PendingStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)
public PendingStub(ApiProvider apiProvider, StubConfigurationBase config)
public java.util.List<Summary> list(PendingTypes.SourceType sourceType, java.lang.String url)
Pending
Synchronous method overload. Result of the invocation will be reported as a method return value.
public java.util.List<Summary> list(PendingTypes.SourceType sourceType, java.lang.String url, InvocationConfig invocationConfig)
Pending
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void list(PendingTypes.SourceType sourceType, java.lang.String url, AsyncCallback<java.util.List<Summary>> asyncCallback)
Pending
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
List of the update summaries
Operation Errors:
Error
- Generic error
NotFound
- source is not found
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
public void list(PendingTypes.SourceType sourceType, java.lang.String url, AsyncCallback<java.util.List<Summary>> asyncCallback, InvocationConfig invocationConfig)
Pending
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:
List of the update summaries
Operation Errors:
Error
- Generic error
NotFound
- source is not found
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
list
in interface Pending
sourceType
- type of the sourceurl
- specific URL to check at
If null
then URL is taken from the policy settingsasyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public PendingTypes.Info get(java.lang.String version)
Pending
Synchronous method overload. Result of the invocation will be reported as a method return value.
public PendingTypes.Info get(java.lang.String version, InvocationConfig invocationConfig)
Pending
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void get(java.lang.String version, AsyncCallback<PendingTypes.Info> asyncCallback)
Pending
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Update
Operation Errors:
Error
- Generic error
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
NotFound
- the update is not found
AlreadyInDesiredState
- if the update of this version is already installed
public void get(java.lang.String version, AsyncCallback<PendingTypes.Info> asyncCallback, InvocationConfig invocationConfig)
Pending
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:
Update
Operation Errors:
Error
- Generic error
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
NotFound
- the update is not found
AlreadyInDesiredState
- if the update of this version is already installed
get
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public PendingTypes.PrecheckResult precheck(java.lang.String version)
Pending
Synchronous method overload. Result of the invocation will be reported as a method return value.
public PendingTypes.PrecheckResult precheck(java.lang.String version, InvocationConfig invocationConfig)
Pending
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void precheck(java.lang.String version, AsyncCallback<PendingTypes.PrecheckResult> asyncCallback)
Pending
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
PrecheckResult
Operation Errors:
Error
- Generic error
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
NotFound
- the update is not found
AlreadyInDesiredState
- if this version is already installed
NotAllowedInCurrentState
- if another operation is in progress
public void precheck(java.lang.String version, AsyncCallback<PendingTypes.PrecheckResult> asyncCallback, InvocationConfig invocationConfig)
Pending
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:
PrecheckResult
Operation Errors:
Error
- Generic error
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
NotFound
- the update is not found
AlreadyInDesiredState
- if this version is already installed
NotAllowedInCurrentState
- if another operation is in progress
precheck
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void stage(java.lang.String version)
Pending
Synchronous method overload. Result of the invocation will be reported as a method return value.
public void stage(java.lang.String version, InvocationConfig invocationConfig)
Pending
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void stage(java.lang.String version, AsyncCallback<java.lang.Void> asyncCallback)
Pending
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
NotFound
- the update is not found
AlreadyInDesiredState
- if the update of this version is already installed
AlreadyExists
- the update is already staged
NotAllowedInCurrentState
- if appliance update state prevents staging
public void stage(java.lang.String version, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Pending
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
NotFound
- the update is not found
AlreadyInDesiredState
- if the update of this version is already installed
AlreadyExists
- the update is already staged
NotAllowedInCurrentState
- if appliance update state prevents staging
stage
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public Notifications validate(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData)
Pending
Synchronous method overload. Result of the invocation will be reported as a method return value.
validate
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.public Notifications validate(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, InvocationConfig invocationConfig)
Pending
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
validate
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.invocationConfig
- Configuration for the method invocation.public void validate(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, AsyncCallback<Notifications> asyncCallback)
Pending
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Issues struct with the issues found during the validation
Operation Errors:
Error
- Generic error
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
NotFound
- if the update is not found
AlreadyInDesiredState
- if the update of this version is already installed
NotAllowedInCurrentState
- if appliance update state prevents running an check
validate
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void validate(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, AsyncCallback<Notifications> asyncCallback, InvocationConfig invocationConfig)
Pending
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:
Issues struct with the issues found during the validation
Operation Errors:
Error
- Generic error
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
NotFound
- if the update is not found
AlreadyInDesiredState
- if the update of this version is already installed
NotAllowedInCurrentState
- if appliance update state prevents running an check
validate
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void install(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData)
Pending
Synchronous method overload. Result of the invocation will be reported as a method return value.
install
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.public void install(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, InvocationConfig invocationConfig)
Pending
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
install
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.invocationConfig
- Configuration for the method invocation.public void install(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, AsyncCallback<java.lang.Void> asyncCallback)
Pending
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- Generic error
Error
- Generic error
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
NotFound
- if the update is not found
AlreadyInDesiredState
- if the update of this version is already installed
NotAllowedInCurrentState
- if appliance update state prevents running an update or not staged
install
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void install(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Pending
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
Error
- Generic error
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
NotFound
- if the update is not found
AlreadyInDesiredState
- if the update of this version is already installed
NotAllowedInCurrentState
- if appliance update state prevents running an update or not staged
install
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.public void stageAndInstall(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData)
Pending
Synchronous method overload. Result of the invocation will be reported as a method return value.
stageAndInstall
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.public void stageAndInstall(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, InvocationConfig invocationConfig)
Pending
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
stageAndInstall
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.invocationConfig
- Configuration for the method invocation.public void stageAndInstall(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, AsyncCallback<java.lang.Void> asyncCallback)
Pending
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- Generic error
Error
- Generic error
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
NotFound
- if the update is not found
AlreadyInDesiredState
- if the update of this version is already installed
NotAllowedInCurrentState
- if appliance update state prevents running an update
stageAndInstall
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.public void stageAndInstall(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> userData, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Pending
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
Error
- Generic error
Unauthenticated
- session is not authenticated
Unauthorized
- session is not authorized to perform this operation
NotFound
- if the update is not found
AlreadyInDesiredState
- if the update of this version is already installed
NotAllowedInCurrentState
- if appliance update state prevents running an update
stageAndInstall
in interface Pending
version
- Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending
.userData
- map of user provided data with IDs
The key in the parameter Map
must be an identifier for the
resource type: com.vmware.applicance.update.pending.dataitem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.