Reference documentation and code samples for the Managed Service for Apache Kafka V1 API class Google::Cloud::ManagedKafka::V1::Cluster.
An Apache Kafka cluster deployed in a location.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#capacity_config
def capacity_config() -> ::Google::Cloud::ManagedKafka::V1::CapacityConfig
Returns
- (::Google::Cloud::ManagedKafka::V1::CapacityConfig) — Required. Capacity configuration for the Kafka cluster.
#capacity_config=
def capacity_config=(value) -> ::Google::Cloud::ManagedKafka::V1::CapacityConfig
Parameter
- value (::Google::Cloud::ManagedKafka::V1::CapacityConfig) — Required. Capacity configuration for the Kafka cluster.
Returns
- (::Google::Cloud::ManagedKafka::V1::CapacityConfig) — Required. Capacity configuration for the Kafka cluster.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the cluster was created.
#gcp_config
def gcp_config() -> ::Google::Cloud::ManagedKafka::V1::GcpConfig
Returns
- (::Google::Cloud::ManagedKafka::V1::GcpConfig) — Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.
#gcp_config=
def gcp_config=(value) -> ::Google::Cloud::ManagedKafka::V1::GcpConfig
Parameter
- value (::Google::Cloud::ManagedKafka::V1::GcpConfig) — Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.
Returns
- (::Google::Cloud::ManagedKafka::V1::GcpConfig) — Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.
#name
def name() -> ::String
Returns
- (::String) — Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
Returns
- (::String) — Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
#rebalance_config
def rebalance_config() -> ::Google::Cloud::ManagedKafka::V1::RebalanceConfig
Returns
- (::Google::Cloud::ManagedKafka::V1::RebalanceConfig) — Optional. Rebalance configuration for the Kafka cluster.
#rebalance_config=
def rebalance_config=(value) -> ::Google::Cloud::ManagedKafka::V1::RebalanceConfig
Parameter
- value (::Google::Cloud::ManagedKafka::V1::RebalanceConfig) — Optional. Rebalance configuration for the Kafka cluster.
Returns
- (::Google::Cloud::ManagedKafka::V1::RebalanceConfig) — Optional. Rebalance configuration for the Kafka cluster.
#satisfies_pzi
def satisfies_pzi() -> ::Boolean
Returns
- (::Boolean) — Output only. Reserved for future use.
#satisfies_pzs
def satisfies_pzs() -> ::Boolean
Returns
- (::Boolean) — Output only. Reserved for future use.
#state
def state() -> ::Google::Cloud::ManagedKafka::V1::Cluster::State
Returns
- (::Google::Cloud::ManagedKafka::V1::Cluster::State) — Output only. The current state of the cluster.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the cluster was last updated.