# NetApp V1 API - Class Google::Cloud::NetApp::V1::Replication (v2.11.0)

2.11.0 (latest) 2.10.0 2.9.0 2.8.0 2.7.0 2.6.1 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.2 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.1 1.0.0 0.6.0 0.5.2 0.4.2 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the NetApp V1 API class Google::Cloud::NetApp::V1::Replication.

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

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #cluster_location

    def cluster_location() -> ::String

**Returns**

- (::String) --- Optional. Location of the user cluster.

### #cluster_location=

    def cluster_location=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Location of the user cluster.
**Returns**

- (::String) --- Optional. Location of the user cluster.

### #create_time

    def create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Protobuf-Timestamp)) --- Output only. Replication create time.

### #description

    def description() -> ::String

**Returns**

- (::String) --- A description about this replication relationship.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- A description about this replication relationship.
**Returns**

- (::String) --- A description about this replication relationship.

### #destination_volume

    def destination_volume() -> ::String

**Returns**

- (::String) --- Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"

### #destination_volume_parameters

    def destination_volume_parameters() -> ::Google::Cloud::NetApp::V1::DestinationVolumeParameters

**Returns**

- ([::Google::Cloud::NetApp::V1::DestinationVolumeParameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-DestinationVolumeParameters)) --- Required. Input only. Destination volume parameters

### #destination_volume_parameters=

    def destination_volume_parameters=(value) -> ::Google::Cloud::NetApp::V1::DestinationVolumeParameters

**Parameter**

- **value** ([::Google::Cloud::NetApp::V1::DestinationVolumeParameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-DestinationVolumeParameters)) --- Required. Input only. Destination volume parameters
**Returns**

- ([::Google::Cloud::NetApp::V1::DestinationVolumeParameters](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-DestinationVolumeParameters)) --- Required. Input only. Destination volume parameters

### #healthy

    def healthy() -> ::Boolean

**Returns**

- (::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.

### #hybrid_peering_details

    def hybrid_peering_details() -> ::Google::Cloud::NetApp::V1::HybridPeeringDetails

**Returns**

- ([::Google::Cloud::NetApp::V1::HybridPeeringDetails](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-HybridPeeringDetails)) --- Output only. Hybrid peering details.

### #hybrid_replication_type

    def hybrid_replication_type() -> ::Google::Cloud::NetApp::V1::Replication::HybridReplicationType

**Returns**

- ([::Google::Cloud::NetApp::V1::Replication::HybridReplicationType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-Replication-HybridReplicationType)) --- Output only. Type of the hybrid replication.

### #hybrid_replication_user_commands

    def hybrid_replication_user_commands() -> ::Google::Cloud::NetApp::V1::UserCommands

**Returns**

- ([::Google::Cloud::NetApp::V1::UserCommands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-UserCommands)) --- Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer.

### #labels

    def labels() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Resource labels to represent user provided metadata.

### #labels=

    def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::String}) --- Resource labels to represent user provided metadata.
**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Resource labels to represent user provided metadata.

### #mirror_state

    def mirror_state() -> ::Google::Cloud::NetApp::V1::Replication::MirrorState

**Returns**

- ([::Google::Cloud::NetApp::V1::Replication::MirrorState](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-Replication-MirrorState)) --- Output only. Indicates the state of mirroring.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
**Returns**

- (::String) --- Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.

### #replication_schedule

    def replication_schedule() -> ::Google::Cloud::NetApp::V1::Replication::ReplicationSchedule

**Returns**

- ([::Google::Cloud::NetApp::V1::Replication::ReplicationSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-Replication-ReplicationSchedule)) --- Required. Indicates the schedule for replication.

### #replication_schedule=

    def replication_schedule=(value) -> ::Google::Cloud::NetApp::V1::Replication::ReplicationSchedule

**Parameter**

- **value** ([::Google::Cloud::NetApp::V1::Replication::ReplicationSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-Replication-ReplicationSchedule)) --- Required. Indicates the schedule for replication.
**Returns**

- ([::Google::Cloud::NetApp::V1::Replication::ReplicationSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-Replication-ReplicationSchedule)) --- Required. Indicates the schedule for replication.

### #role

    def role() -> ::Google::Cloud::NetApp::V1::Replication::ReplicationRole

**Returns**

- ([::Google::Cloud::NetApp::V1::Replication::ReplicationRole](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-Replication-ReplicationRole)) --- Output only. Indicates whether this points to source or destination.

### #source_volume

    def source_volume() -> ::String

**Returns**

- (::String) --- Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"

### #state

    def state() -> ::Google::Cloud::NetApp::V1::Replication::State

**Returns**

- ([::Google::Cloud::NetApp::V1::Replication::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-Replication-State)) --- Output only. State of the replication.

### #state_details

    def state_details() -> ::String

**Returns**

- (::String) --- Output only. State details of the replication.

### #transfer_stats

    def transfer_stats() -> ::Google::Cloud::NetApp::V1::TransferStats

**Returns**

- ([::Google::Cloud::NetApp::V1::TransferStats](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-TransferStats)) --- Output only. Replication transfer statistics.