com.solidfire.element.api

Class ModifyGroupSnapshotRequest

java.lang.Object

com.solidfire.element.api.ModifyGroupSnapshotRequest

All Implemented Interfaces:

java.io.Serializable

public class ModifyGroupSnapshotRequest
extends java.lang.Object
implements java.io.Serializable

ModifyGroupSnapshotRequest ModifyGroupSnapshot enables you to change the attributes of a group of snapshots. You can also use this method to enable snapshots created on the Read/Write (source) volume to be remotely replicated to a target SolidFire storage system.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModifyGroupSnapshotRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ModifyGroupSnapshotRequest()
ModifyGroupSnapshotRequest(java.lang.Long groupSnapshotID, Optional<java.lang.String> expirationTime, Optional<java.lang.Boolean> enableRemoteReplication)
ModifyGroupSnapshotRequest(java.lang.Long groupSnapshotID, Optional<java.lang.String> expirationTime, Optional<java.lang.Boolean> enableRemoteReplication, Optional<java.lang.String> snapMirrorLabel)

Method Summary

Modifier and Type	Method and Description
ModifyGroupSnapshotRequest.Builder	asBuilder()
static ModifyGroupSnapshotRequest.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.lang.Boolean>	getEnableRemoteReplication() Replicates the snapshot created to a remote cluster.
Optional<java.lang.String>	getExpirationTime() Specify the time after which the group snapshot can be removed.
java.lang.Long	getGroupSnapshotID() Specifies the ID of the group of snapshots.
Optional<java.lang.String>	getSnapMirrorLabel() Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint.
int	hashCode()
void	setEnableRemoteReplication(Optional<java.lang.Boolean> enableRemoteReplication)
void	setExpirationTime(Optional<java.lang.String> expirationTime)
void	setGroupSnapshotID(java.lang.Long groupSnapshotID)
void	setSnapMirrorLabel(Optional<java.lang.String> snapMirrorLabel)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ModifyGroupSnapshotRequest

@Since(value="7.0")
public ModifyGroupSnapshotRequest()

ModifyGroupSnapshotRequest

@Since(value="7.0")
public ModifyGroupSnapshotRequest(java.lang.Long groupSnapshotID,
                                                      Optional<java.lang.String> expirationTime,
                                                      Optional<java.lang.Boolean> enableRemoteReplication)

ModifyGroupSnapshotRequest

@Since(value="10.0")
public ModifyGroupSnapshotRequest(java.lang.Long groupSnapshotID,
                                                       Optional<java.lang.String> expirationTime,
                                                       Optional<java.lang.Boolean> enableRemoteReplication,
                                                       Optional<java.lang.String> snapMirrorLabel)

Method Detail

getGroupSnapshotID

public java.lang.Long getGroupSnapshotID()

Specifies the ID of the group of snapshots.

setGroupSnapshotID

public void setGroupSnapshotID(java.lang.Long groupSnapshotID)

getExpirationTime

public Optional<java.lang.String> getExpirationTime()

Specify the time after which the group snapshot can be removed. If neither 'expirationTime' nor 'retention' is specified for the original group snapshot, the snapshot will be retained until manually deleted. The format is: ISO 8601 date string for time based expiration, otherwise it will not expire. 'null', or not specified, the snapshot is to be retained permanently. 'fifo' causes the snapshot to be preserved on a First-In-First-Out basis, relative to other FIFO snapshots on the volume. The API will fail if no FIFO space is available. Note: The 'retention' option is not supported by ModifyGroupSnapshot.

setExpirationTime

public void setExpirationTime(Optional<java.lang.String> expirationTime)

getEnableRemoteReplication

public Optional<java.lang.Boolean> getEnableRemoteReplication()

Replicates the snapshot created to a remote cluster. Possible values are: true: The snapshot is replicated to remote storage. false: Default. The snapshot is not replicated.

setEnableRemoteReplication

public void setEnableRemoteReplication(Optional<java.lang.Boolean> enableRemoteReplication)

getSnapMirrorLabel

public Optional<java.lang.String> getSnapMirrorLabel()

Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint.

setSnapMirrorLabel

public void setSnapMirrorLabel(Optional<java.lang.String> snapMirrorLabel)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static ModifyGroupSnapshotRequest.Builder builder()

asBuilder

public final ModifyGroupSnapshotRequest.Builder asBuilder()