com.solidfire.element.api

Class SnapMirrorRelationship

java.lang.Object

com.solidfire.element.api.SnapMirrorRelationship

All Implemented Interfaces:

java.io.Serializable

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

SnapMirrorRelationship The snapMirrorRelationship object contains information about a SnapMirror relationship between a SolidFire volume and an ONTAP volume.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnapMirrorRelationship.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
SnapMirrorRelationship()
SnapMirrorRelationship(java.lang.Long snapMirrorEndpointID, java.lang.String clusterName, java.lang.String snapMirrorRelationshipID, SnapMirrorVolumeInfo sourceVolume, SnapMirrorVolumeInfo destinationVolume, java.lang.Long currentMaxTransferRate, java.lang.Boolean isHealthy, java.lang.Long lagtime, java.lang.Long lastTransferDuration, java.lang.String lastTransferError, java.lang.Long lastTransferSize, java.lang.String lastTransferEndTimestamp, java.lang.String lastTransferType, java.lang.Long maxTransferRate, java.lang.String mirrorState, java.lang.String newestSnapshot, java.lang.String policyName, java.lang.String policyType, java.lang.String relationshipStatus, java.lang.String releationshipType, java.lang.String scheduleName, java.lang.String unhealthyReason)

Method Summary

Modifier and Type	Method and Description
SnapMirrorRelationship.Builder	asBuilder()
static SnapMirrorRelationship.Builder	builder()
boolean	equals(java.lang.Object o)
java.lang.String	getClusterName() The name of the destination ONTAP cluster.
java.lang.Long	getCurrentMaxTransferRate() The current maximum transfer rate between the source and destination volumes, in kilobytes per second.
SnapMirrorVolumeInfo	getDestinationVolume() An object describing the destination volume.
java.lang.Boolean	getIsHealthy() Whether the relationship is healthy or not.
java.lang.Long	getLagtime() The amount of time in seconds by which the data on the destination volume lags behind the data on the source volume.
java.lang.Long	getLastTransferDuration() The amount of time in seconds it took for the last transfer to complete.
java.lang.String	getLastTransferEndTimestamp() The timestamp of the end of the last transfer.
java.lang.String	getLastTransferError() A message describing the cause of the last transfer failure.
java.lang.Long	getLastTransferSize() The total number of bytes transferred during the last transfer.
java.lang.String	getLastTransferType() The type of the previous transfer in the relationship.
java.lang.Long	getMaxTransferRate() Specifies the maximum data transfer rate between the volumes in kilobytes per second.
java.lang.String	getMirrorState() The mirror state of the SnapMirror relationship.
java.lang.String	getNewestSnapshot() The name of the newest Snapshot copy on the destination volume.
java.lang.String	getPolicyName() Specifies the name of the ONTAP SnapMirror policy for the relationship.
java.lang.String	getPolicyType() The type of the ONTAP SnapMirror policy for the relationship.
java.lang.String	getRelationshipStatus() The status of the SnapMirror relationship.
java.lang.String	getReleationshipType() The type of the SnapMirror relationship.
java.lang.String	getScheduleName() The name of the pre-existing cron schedule on the ONTAP system that is used to update the SnapMirror relationship.
java.lang.Long	getSnapMirrorEndpointID() The ID of the destination ONTAP system.
java.lang.String	getSnapMirrorRelationshipID() The unique identifier for each snapMirrorRelationship object in an array as would be returned in ListSnapMirrorRelationships.
SnapMirrorVolumeInfo	getSourceVolume() An object describing the source volume.
java.lang.String	getUnhealthyReason() The reason the relationship is not healthy.
int	hashCode()
void	setClusterName(java.lang.String clusterName)
void	setCurrentMaxTransferRate(java.lang.Long currentMaxTransferRate)
void	setDestinationVolume(SnapMirrorVolumeInfo destinationVolume)
void	setIsHealthy(java.lang.Boolean isHealthy)
void	setLagtime(java.lang.Long lagtime)
void	setLastTransferDuration(java.lang.Long lastTransferDuration)
void	setLastTransferEndTimestamp(java.lang.String lastTransferEndTimestamp)
void	setLastTransferError(java.lang.String lastTransferError)
void	setLastTransferSize(java.lang.Long lastTransferSize)
void	setLastTransferType(java.lang.String lastTransferType)
void	setMaxTransferRate(java.lang.Long maxTransferRate)
void	setMirrorState(java.lang.String mirrorState)
void	setNewestSnapshot(java.lang.String newestSnapshot)
void	setPolicyName(java.lang.String policyName)
void	setPolicyType(java.lang.String policyType)
void	setRelationshipStatus(java.lang.String relationshipStatus)
void	setReleationshipType(java.lang.String releationshipType)
void	setScheduleName(java.lang.String scheduleName)
void	setSnapMirrorEndpointID(java.lang.Long snapMirrorEndpointID)
void	setSnapMirrorRelationshipID(java.lang.String snapMirrorRelationshipID)
void	setSourceVolume(SnapMirrorVolumeInfo sourceVolume)
void	setUnhealthyReason(java.lang.String unhealthyReason)
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

SnapMirrorRelationship

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

SnapMirrorRelationship

@Since(value="10.0")
public SnapMirrorRelationship(java.lang.Long snapMirrorEndpointID,
                                                   java.lang.String clusterName,
                                                   java.lang.String snapMirrorRelationshipID,
                                                   SnapMirrorVolumeInfo sourceVolume,
                                                   SnapMirrorVolumeInfo destinationVolume,
                                                   java.lang.Long currentMaxTransferRate,
                                                   java.lang.Boolean isHealthy,
                                                   java.lang.Long lagtime,
                                                   java.lang.Long lastTransferDuration,
                                                   java.lang.String lastTransferError,
                                                   java.lang.Long lastTransferSize,
                                                   java.lang.String lastTransferEndTimestamp,
                                                   java.lang.String lastTransferType,
                                                   java.lang.Long maxTransferRate,
                                                   java.lang.String mirrorState,
                                                   java.lang.String newestSnapshot,
                                                   java.lang.String policyName,
                                                   java.lang.String policyType,
                                                   java.lang.String relationshipStatus,
                                                   java.lang.String releationshipType,
                                                   java.lang.String scheduleName,
                                                   java.lang.String unhealthyReason)

Method Detail

getSnapMirrorEndpointID

public java.lang.Long getSnapMirrorEndpointID()

The ID of the destination ONTAP system.

setSnapMirrorEndpointID

public void setSnapMirrorEndpointID(java.lang.Long snapMirrorEndpointID)

getClusterName

public java.lang.String getClusterName()

The name of the destination ONTAP cluster.

setClusterName

public void setClusterName(java.lang.String clusterName)

getSnapMirrorRelationshipID

public java.lang.String getSnapMirrorRelationshipID()

The unique identifier for each snapMirrorRelationship object in an array as would be returned in ListSnapMirrorRelationships. This UUID is created and returned from the ONTAP system.

setSnapMirrorRelationshipID

public void setSnapMirrorRelationshipID(java.lang.String snapMirrorRelationshipID)

getSourceVolume

public SnapMirrorVolumeInfo getSourceVolume()

An object describing the source volume.

setSourceVolume

public void setSourceVolume(SnapMirrorVolumeInfo sourceVolume)

getDestinationVolume

public SnapMirrorVolumeInfo getDestinationVolume()

An object describing the destination volume.

setDestinationVolume

public void setDestinationVolume(SnapMirrorVolumeInfo destinationVolume)

getCurrentMaxTransferRate

public java.lang.Long getCurrentMaxTransferRate()

The current maximum transfer rate between the source and destination volumes, in kilobytes per second.

setCurrentMaxTransferRate

public void setCurrentMaxTransferRate(java.lang.Long currentMaxTransferRate)

getIsHealthy

public java.lang.Boolean getIsHealthy()

