com.vmware.snapservice.clusters.virtual_machines

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.virtual_machines.SnapshotsTypes

SnapshotsTypes.FilterSpec, SnapshotsTypes.Info, SnapshotsTypes.ListItem, SnapshotsTypes.ListResult, SnapshotsTypes.Type

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
SnapshotsTypes.Info	get(java.lang.String cluster, java.lang.String vm, java.lang.String snapshot) Get the detailed information regarding the specified virtual machine snapshot.
void	get(java.lang.String cluster, java.lang.String vm, java.lang.String snapshot, com.vmware.vapi.bindings.client.AsyncCallback<SnapshotsTypes.Info> asyncCallback) Get the detailed information regarding the specified virtual machine snapshot.
void	get(java.lang.String cluster, java.lang.String vm, 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 virtual machine snapshot.
SnapshotsTypes.Info	get(java.lang.String cluster, java.lang.String vm, java.lang.String snapshot, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the detailed information regarding the specified virtual machine snapshot.
SnapshotsTypes.ListResult	list(java.lang.String cluster, java.lang.String vm, SnapshotsTypes.FilterSpec filter) List the snapshots for the given virtual machine.
void	list(java.lang.String cluster, java.lang.String vm, SnapshotsTypes.FilterSpec filter, com.vmware.vapi.bindings.client.AsyncCallback<SnapshotsTypes.ListResult> asyncCallback) List the snapshots for the given virtual machine.
void	list(java.lang.String cluster, java.lang.String vm, 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 virtual machine.
SnapshotsTypes.ListResult	list(java.lang.String cluster, java.lang.String vm, SnapshotsTypes.FilterSpec filter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List the snapshots for the given virtual machine.

Method Detail

list

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

List the snapshots for the given virtual machine.

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.

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

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 virtual machine snapshots match the filter.

Returns:

Information about the snapshots matching the SnapshotsTypes.FilterSpec for the specified virtual machine.

Throws:

Error - If there is unknown internal error.

NotFound - If there is no cluster associated with cluster or no or no virtual machine associated with vmin 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 vm,
                               SnapshotsTypes.FilterSpec filter,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List the snapshots for the given virtual machine.

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.

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

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 virtual machine snapshots match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the snapshots matching the SnapshotsTypes.FilterSpec for the specified virtual machine.

Throws:

Error - If there is unknown internal error.

NotFound - If there is no cluster associated with cluster or no or no virtual machine associated with vmin 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 vm,
          SnapshotsTypes.FilterSpec filter,
          com.vmware.vapi.bindings.client.AsyncCallback<SnapshotsTypes.ListResult> asyncCallback)

List the snapshots for the given virtual machine.

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

Invocation Result:
Information about the snapshots matching the SnapshotsTypes.FilterSpec for the specified virtual machine.

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

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

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 virtual machine snapshots match the filter.

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

list

void list(java.lang.String cluster,
          java.lang.String vm,
          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 virtual machine.

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 SnapshotsTypes.FilterSpec for the specified virtual machine.

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

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

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 virtual machine snapshots match the filter.

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 vm,
                        java.lang.String snapshot)

Get the detailed information regarding the specified virtual machine 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.

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

snapshot - Identifier of the virtual machine snapshot. The parameter must be an identifier for the resource type: com.vmware.snapservice.vm.snapshot.

Returns:

Information about the virtual mahcine snapshot.

Throws:

Error - If there is unknown internal error.

NotFound - If no cluster associated with cluster or no virtual machine associated with vm 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 vm,
                        java.lang.String snapshot,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get the detailed information regarding the specified virtual machine 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.

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

snapshot - Identifier of the virtual machine snapshot. The parameter must be an identifier for the resource type: com.vmware.snapservice.vm.snapshot.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the virtual mahcine snapshot.

Throws:

Error - If there is unknown internal error.

NotFound - If no cluster associated with cluster or no virtual machine associated with vm 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 vm,
         java.lang.String snapshot,
         com.vmware.vapi.bindings.client.AsyncCallback<SnapshotsTypes.Info> asyncCallback)

Get the detailed information regarding the specified virtual machine snapshot.

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

Invocation Result:
Information about the virtual mahcine snapshot.

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

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

snapshot - Identifier of the virtual machine snapshot. The parameter must be an identifier for the resource type: com.vmware.snapservice.vm.snapshot.

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

get

void get(java.lang.String cluster,
         java.lang.String vm,
         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 virtual machine 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 virtual mahcine snapshot.

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

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

snapshot - Identifier of the virtual machine snapshot. The parameter must be an identifier for the resource type: com.vmware.snapservice.vm.snapshot.

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

invocationConfig - Configuration for the method invocation.