Optional. The configuration of the broker truststore. If specified, clients can use mTLS for authentication.
↳ ssl_principal_mapping_rules
string
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).
getTrustConfig
Optional. The configuration of the broker truststore. If specified, clients
can use mTLS for authentication.
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).
Returns
Type
Description
string
setSslPrincipalMappingRules
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).
[[["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-09-04 UTC."],[],[],null,["# Google Cloud Managed Kafka V1 Client - Class TlsConfig (0.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.1 (latest)](/php/docs/reference/cloud-managedkafka/latest/V1.TlsConfig)\n- [0.6.0](/php/docs/reference/cloud-managedkafka/0.6.0/V1.TlsConfig)\n- [0.5.0](/php/docs/reference/cloud-managedkafka/0.5.0/V1.TlsConfig)\n- [0.4.1](/php/docs/reference/cloud-managedkafka/0.4.1/V1.TlsConfig)\n- [0.3.1](/php/docs/reference/cloud-managedkafka/0.3.1/V1.TlsConfig)\n- [0.2.3](/php/docs/reference/cloud-managedkafka/0.2.3/V1.TlsConfig)\n- [0.1.3](/php/docs/reference/cloud-managedkafka/0.1.3/V1.TlsConfig) \nReference documentation and code samples for the Google Cloud Managed Kafka V1 Client class TlsConfig.\n\nThe TLS configuration for the Kafka cluster.\n\nGenerated from protobuf message `google.cloud.managedkafka.v1.TlsConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ManagedKafka \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTrustConfig\n\nOptional. The configuration of the broker truststore. If specified, clients\ncan use mTLS for authentication.\n\n### hasTrustConfig\n\n### clearTrustConfig\n\n### setTrustConfig\n\nOptional. The configuration of the broker truststore. If specified, clients\ncan use mTLS for authentication.\n\n### getSslPrincipalMappingRules\n\nOptional. A list of rules for mapping from SSL principal names to\nshort names. These are applied in order by Kafka.\n\nRefer to the Apache Kafka documentation for `ssl.principal.mapping.rules`\nfor the precise formatting details and syntax.\nExample: \"RULE:\\^CN=(.*?),OU=ServiceUsers.*$/$1@example.com/,DEFAULT\"\nThis is a static Kafka broker configuration. Setting or modifying this\nfield will trigger a rolling restart of the Kafka brokers to apply\nthe change. An empty string means no rules are applied (Kafka default).\n\n### setSslPrincipalMappingRules\n\nOptional. A list of rules for mapping from SSL principal names to\nshort names. These are applied in order by Kafka.\n\nRefer to the Apache Kafka documentation for `ssl.principal.mapping.rules`\nfor the precise formatting details and syntax.\nExample: \"RULE:\\^CN=(.*?),OU=ServiceUsers.*$/$1@example.com/,DEFAULT\"\nThis is a static Kafka broker configuration. Setting or modifying this\nfield will trigger a rolling restart of the Kafka brokers to apply\nthe change. An empty string means no rules are applied (Kafka default)."]]
