Show / Hide Table of Contents

Class Cluster

An Apache Kafka cluster deployed in a location.

Inheritance
object
Cluster
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.ManagedKafka.v1.Data
Assembly: Google.Apis.ManagedKafka.v1.dll
Syntax
public class Cluster : IDirectResponseSchema

Properties

BootstrapAddress

Output only. The bootstrap address of the Kafka cluster. The returned address format is: bootstrap-...managedkafka.s.cloud.goog or bootstrap...managedkafka..cloud.goog (legacy format). ## Examples: bootstrap-nol2mecj8p94jhx2ge2rg54579a.c0aad26f.europe-west1.managedkafka.s.cloud.goog - bootstrap.my-cluster.us-central1.managedkafka.my-project.cloud.goog The port number is omitted so clients can connect to their target listener (for example, :9092 for TLS or :9094 for mTLS).

Declaration
[JsonProperty("bootstrapAddress")]
public virtual string BootstrapAddress { get; set; }
Property Value
Type Description
string

BrokerCapacityConfig

Optional. Capacity configuration at a per-broker level within the Kafka cluster. The config will be appled to each broker in the cluster.

Declaration
[JsonProperty("brokerCapacityConfig")]
public virtual BrokerCapacityConfig BrokerCapacityConfig { get; set; }
Property Value
Type Description
BrokerCapacityConfig

BrokerDetails

Output only. Only populated when FULL view is requested. Details of each broker in the cluster.

Declaration
[JsonProperty("brokerDetails")]
public virtual IList<BrokerDetails> BrokerDetails { get; set; }
Property Value
Type Description
IList<BrokerDetails>

CapacityConfig

Required. Capacity configuration for the Kafka cluster.

Declaration
[JsonProperty("capacityConfig")]
public virtual CapacityConfig CapacityConfig { get; set; }
Property Value
Type Description
CapacityConfig

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The time when the cluster was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EffectiveCapacityConfig

Output only. Only populated when FULL view is requested. The effective capacity configuration of the cluster.

Declaration
[JsonProperty("effectiveCapacityConfig")]
public virtual EffectiveCapacityConfig EffectiveCapacityConfig { get; set; }
Property Value
Type Description
EffectiveCapacityConfig

GcpConfig

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

Declaration
[JsonProperty("gcpConfig")]
public virtual GcpConfig GcpConfig { get; set; }
Property Value
Type Description
GcpConfig

KafkaVersion

Optional. The Apache Kafka version of the cluster. Specifically, this value is the finalized metadata version. If not specified during cluster creation, defaults to 3.7.x. Supported values: 3.7.x.

Declaration
[JsonProperty("kafkaVersion")]
public virtual string KafkaVersion { get; set; }
Property Value
Type Description
string

Labels

Optional. Labels as key value pairs.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PublicClusterDetails

Output only. Details of the public cluster feature for the Kafka cluster.

Declaration
[JsonProperty("publicClusterDetails")]
public virtual PublicClusterDetails PublicClusterDetails { get; set; }
Property Value
Type Description
PublicClusterDetails

RebalanceConfig

Optional. Rebalance configuration for the Kafka cluster.

Declaration
[JsonProperty("rebalanceConfig")]
public virtual RebalanceConfig RebalanceConfig { get; set; }
Property Value
Type Description
RebalanceConfig

SatisfiesPzi

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

State

Output only. The current state of the cluster.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

TlsConfig

Optional. TLS configuration for the Kafka cluster.

Declaration
[JsonProperty("tlsConfig")]
public virtual TlsConfig TlsConfig { get; set; }
Property Value
Type Description
TlsConfig

UpdateOptions

Optional. UpdateOptions represents options that control how updates to the cluster are applied.

Declaration
[JsonProperty("updateOptions")]
public virtual UpdateOptions UpdateOptions { get; set; }
Property Value
Type Description
UpdateOptions

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX