Google Cloud Redis V1 Client - Class FailoverInstanceRequest (2.1.0)

Reference documentation and code samples for the Google Cloud Redis V1 Client class FailoverInstanceRequest.

Request for Failover.

Generated from protobuf message google.cloud.redis.v1.FailoverInstanceRequest

Namespace

Google \ Cloud \ Redis \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

↳ data_protection_mode int

Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

getName

Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

Returns
Type Description
string

setName

Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

Parameter
Name Description
var string
Returns
Type Description
$this

getDataProtectionMode

Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

Returns
Type Description
int

setDataProtectionMode

Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region. Please see Google\Cloud\Redis\V1\CloudRedisClient::instanceName() for help formatting this field.

dataProtectionMode int

Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default. For allowed values, use constants defined on Google\Cloud\Redis\V1\FailoverInstanceRequest\DataProtectionMode

Returns
Type Description
Google\Cloud\Redis\V1\FailoverInstanceRequest