Class TlsConfig (0.24.0)

public final class TlsConfig extends GeneratedMessageV3 implements TlsConfigOrBuilder

The TLS configuration for the Kafka cluster.

Protobuf type google.cloud.managedkafka.v1.TlsConfig

Implements

TlsConfigOrBuilder

Static Fields

SSL_PRINCIPAL_MAPPING_RULES_FIELD_NUMBER

public static final int SSL_PRINCIPAL_MAPPING_RULES_FIELD_NUMBER
Field Value
Type Description
int

TRUST_CONFIG_FIELD_NUMBER

public static final int TRUST_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TlsConfig getDefaultInstance()
Returns
Type Description
TlsConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TlsConfig.Builder newBuilder()
Returns
Type Description
TlsConfig.Builder

newBuilder(TlsConfig prototype)

public static TlsConfig.Builder newBuilder(TlsConfig prototype)
Parameter
Name Description
prototype TlsConfig
Returns
Type Description
TlsConfig.Builder

parseDelimitedFrom(InputStream input)

public static TlsConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TlsConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TlsConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TlsConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TlsConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TlsConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TlsConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TlsConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TlsConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TlsConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TlsConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TlsConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TlsConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TlsConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TlsConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TlsConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TlsConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TlsConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TlsConfig> parser()
Returns
Type Description
Parser<TlsConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TlsConfig getDefaultInstanceForType()
Returns
Type Description
TlsConfig

getParserForType()

public Parser<TlsConfig> getParserForType()
Returns
Type Description
Parser<TlsConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSslPrincipalMappingRules()

public String getSslPrincipalMappingRules()

Optional. A list of rules for mapping from SSL principal names to short names. These are applied in order by Kafka. Refer to the Apache Kafka documentation for ssl.principal.mapping.rules for the precise formatting details and syntax. Example: "RULE:^CN=(.?),OU=ServiceUsers.$/$1@example.com/,DEFAULT"

This is a static Kafka broker configuration. Setting or modifying this field will trigger a rolling restart of the Kafka brokers to apply the change. An empty string means no rules are applied (Kafka default).

string ssl_principal_mapping_rules = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sslPrincipalMappingRules.

getSslPrincipalMappingRulesBytes()

public ByteString getSslPrincipalMappingRulesBytes()

Optional. A list of rules for mapping from SSL principal names to short names. These are applied in order by Kafka. Refer to the Apache Kafka documentation for ssl.principal.mapping.rules for the precise formatting details and syntax. Example: "RULE:^CN=(.?),OU=ServiceUsers.$/$1@example.com/,DEFAULT"

This is a static Kafka broker configuration. Setting or modifying this field will trigger a rolling restart of the Kafka brokers to apply the change. An empty string means no rules are applied (Kafka default).

string ssl_principal_mapping_rules = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sslPrincipalMappingRules.

getTrustConfig()

public TrustConfig getTrustConfig()

Optional. The configuration of the broker truststore. If specified, clients can use mTLS for authentication.

.google.cloud.managedkafka.v1.TrustConfig trust_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TrustConfig

The trustConfig.

getTrustConfigOrBuilder()

public TrustConfigOrBuilder getTrustConfigOrBuilder()

Optional. The configuration of the broker truststore. If specified, clients can use mTLS for authentication.

.google.cloud.managedkafka.v1.TrustConfig trust_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TrustConfigOrBuilder

hasTrustConfig()

public boolean hasTrustConfig()

Optional. The configuration of the broker truststore. If specified, clients can use mTLS for authentication.

.google.cloud.managedkafka.v1.TrustConfig trust_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the trustConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TlsConfig.Builder newBuilderForType()
Returns
Type Description
TlsConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TlsConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TlsConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TlsConfig.Builder toBuilder()
Returns
Type Description
TlsConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException