Send feedback
Class TlsConfig (0.24.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class TlsConfig extends GeneratedMessageV3 implements TlsConfigOrBuilder
The TLS configuration for the Kafka cluster.
Protobuf type google.cloud.managedkafka.v1.TlsConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static TlsConfig . Builder newBuilder ()
newBuilder(TlsConfig prototype)
public static TlsConfig . Builder newBuilder ( TlsConfig prototype )
Parameter
Name
Description
prototype
TlsConfig
public static TlsConfig parseDelimitedFrom ( InputStream input )
public static TlsConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static TlsConfig parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TlsConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static TlsConfig parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TlsConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static TlsConfig parseFrom ( CodedInputStream input )
public static TlsConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static TlsConfig parseFrom ( InputStream input )
public static TlsConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static TlsConfig parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TlsConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<TlsConfig> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getDefaultInstanceForType()
public TlsConfig getDefaultInstanceForType ()
getParserForType()
public Parser<TlsConfig> getParserForType ()
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];
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];
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()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public TlsConfig . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TlsConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public TlsConfig . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-18 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-18 UTC."],[],[]]