Google Cloud Redis Cluster V1 Client - Class UpdateClusterRequest (0.3.0)

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

Request for UpdateCluster.

Generated from protobuf message google.cloud.redis.cluster.v1.UpdateClusterRequest

Namespace

Google \ Cloud \ Redis \ Cluster \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ update_mask Google\Protobuf\FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * size_gb * replica_count

↳ cluster Google\Cloud\Redis\Cluster\V1\Cluster

Required. Update description. Only fields specified in update_mask are updated.

↳ request_id string

Idempotent request UUID.

getUpdateMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster:

  • size_gb
  • replica_count
Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster:

  • size_gb
  • replica_count
Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getCluster

Required. Update description.

Only fields specified in update_mask are updated.

Returns
Type Description
Google\Cloud\Redis\Cluster\V1\Cluster|null

hasCluster

clearCluster

setCluster

Required. Update description.

Only fields specified in update_mask are updated.

Parameter
Name Description
var Google\Cloud\Redis\Cluster\V1\Cluster
Returns
Type Description
$this

getRequestId

Idempotent request UUID.

Returns
Type Description
string

setRequestId

Idempotent request UUID.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
cluster Google\Cloud\Redis\Cluster\V1\Cluster

Required. Update description. Only fields specified in update_mask are updated.

updateMask Google\Protobuf\FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster:

  • size_gb
  • replica_count
Returns
Type Description
Google\Cloud\Redis\Cluster\V1\UpdateClusterRequest