- Resource: Replication
- State
- ReplicationRole
- ReplicationSchedule
- MirrorState
- TransferStats
- DestinationVolumeParameters
- Methods
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 ( |
Fields | |
---|---|
name |
Identifier. The resource name of the Replication. Format: |
state |
Output only. State of the replication. |
stateDetails |
Output only. State details of the replication. |
role |
Output only. Indicates whether this points to source or destination. |
replicationSchedule |
Required. Indicates the schedule for replication. |
mirrorState |
Output only. Indicates the state of mirroring. |
createTime |
Output only. Replication create time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
destinationVolume |
Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volumeId}" |
transferStats |
Output only. Replication transfer statistics. |
labels |
Resource labels to represent user provided metadata. An object containing a list of |
destinationVolumeParameters |
Required. Input only. Destination volume parameters |
sourceVolume |
Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volumeId}" |
healthy |
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 |
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 |
Incremental 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 |
Cumulative bytes trasferred so far for the replication relatinonship. |
totalTransferDuration |
Cumulative time taken across all transfers for the replication relationship. A duration in seconds with up to nine fractional digits, ending with ' |
lastTransferBytes |
Last transfer size in bytes. |
lastTransferDuration |
Time taken during last transfer. A duration in seconds with up to nine fractional digits, ending with ' |
lagDuration |
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 ' |
updateTime |
Time when progress was updated last. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
lastTransferEndTime |
Time when last transfer completed. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
lastTransferError |
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 |
Required. Existing destination StoragePool name. |
volumeId |
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 |
Destination volume's share name. If not specified, source volume's share name will be used. |
description |
Description for the destination volume. |
Methods |
|
---|---|
|
Create a new replication for a volume. |
|
Deletes a replication. |
|
Describe a replication for a volume. |
|
Returns descriptions of all replications for a volume. |
|
Updates the settings of a specific replication. |
|
Resume Cross Region Replication. |
|
Reverses direction of replication. |
|
Stop Cross Region Replication. |