com.vmware.snapservice.clusters

Interface ProtectionGroups

All Superinterfaces:

ProtectionGroupsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ProtectionGroupsStub

public interface ProtectionGroups
extends com.vmware.vapi.bindings.Service, ProtectionGroupsTypes

The ProtectionGroups interface provides methods for managing protection groups created for a cluster.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.snapservice.clusters.ProtectionGroupsTypes

ProtectionGroupsTypes._VAPI_OPERATIONS, ProtectionGroupsTypes.DeleteSpec, ProtectionGroupsTypes.FilterSpec, ProtectionGroupsTypes.ListItem, ProtectionGroupsTypes.ListResult

Field Summary

Fields inherited from interface com.vmware.snapservice.clusters.ProtectionGroupsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create_Task(java.lang.String cluster, ProtectionGroupSpec spec) Create a protection group for the given cluster.
void	create_Task(java.lang.String cluster, ProtectionGroupSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Create a protection group for the given cluster.
void	create_Task(java.lang.String cluster, ProtectionGroupSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a protection group for the given cluster.
java.lang.String	create_Task(java.lang.String cluster, ProtectionGroupSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a protection group for the given cluster.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String pg, ProtectionGroupsTypes.DeleteSpec spec) Delete the specified protection group.
void	delete_Task(java.lang.String cluster, java.lang.String pg, ProtectionGroupsTypes.DeleteSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Delete the specified protection group.
void	delete_Task(java.lang.String cluster, java.lang.String pg, ProtectionGroupsTypes.DeleteSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete the specified protection group.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String pg, ProtectionGroupsTypes.DeleteSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete the specified protection group.
ProtectionGroupInfo	get(java.lang.String cluster, java.lang.String pg) Get the detailed information regarding the specified protection group.
void	get(java.lang.String cluster, java.lang.String pg, com.vmware.vapi.bindings.client.AsyncCallback<ProtectionGroupInfo> asyncCallback) Get the detailed information regarding the specified protection group.
void	get(java.lang.String cluster, java.lang.String pg, com.vmware.vapi.bindings.client.AsyncCallback<ProtectionGroupInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the detailed information regarding the specified protection group.
ProtectionGroupInfo	get(java.lang.String cluster, java.lang.String pg, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the detailed information regarding the specified protection group.
ProtectionGroupsTypes.ListResult	list(java.lang.String cluster, ProtectionGroupsTypes.FilterSpec filter) List the protection groups for the given cluster.
void	list(java.lang.String cluster, ProtectionGroupsTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<ProtectionGroupsTypes.ListResult> asyncCallback) List the protection groups for the given cluster.
void	list(java.lang.String cluster, ProtectionGroupsTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<ProtectionGroupsTypes.ListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List the protection groups for the given cluster.
ProtectionGroupsTypes.ListResult	list(java.lang.String cluster, ProtectionGroupsTypes.FilterSpec filter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List the protection groups for the given cluster.
java.lang.String	pause_Task(java.lang.String cluster, java.lang.String pg) Pause the specified proteciton group.
void	pause_Task(java.lang.String cluster, java.lang.String pg, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Pause the specified proteciton group.
void	pause_Task(java.lang.String cluster, java.lang.String pg, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Pause the specified proteciton group.
java.lang.String	pause_Task(java.lang.String cluster, java.lang.String pg, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Pause the specified proteciton group.
java.lang.String	resume_Task(java.lang.String cluster, java.lang.String pg) Resume the specified proteciton group.
void	resume_Task(java.lang.String cluster, java.lang.String pg, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Resume the specified proteciton group.
void	resume_Task(java.lang.String cluster, java.lang.String pg, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Resume the specified proteciton group.
java.lang.String	resume_Task(java.lang.String cluster, java.lang.String pg, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Resume the specified proteciton group.
java.lang.String	update_Task(java.lang.String cluster, java.lang.String pg, ProtectionGroupUpdateSpec spec) Update a protection group for the given cluster.
void	update_Task(java.lang.String cluster, java.lang.String pg, ProtectionGroupUpdateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Update a protection group for the given cluster.
void	update_Task(java.lang.String cluster, java.lang.String pg, ProtectionGroupUpdateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update a protection group for the given cluster.
java.lang.String	update_Task(java.lang.String cluster, java.lang.String pg, ProtectionGroupUpdateSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update a protection group for the given cluster.

Method Detail

create_Task

java.lang.String create_Task(java.lang.String cluster,
                             ProtectionGroupSpec spec)

Create a protection group for the given cluster.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - specification for the protection group.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If there is no cluster associated with cluster in the system.

InvalidArgument - If validation of the spec fails.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

create_Task

java.lang.String create_Task(java.lang.String cluster,
                             ProtectionGroupSpec spec,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a protection group for the given cluster.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - specification for the protection group.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If there is no cluster associated with cluster in the system.

InvalidArgument - If validation of the spec fails.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

create_Task

void create_Task(java.lang.String cluster,
                 ProtectionGroupSpec spec,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Create a protection group for the given cluster.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If there is no cluster associated with cluster in the system.
InvalidArgument - If validation of the spec fails.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - specification for the protection group.

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

create_Task

void create_Task(java.lang.String cluster,
                 ProtectionGroupSpec spec,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a protection group for the given cluster.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If there is no cluster associated with cluster in the system.
InvalidArgument - If validation of the spec fails.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - specification for the protection group.

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

invocationConfig - Configuration for the method invocation.

list

ProtectionGroupsTypes.ListResult list(java.lang.String cluster,
                                      ProtectionGroupsTypes.FilterSpec filter)

List the protection groups for the given cluster.

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

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

filter - Specification of matching protection groups for which information should be returned. If null, the behavior is equivalent to a ProtectionGroupsTypes.FilterSpec with all properties null which means all protection groups match the filter.

Returns:

Information about the protection groups matching the ProtectionGroupsTypes.FilterSpec for the given cluster.

Throws:

Error - If there is unknown internal error.

NotFound - If there is no cluster associated with cluster in the system.

InvalidArgument - If validation of the filter fails.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

list

ProtectionGroupsTypes.ListResult list(java.lang.String cluster,
                                      ProtectionGroupsTypes.FilterSpec filter,
                                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List the protection groups for the given cluster.

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:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

filter - Specification of matching protection groups for which information should be returned. If null, the behavior is equivalent to a ProtectionGroupsTypes.FilterSpec with all properties null which means all protection groups match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the protection groups matching the ProtectionGroupsTypes.FilterSpec for the given cluster.

Throws:

Error - If there is unknown internal error.

NotFound - If there is no cluster associated with cluster in the system.

InvalidArgument - If validation of the filter fails.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

list

void list(java.lang.String cluster,
          ProtectionGroupsTypes.FilterSpec filter,
          com.vmware.vapi.bindings.client.AsyncCallback<ProtectionGroupsTypes.ListResult> asyncCallback)

List the protection groups for the given cluster.

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

Invocation Result:
Information about the protection groups matching the ProtectionGroupsTypes.FilterSpec for the given cluster.

Operation Errors:
Error - If there is unknown internal error.
NotFound - If there is no cluster associated with cluster in the system.
InvalidArgument - If validation of the filter fails.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

filter - Specification of matching protection groups for which information should be returned. If null, the behavior is equivalent to a ProtectionGroupsTypes.FilterSpec with all properties null which means all protection groups match the filter.

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

list

void list(java.lang.String cluster,
          ProtectionGroupsTypes.FilterSpec filter,
          com.vmware.vapi.bindings.client.AsyncCallback<ProtectionGroupsTypes.ListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List the protection groups for the given cluster.

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:
Information about the protection groups matching the ProtectionGroupsTypes.FilterSpec for the given cluster.

Operation Errors:
Error - If there is unknown internal error.
NotFound - If there is no cluster associated with cluster in the system.
InvalidArgument - If validation of the filter fails.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

filter - Specification of matching protection groups for which information should be returned. If null, the behavior is equivalent to a ProtectionGroupsTypes.FilterSpec with all properties null which means all protection groups match the filter.

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

invocationConfig - Configuration for the method invocation.

get

ProtectionGroupInfo get(java.lang.String cluster,
                        java.lang.String pg)

Get the detailed information regarding the specified protection group.

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

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group. The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

Returns:

Information about the specified protection group.

Throws:

Error - If there is unknown internal error.

NotFound - If no cluster associated with cluster or protection group associated with pg is found in the system.

InvalidArgument - If any input is invalid.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

get

ProtectionGroupInfo get(java.lang.String cluster,
                        java.lang.String pg,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get the detailed information regarding the specified protection group.

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:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group. The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified protection group.

Throws:

Error - If there is unknown internal error.

NotFound - If no cluster associated with cluster or protection group associated with pg is found in the system.

InvalidArgument - If any input is invalid.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

get

void get(java.lang.String cluster,
         java.lang.String pg,
         com.vmware.vapi.bindings.client.AsyncCallback<ProtectionGroupInfo> asyncCallback)

Get the detailed information regarding the specified protection group.

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

Invocation Result:
Information about the specified protection group.

Operation Errors:
Error - If there is unknown internal error.
NotFound - If no cluster associated with cluster or protection group associated with pg is found in the system.
InvalidArgument - If any input is invalid.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group. The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

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

get

void get(java.lang.String cluster,
         java.lang.String pg,
         com.vmware.vapi.bindings.client.AsyncCallback<ProtectionGroupInfo> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get the detailed information regarding the specified protection group.

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:
Information about the specified protection group.

Operation Errors:
Error - If there is unknown internal error.
NotFound - If no cluster associated with cluster or protection group associated with pg is found in the system.
InvalidArgument - If any input is invalid.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group. The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

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

invocationConfig - Configuration for the method invocation.

update_Task

java.lang.String update_Task(java.lang.String cluster,
                             java.lang.String pg,
                             ProtectionGroupUpdateSpec spec)

Update a protection group for the given cluster.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

spec - specification for updting the protection group.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.

InvalidArgument - If validation of the spec fails.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

Unsupported - If the specified protection group is locked.

update_Task

java.lang.String update_Task(java.lang.String cluster,
                             java.lang.String pg,
                             ProtectionGroupUpdateSpec spec,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update a protection group for the given cluster.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

spec - specification for updting the protection group.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.

InvalidArgument - If validation of the spec fails.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

Unsupported - If the specified protection group is locked.

update_Task

void update_Task(java.lang.String cluster,
                 java.lang.String pg,
                 ProtectionGroupUpdateSpec spec,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Update a protection group for the given cluster.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.
InvalidArgument - If validation of the spec fails.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.
Unsupported - If the specified protection group is locked.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

spec - specification for updting the protection group.

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

update_Task

void update_Task(java.lang.String cluster,
                 java.lang.String pg,
                 ProtectionGroupUpdateSpec spec,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update a protection group for the given cluster.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.
InvalidArgument - If validation of the spec fails.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.
Unsupported - If the specified protection group is locked.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

spec - specification for updting the protection group.

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

invocationConfig - Configuration for the method invocation.

pause_Task

java.lang.String pause_Task(java.lang.String cluster,
                            java.lang.String pg)

Pause the specified proteciton group. This action pauses all periodic snapshot operations and deletion of expired snapshots. Any ongoing snapshot creation or deletion operations will not be paused.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error.

AlreadyInDesiredState - If the protection group is already paused.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

Unsupported - If the specified protection group is locked.

pause_Task

java.lang.String pause_Task(java.lang.String cluster,
                            java.lang.String pg,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Pause the specified proteciton group. This action pauses all periodic snapshot operations and deletion of expired snapshots. Any ongoing snapshot creation or deletion operations will not be paused.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error.

AlreadyInDesiredState - If the protection group is already paused.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

Unsupported - If the specified protection group is locked.

pause_Task

void pause_Task(java.lang.String cluster,
                java.lang.String pg,
                com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Pause the specified proteciton group. This action pauses all periodic snapshot operations and deletion of expired snapshots. Any ongoing snapshot creation or deletion operations will not be paused.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error.
AlreadyInDesiredState - If the protection group is already paused.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.
Unsupported - If the specified protection group is locked.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

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

pause_Task

void pause_Task(java.lang.String cluster,
                java.lang.String pg,
                com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Pause the specified proteciton group. This action pauses all periodic snapshot operations and deletion of expired snapshots. Any ongoing snapshot creation or deletion operations will not be paused.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error.
AlreadyInDesiredState - If the protection group is already paused.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.
Unsupported - If the specified protection group is locked.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

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

invocationConfig - Configuration for the method invocation.

resume_Task

java.lang.String resume_Task(java.lang.String cluster,
                             java.lang.String pg)

Resume the specified proteciton group. This action resumes all periodic snapshot operations and deletion of expired snapshots.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error.

AlreadyInDesiredState - If the protection group is already active.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

Unsupported - If the specified protection group is locked.

resume_Task

java.lang.String resume_Task(java.lang.String cluster,
                             java.lang.String pg,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Resume the specified proteciton group. This action resumes all periodic snapshot operations and deletion of expired snapshots.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error.

AlreadyInDesiredState - If the protection group is already active.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

Unsupported - If the specified protection group is locked.

resume_Task

void resume_Task(java.lang.String cluster,
                 java.lang.String pg,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Resume the specified proteciton group. This action resumes all periodic snapshot operations and deletion of expired snapshots.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error.
AlreadyInDesiredState - If the protection group is already active.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.
Unsupported - If the specified protection group is locked.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

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

resume_Task

void resume_Task(java.lang.String cluster,
                 java.lang.String pg,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Resume the specified proteciton group. This action resumes all periodic snapshot operations and deletion of expired snapshots.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error.
AlreadyInDesiredState - If the protection group is already active.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If there is no cluster associated with cluster or protection group associated with pg in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.
Unsupported - If the specified protection group is locked.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

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

invocationConfig - Configuration for the method invocation.

delete_Task

java.lang.String delete_Task(java.lang.String cluster,
                             java.lang.String pg,
                             ProtectionGroupsTypes.DeleteSpec spec)

Delete the specified protection group. Default bahaviour:

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group. The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

spec - Specifies the additional parameters for the delete operation. If null, protection group status is set to marked as deleted and will be be deleted permanently once all its associated snapshots are deleted.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If no cluster associated with cluster or protection group associated with pg is found in the system.

ServiceUnavailable - If the service is not available.

InvalidArgument - If validation of the spec fails.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

Unsupported - If the specified protection group is locked.

delete_Task

java.lang.String delete_Task(java.lang.String cluster,
                             java.lang.String pg,
                             ProtectionGroupsTypes.DeleteSpec spec,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete the specified protection group. Default bahaviour:

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group. The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

spec - Specifies the additional parameters for the delete operation. If null, protection group status is set to marked as deleted and will be be deleted permanently once all its associated snapshots are deleted.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is unknown internal error.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If no cluster associated with cluster or protection group associated with pg is found in the system.

ServiceUnavailable - If the service is not available.

InvalidArgument - If validation of the spec fails.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller is not authorized to perform the operation.

Unsupported - If the specified protection group is locked.

delete_Task

void delete_Task(java.lang.String cluster,
                 java.lang.String pg,
                 ProtectionGroupsTypes.DeleteSpec spec,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Delete the specified protection group. Default bahaviour:

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If no cluster associated with cluster or protection group associated with pg is found in the system.
ServiceUnavailable - If the service is not available.
InvalidArgument - If validation of the spec fails.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.
Unsupported - If the specified protection group is locked.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group. The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

spec - Specifies the additional parameters for the delete operation. If null, protection group status is set to marked as deleted and will be be deleted permanently once all its associated snapshots are deleted.

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

delete_Task

void delete_Task(java.lang.String cluster,
                 java.lang.String pg,
                 ProtectionGroupsTypes.DeleteSpec spec,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete the specified protection group. Default bahaviour:

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If no cluster associated with cluster or protection group associated with pg is found in the system.
ServiceUnavailable - If the service is not available.
InvalidArgument - If validation of the spec fails.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized to perform the operation.
Unsupported - If the specified protection group is locked.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

pg - Identifier of the protection group. The parameter must be an identifier for the resource type: com.vmware.snapservice.protection_group.

spec - Specifies the additional parameters for the delete operation. If null, protection group status is set to marked as deleted and will be be deleted permanently once all its associated snapshots are deleted.

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

invocationConfig - Configuration for the method invocation.