Whether the relationship is healthy or not. Possible values: true: The relationship is healthy. false: The relationship is not healthy. This can be caused by a manual or scheduled update failing or being aborted, or by the last scheduled update being delayed.

setIsHealthy

public void setIsHealthy(java.lang.Boolean isHealthy)

getLagtime

public java.lang.Long getLagtime()

The amount of time in seconds by which the data on the destination volume lags behind the data on the source volume.

setLagtime

public void setLagtime(java.lang.Long lagtime)

getLastTransferDuration

public java.lang.Long getLastTransferDuration()

The amount of time in seconds it took for the last transfer to complete.

setLastTransferDuration

public void setLastTransferDuration(java.lang.Long lastTransferDuration)

getLastTransferError

public java.lang.String getLastTransferError()

A message describing the cause of the last transfer failure.

setLastTransferError

public void setLastTransferError(java.lang.String lastTransferError)

getLastTransferSize

public java.lang.Long getLastTransferSize()

The total number of bytes transferred during the last transfer.

setLastTransferSize

public void setLastTransferSize(java.lang.Long lastTransferSize)

getLastTransferEndTimestamp

public java.lang.String getLastTransferEndTimestamp()

The timestamp of the end of the last transfer.

setLastTransferEndTimestamp

public void setLastTransferEndTimestamp(java.lang.String lastTransferEndTimestamp)

getLastTransferType

public java.lang.String getLastTransferType()

The type of the previous transfer in the relationship.

setLastTransferType

public void setLastTransferType(java.lang.String lastTransferType)

getMaxTransferRate

public java.lang.Long getMaxTransferRate()

Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth.

setMaxTransferRate

public void setMaxTransferRate(java.lang.Long maxTransferRate)

getMirrorState

public java.lang.String getMirrorState()

The mirror state of the SnapMirror relationship. Possible values: uninitialized: The destination volume has not been initialized. snapmirrored: The destination volume has been initialized and is ready to recieve SnapMirror updates. broken-off: The destination volume is read-write and snapshots are present.

setMirrorState

public void setMirrorState(java.lang.String mirrorState)

getNewestSnapshot

public java.lang.String getNewestSnapshot()

The name of the newest Snapshot copy on the destination volume.

setNewestSnapshot

public void setNewestSnapshot(java.lang.String newestSnapshot)

getPolicyName

public java.lang.String getPolicyName()

Specifies the name of the ONTAP SnapMirror policy for the relationship. A list of available policies can be retrieved with ListSnapMirrorPolicies. Example values are "MirrorLatest" and "MirrorAndVault".

setPolicyName

public void setPolicyName(java.lang.String policyName)

getPolicyType

public java.lang.String getPolicyType()

The type of the ONTAP SnapMirror policy for the relationship. See ListSnapMirrorPolicies. Examples are: "async_mirror" or "mirror_vault"

setPolicyType

public void setPolicyType(java.lang.String policyType)

getRelationshipStatus

public java.lang.String getRelationshipStatus()

The status of the SnapMirror relationship. Possible values: idle transferring checking quiescing quiesced queued preparing finalizing aborting breaking

setRelationshipStatus

public void setRelationshipStatus(java.lang.String relationshipStatus)

getReleationshipType

public java.lang.String getReleationshipType()

The type of the SnapMirror relationship. On SolidFire systems, this value is always "extended_data_protection".

setReleationshipType

public void setReleationshipType(java.lang.String releationshipType)

getScheduleName

public java.lang.String getScheduleName()

The name of the pre-existing cron schedule on the ONTAP system that is used to update the SnapMirror relationship. A list of available schedules can be retrieved with ListSnapMirrorSchedules.

setScheduleName

public void setScheduleName(java.lang.String scheduleName)

getUnhealthyReason

public java.lang.String getUnhealthyReason()

The reason the relationship is not healthy.

setUnhealthyReason

public void setUnhealthyReason(java.lang.String unhealthyReason)

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 SnapMirrorRelationship.Builder builder()

asBuilder

public final SnapMirrorRelationship.Builder asBuilder()