REST Resource: projects.locations.volumes.replications

Resource: Replication

Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.

JSON representation 
{
  "name": string,
  "state": enum (State),
  "stateDetails": string,
  "role": enum (ReplicationRole),
  "replicationSchedule": enum (ReplicationSchedule),
  "mirrorState": enum (MirrorState),
  "createTime": string,
  "destinationVolume": string,
  "transferStats": {
    object (TransferStats)
  },
  "labels": {
    string: string,
    ...
  },
  "destinationVolumeParameters": {
    object (DestinationVolumeParameters)
  },
  "sourceVolume": string,
  "healthy": boolean,
  "description": string
}
Fields
name

string

Identifier. The resource name of the Replication. Format: projects/{projectId}/locations/{location}/volumes/{volumeId}/replications/{replicationId}.
state

enum (State)

Output only. State of the replication.
stateDetails

string

Output only. State details of the replication.
role

enum (ReplicationRole)

Output only. Indicates whether this points to source or destination.
replicationSchedule

enum (ReplicationSchedule)

Required. Indicates the schedule for replication.
mirrorState

enum (MirrorState)

Output only. Indicates the state of mirroring.
createTime

string (Timestamp format)

Output only. Replication create time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
destinationVolume

string

Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volumeId}"
transferStats

object (TransferStats)

Output only. Replication transfer statistics.
labels

map (key: string, value: string)

Resource labels to represent user provided metadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
destinationVolumeParameters

object (DestinationVolumeParameters)

Required. Input only. Destination volume parameters
sourceVolume

string

Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volumeId}"
healthy

boolean

Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
description

string

A description about this replication relationship.

State

The replication states New enum values may be added in future to indicate possible new states.

Enums
STATE_UNSPECIFIED Unspecified replication State
CREATING Replication is creating.
READY Replication is ready.
UPDATING Replication is updating.
DELETING Replication is deleting.
ERROR Replication is in error state.

ReplicationRole

New enum values may be added in future to support different replication topology.

Enums
REPLICATION_ROLE_UNSPECIFIED Unspecified replication role
SOURCE Indicates Source volume.
DESTINATION Indicates Destination volume.

ReplicationSchedule

Schedule for Replication. New enum values may be added in future to support different frequency of replication.

Enums
REPLICATION_SCHEDULE_UNSPECIFIED Unspecified ReplicationSchedule
EVERY_10_MINUTES Replication happens once every 10 minutes.
HOURLY Replication happens once every hour.
DAILY Replication happens once every day.

MirrorState

Mirroring states. No new value is expected to be added in future.

Enums
MIRROR_STATE_UNSPECIFIED Unspecified MirrorState
PREPARING Destination volume is being prepared.
MIRRORED Destination volume has been initialized and is ready to receive replication transfers.
STOPPED Destination volume is not receiving replication transfers.
TRANSFERRING Replication is in progress.

TransferStats

TransferStats reports all statistics related to replication transfer.

JSON representation 
{
  "transferBytes": string,
  "totalTransferDuration": string,
  "lastTransferBytes": string,
  "lastTransferDuration": string,
  "lagDuration": string,
  "updateTime": string,
  "lastTransferEndTime": string,
  "lastTransferError": string
}
Fields
transferBytes

string (int64 format)

bytes trasferred so far in current transfer.
totalTransferDuration

string (Duration format)

Total time taken during transfer.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
lastTransferBytes

string (int64 format)

Last transfer size in bytes.
lastTransferDuration

string (Duration format)

Time taken during last transfer.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
lagDuration

string (Duration format)

Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
updateTime

string (Timestamp format)

Time when progress was updated last.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastTransferEndTime

string (Timestamp format)

Time when last transfer completed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastTransferError

string

A message describing the cause of the last transfer failure.

DestinationVolumeParameters

DestinationVolumeParameters specify input parameters used for creating destination volume.

JSON representation 
{
  "storagePool": string,
  "volumeId": string,
  "shareName": string,
  "description": string
}
Fields
storagePool

string

Required. Existing destination StoragePool name.
volumeId

string

Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
shareName

string

Destination volume's share name. If not specified, source volume's share name will be used.
description

string

Description for the destination volume.

Methods

create

 Create a new replication for a volume.

delete

 Deletes a replication.

get

 Describe a replication for a volume.

list

 Returns descriptions of all replications for a volume.

patch

 Updates the settings of a specific replication.

resume

 Resume Cross Region Replication.

reverseDirection

 Reverses direction of replication.

stop

 Stop Cross Region Replication.