Google Cloud Managed Kafka V1 Client - Class CreateClusterRequest (0.1.2)

Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class CreateClusterRequest.

Request for CreateCluster.

Generated from protobuf message google.cloud.managedkafka.v1.CreateClusterRequest

Namespace

Google \ Cloud \ ManagedKafka \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.
↳ cluster_id string

Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035. This value is structured like: my-cluster-id.
↳ cluster Google\Cloud\ManagedKafka\V1\Cluster

Required. Configuration of the cluster to create. Its name field is ignored.
↳ request_id string

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

getParent

Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.

Returns
Type Description
string

setParent

Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterId

Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035.

This value is structured like: my-cluster-id.

Returns
Type Description
string

setClusterId

Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035.

This value is structured like: my-cluster-id.

Parameter
Name Description
var string
Returns
Type Description
$this

getCluster

Required. Configuration of the cluster to create. Its name field is ignored.

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

hasCluster

clearCluster

setCluster

Required. Configuration of the cluster to create. Its name field is ignored.

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

getRequestId

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type Description
string

setRequestId

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}. Please see Google\Cloud\ManagedKafka\V1\ManagedKafkaClient::locationName() for help formatting this field.
cluster Google\Cloud\ManagedKafka\V1\Cluster

Required. Configuration of the cluster to create. Its name field is ignored.
clusterId string

Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035.

This value is structured like: my-cluster-id.
Returns
Type Description
Google\Cloud\ManagedKafka\V1\CreateClusterRequest