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

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

Request for CreateCluster.

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

Namespace

Google \ Cloud \ Redis \ Cluster \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.
↳ cluster_id string

Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location
↳ cluster Google\Cloud\Redis\Cluster\V1\Cluster

Required. The cluster that is to be created.
↳ request_id string

Idempotent request UUID.

getParent

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

Returns
Type Description
string

setParent

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterId

Required. The logical name of the Redis cluster in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.

  • Must start with a letter.

  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
Returns
Type Description
string

setClusterId

Required. The logical name of the Redis cluster in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.

  • Must start with a letter.

  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
Parameter
Name Description
var string
Returns
Type Description
$this

getCluster

Required. The cluster that is to be created.

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

hasCluster

clearCluster

setCluster

Required. The cluster that is to be created.

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
parent string

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region. Please see Google\Cloud\Redis\Cluster\V1\CloudRedisClusterClient::locationName() for help formatting this field.
cluster Google\Cloud\Redis\Cluster\V1\Cluster

Required. The cluster that is to be created.
clusterId string

Required. The logical name of the Redis cluster in the customer project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
Returns
Type Description
Google\Cloud\Redis\Cluster\V1\CreateClusterRequest