Google Cloud Net App V1 Client - Class StopReplicationRequest (0.1.1)

Reference documentation and code samples for the Google Cloud Net App V1 Client class StopReplicationRequest.

StopReplicationRequest stops a replication until resumed.

Generated from protobuf message google.cloud.netapp.v1.StopReplicationRequest

Namespace

Google \ Cloud \ NetApp \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.
`↳ force`	`bool` Indicates whether to stop replication forcefully while data transfer is in progress. Warning! if force is true, this will abort any current transfers and can lead to data loss due to partial transfer. If force is false, stop replication will fail while data transfer is in progress and you will need to retry later.

getName

Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.

Returns
Type	Description
`string`

setName

Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getForce

Indicates whether to stop replication forcefully while data transfer is in progress.

Warning! if force is true, this will abort any current transfers and can lead to data loss due to partial transfer. If force is false, stop replication will fail while data transfer is in progress and you will need to retry later.

Returns
Type	Description
`bool`

setForce

Indicates whether to stop replication forcefully while data transfer is in progress.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`