com.vmware.vcenter.namespace_management.supervisors.recovery.backup

Interface Jobs

All Superinterfaces:

JobsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

JobsStub

public interface Jobs
extends com.vmware.vapi.bindings.Service, JobsTypes

The Jobs interface provides methods to create Supervisor backup jobs. This interface was added in vSphere API 8.0.3.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.supervisors.recovery.backup.JobsTypes

JobsTypes.CreateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.supervisors.recovery.backup.JobsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(java.lang.String supervisor, JobsTypes.CreateSpec spec) Initiate a Supervisor Backup job.
void	create(java.lang.String supervisor, JobsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Initiate a Supervisor Backup job.
void	create(java.lang.String supervisor, JobsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Initiate a Supervisor Backup job.
java.lang.String	create(java.lang.String supervisor, JobsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Initiate a Supervisor Backup job.

Method Detail

create

java.lang.String create(java.lang.String supervisor,
                        JobsTypes.CreateSpec spec)

Initiate a Supervisor Backup job. The Backup captures Supervisor Control plane state that includes a snapshot of etcd, required certificates and container images for infrastructure components. Once the job succeeds, corresponding Backup archive will be stored on vCenter Appliance file system. These Backup archives can be looked up and managed using operations provided by Archives interface and can be used to restore the Supervisor using Jobs.create(java.lang.String, java.lang.String). This method was added in vSphere API 8.0.3.0.

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

Parameters:

supervisor - Identifier for the Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - Specifies input parameters for backup create job.

Returns:

The task identifier for the backup job. On success, the task's result property will be set to The return value will be an identifier for the resource type: com.vmware.cis.task.

Throws:

Error - if the system reports an error while responding to the request.

AlreadyExists - if a backup job is already pending for the Supervisor.

NotAllowedInCurrentState - if Supervisor is not healthy and {#member CreateSpec.ignoreHealthCheckFailure} is not set to true or if Supervisor is not fully enabled yet.

NotFound - if the given Supervisor cannot be found.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the Namespaces.Backup privilege on the Supervisor.

Unsupported - if version of the specified Supervisor does not support backup.

create

java.lang.String create(java.lang.String supervisor,
                        JobsTypes.CreateSpec spec,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Initiate a Supervisor Backup job. The Backup captures Supervisor Control plane state that includes a snapshot of etcd, required certificates and container images for infrastructure components. Once the job succeeds, corresponding Backup archive will be stored on vCenter Appliance file system. These Backup archives can be looked up and managed using operations provided by Archives interface and can be used to restore the Supervisor using Jobs.create(java.lang.String, java.lang.String). This method was added in vSphere API 8.0.3.0.

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:

supervisor - Identifier for the Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - Specifies input parameters for backup create job.

invocationConfig - Configuration for the method invocation.

Returns:

The task identifier for the backup job. On success, the task's result property will be set to The return value will be an identifier for the resource type: com.vmware.cis.task.

Throws:

Error - if the system reports an error while responding to the request.

AlreadyExists - if a backup job is already pending for the Supervisor.

NotAllowedInCurrentState - if Supervisor is not healthy and {#member CreateSpec.ignoreHealthCheckFailure} is not set to true or if Supervisor is not fully enabled yet.

NotFound - if the given Supervisor cannot be found.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the Namespaces.Backup privilege on the Supervisor.

Unsupported - if version of the specified Supervisor does not support backup.

create

void create(java.lang.String supervisor,
            JobsTypes.CreateSpec spec,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Initiate a Supervisor Backup job. The Backup captures Supervisor Control plane state that includes a snapshot of etcd, required certificates and container images for infrastructure components. Once the job succeeds, corresponding Backup archive will be stored on vCenter Appliance file system. These Backup archives can be looked up and managed using operations provided by Archives interface and can be used to restore the Supervisor using Jobs.create(java.lang.String, java.lang.String). This method was added in vSphere API 8.0.3.0.

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

Invocation Result:
The task identifier for the backup job. On success, the task's result property will be set to The return value will be an identifier for the resource type: com.vmware.cis.task.

Operation Errors:
Error - if the system reports an error while responding to the request.
AlreadyExists - if a backup job is already pending for the Supervisor.
NotAllowedInCurrentState - if Supervisor is not healthy and {#member CreateSpec.ignoreHealthCheckFailure} is not set to true or if Supervisor is not fully enabled yet.
NotFound - if the given Supervisor cannot be found.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the Namespaces.Backup privilege on the Supervisor.
Unsupported - if version of the specified Supervisor does not support backup.

Parameters:

supervisor - Identifier for the Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - Specifies input parameters for backup create job.

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

create

void create(java.lang.String supervisor,
            JobsTypes.CreateSpec spec,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Initiate a Supervisor Backup job. The Backup captures Supervisor Control plane state that includes a snapshot of etcd, required certificates and container images for infrastructure components. Once the job succeeds, corresponding Backup archive will be stored on vCenter Appliance file system. These Backup archives can be looked up and managed using operations provided by Archives interface and can be used to restore the Supervisor using Jobs.create(java.lang.String, java.lang.String). This method was added in vSphere API 8.0.3.0.

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 task identifier for the backup job. On success, the task's result property will be set to The return value will be an identifier for the resource type: com.vmware.cis.task.

Operation Errors:
Error - if the system reports an error while responding to the request.
AlreadyExists - if a backup job is already pending for the Supervisor.
NotAllowedInCurrentState - if Supervisor is not healthy and {#member CreateSpec.ignoreHealthCheckFailure} is not set to true or if Supervisor is not fully enabled yet.
NotFound - if the given Supervisor cannot be found.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the Namespaces.Backup privilege on the Supervisor.
Unsupported - if version of the specified Supervisor does not support backup.

Parameters:

supervisor - Identifier for the Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - Specifies input parameters for backup create job.

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

invocationConfig - Configuration for the method invocation.