Google Cloud Managed Kafka V1 Client - Class Cluster (0.1.0)

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

An Apache Kafka cluster deployed in a location.

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

Namespace

Google \ Cloud \ ManagedKafka \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ gcp_config	Google\Cloud\ManagedKafka\V1\GcpConfig Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.
↳ name	string Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
↳ create_time	Google\Protobuf\Timestamp Output only. The time when the cluster was created.
↳ update_time	Google\Protobuf\Timestamp Output only. The time when the cluster was last updated.
↳ labels	array|Google\Protobuf\Internal\MapField Optional. Labels as key value pairs.
↳ capacity_config	Google\Cloud\ManagedKafka\V1\CapacityConfig Required. Capacity configuration for the Kafka cluster.
↳ rebalance_config	Google\Cloud\ManagedKafka\V1\RebalanceConfig Optional. Rebalance configuration for the Kafka cluster.
↳ state	int Output only. The current state of the cluster.

getGcpConfig

Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.

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

hasGcpConfig

setGcpConfig

Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.

Parameter
Name	Description
var	Google\Cloud\ManagedKafka\V1\GcpConfig

Returns
Type	Description
$this

getName

Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}

Returns
Type	Description
string

setName

Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. The time when the cluster was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the cluster was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The time when the cluster was last updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the cluster was last updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getLabels

Optional. Labels as key value pairs.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Labels as key value pairs.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getCapacityConfig

Required. Capacity configuration for the Kafka cluster.

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

hasCapacityConfig

clearCapacityConfig

setCapacityConfig

Required. Capacity configuration for the Kafka cluster.

Parameter
Name	Description
var	Google\Cloud\ManagedKafka\V1\CapacityConfig

Returns
Type	Description
$this

getRebalanceConfig

Optional. Rebalance configuration for the Kafka cluster.

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

hasRebalanceConfig

clearRebalanceConfig

setRebalanceConfig

Optional. Rebalance configuration for the Kafka cluster.

Parameter
Name	Description
var	Google\Cloud\ManagedKafka\V1\RebalanceConfig

Returns
Type	Description
$this

getState

Output only. The current state of the cluster.

Returns
Type	Description
int

setState

Output only. The current state of the cluster.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPlatformConfig

Returns
Type	Description
string