com.vmware.snapservice.clusters.protection_groups

Interface Snapshots

All Superinterfaces:

com.vmware.vapi.bindings.Service, SnapshotsTypes

All Known Implementing Classes:

SnapshotsStub

public interface Snapshots
extends com.vmware.vapi.bindings.Service, SnapshotsTypes

The Snapshots interface provides methods to manage snapshots for a protection group.

Nested Class Summary

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

SnapshotsTypes._VAPI_OPERATIONS, SnapshotsTypes.CreateResult, SnapshotsTypes.CreateSpec, SnapshotsTypes.FilterSpec, SnapshotsTypes.Info, SnapshotsTypes.ListItem, SnapshotsTypes.ListResult, SnapshotsTypes.Type, SnapshotsTypes.VmSnapshotSummary

Field Summary

Fields inherited from interface com.vmware.snapservice.clusters.protection_groups.SnapshotsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create_Task(java.lang.String cluster, java.lang.String pg, SnapshotsTypes.CreateSpec spec) Create a snapshot for the given protection group.
void	create_Task(java.lang.String cluster, java.lang.String pg, SnapshotsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Create a snapshot for the given protection group.
void	create_Task(java.lang.String cluster, java.lang.String pg, SnapshotsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a snapshot for the given protection group.
java.lang.String	create_Task(java.lang.String cluster, java.lang.String pg, SnapshotsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a snapshot for the given protection group.
void	delete(java.lang.String cluster, java.lang.String pg, java.lang.String snapshot) Delete the specified protection group snapshot.
void	delete(java.lang.String cluster, java.lang.String pg, java.lang.String snapshot, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete the specified protection group snapshot.
void	delete(java.lang.String cluster, java.lang.String pg, java.lang.String snapshot, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete the specified protection group snapshot.
void	delete(java.lang.String cluster, java.lang.String pg, java.lang.String snapshot, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete the specified protection group snapshot.
SnapshotsTypes.Info	get(java.lang.String cluster, java.lang.String pg, java.lang.String snapshot) Get the detailed information regarding the specified protection group snapshot.
void	get(java.lang.String cluster, java.lang.String pg, java.lang.String snapshot, com.vmware.vapi.bindings.client.AsyncCallback<SnapshotsTypes.Info> asyncCallback) Get the detailed information regarding the specified protection group snapshot.
void	get(java.lang.String cluster, java.lang.String pg, java.lang.String snapshot, com.vmware.vapi.bindings.client.AsyncCallback<SnapshotsTypes.Info> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the detailed information regarding the specified protection group snapshot.
SnapshotsTypes.Info	get(java.lang.String cluster, java.lang.String pg, java.lang.String snapshot, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the detailed information regarding the specified protection group snapshot.
SnapshotsTypes.ListResult	list(java.lang.String cluster, java.lang.String pg, SnapshotsTypes.FilterSpec filter) List the snapshots for the given protection group.
void	list(java.lang.String cluster, java.lang.String pg, SnapshotsTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<SnapshotsTypes.ListResult> asyncCallback) List the snapshots for the given protection group.
void	list(java.lang.String cluster, java.lang.String pg, SnapshotsTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<SnapshotsTypes.ListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List the snapshots for the given protection group.
SnapshotsTypes.ListResult	list(java.lang.String cluster, java.lang.String pg, SnapshotsTypes.FilterSpec filter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List the snapshots for the given protection group.

Method Detail

create_Task

java.lang.String create_Task(java.lang.String cluster,
                             java.lang.String pg,
                             SnapshotsTypes.CreateSpec spec)

Create a snapshot for the given protection group.

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 the protection group snapshot.

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 no 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.

create_Task

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

Create a snapshot for the given protection group.

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 the protection group snapshot.

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 no 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.

create_Task

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

Create a snapshot for the given protection group.

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 no 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.

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 the protection group snapshot.

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

create_Task

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

Create a snapshot for the given protection group.

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 no 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.

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 the protection group snapshot.

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

invocationConfig - Configuration for the method invocation.

list

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

List the snapshots for the given 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.

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

Returns:

Information about the snapshots matching the

Throws:

Error - If there is unknown internal error.

NotFound - If there is no cluster associated with cluster or no or no protection group associated with pgin 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

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

List the snapshots for the given 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.

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

invocationConfig - Configuration for the method invocation.

Returns:

Information about the snapshots matching the

Throws:

Error - If there is unknown internal error.

NotFound - If there is no cluster associated with cluster or no or no protection group associated with pgin 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,
          java.lang.String pg,
          SnapshotsTypes.FilterSpec filter,
          com.vmware.vapi.bindings.client.AsyncCallback<SnapshotsTypes.ListResult> asyncCallback)

List the snapshots for the given protection group.

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

Invocation Result:
Information about the snapshots matching the

Operation Errors:
Error - If there is unknown internal error.
NotFound - If there is no cluster associated with cluster or no or no protection group associated with pgin 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.

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

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

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

list

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

List the snapshots for the given 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 snapshots matching the

Operation Errors:
Error - If there is unknown internal error.
NotFound - If there is no cluster associated with cluster or no or no protection group associated with pgin 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.

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

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

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

invocationConfig - Configuration for the method invocation.

get

SnapshotsTypes.Info get(java.lang.String cluster,
                        java.lang.String pg,
                        java.lang.String snapshot)

Get the detailed information regarding the specified protection group snapshot.

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.

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

Returns:

Information about the specified protection group snapshot.

Throws:

Error - If there is unknown internal error.

NotFound - If no cluster associated with cluster or no protection group associated with pg or no snapshot associated with snapshot is found 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.

get

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

Get the detailed information regarding the specified protection group snapshot.

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.

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

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified protection group snapshot.

Throws:

Error - If there is unknown internal error.

NotFound - If no cluster associated with cluster or no protection group associated with pg or no snapshot associated with snapshot is found 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.

get

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

Get the detailed information regarding the specified protection group snapshot.

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

Invocation Result:
Information about the specified protection group snapshot.

Operation Errors:
Error - If there is unknown internal error.
NotFound - If no cluster associated with cluster or no protection group associated with pg or no snapshot associated with snapshot is found 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.

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.

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

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

get

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

Get the detailed information regarding the specified protection group snapshot.

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 snapshot.

Operation Errors:
Error - If there is unknown internal error.
NotFound - If no cluster associated with cluster or no protection group associated with pg or no snapshot associated with snapshot is found 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.

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.

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

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String cluster,
            java.lang.String pg,
            java.lang.String snapshot)

Delete the specified protection group snapshot.

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.

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

Throws:

Error - If there is unknown internal error.

NotFound - If no cluster associated with cluster or no protection group associated with pg or no snapshot associated with snapshot is found 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.

delete

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

Delete the specified protection group snapshot.

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.

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

invocationConfig - Configuration for the method invocation.

Throws:

Error - If there is unknown internal error.

NotFound - If no cluster associated with cluster or no protection group associated with pg or no snapshot associated with snapshot is found 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.

delete

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

Delete the specified protection group snapshot.

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

Operation Errors:
Error - If there is unknown internal error.
NotFound - If no cluster associated with cluster or no protection group associated with pg or no snapshot associated with snapshot is found 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.

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.

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

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

delete

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

Delete the specified protection group snapshot.

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 unknown internal error.
NotFound - If no cluster associated with cluster or no protection group associated with pg or no snapshot associated with snapshot is found 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.

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.

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

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

invocationConfig - Configuration for the method invocation.