本页采用了机器翻译。点击此处可查看最新英文版本。

getProviderProperties

Kafka 流配置属性数据

自 R2022b 起

全页折叠

    此函数需要 Streaming Data Framework for MATLAB® Production Server™。

    语法

    prop = getProviderProperties(ks)
    prop = getProviderProperties(ks,name)
    prop = getProviderProperties(___,Category=cat)
    [prop,val] = getProviderProperties(___)

    说明

    prop = getProviderProperties(ks) 返回结构体数组 prop 中的 Kafka® 流提供程序属性的名称和类别。返回的属性名称和类别是在创建 Kafka 流连接器对象 ks 期间指定的。

    示例

    prop = getProviderProperties(ks,name) 仅返回具有 name 指定的提供程序属性名称的属性。

    示例

    prop = getProviderProperties(___,Category=cat) 使用前面任一语法仅返回属于提供程序类别 cat 的属性。

    示例

    [prop,val] = getProviderProperties(___) 还返回每个返回属性的值的元胞数组。

    示例

    示例

    全部折叠

    假设您有一个在网络地址 kafka.host.com:9092 上运行的 Kafka 服务器，该服务器有一个主题 CoolingFan。

    创建一个连接到 Kafka 主机的 KafkaStream 对象，并在对象创建期间指定 Kafka 提供程序属性。

    ks = kafkaStream("kafka.host.com",9092,"CoolingFan", ...
"security.protocol","SSL","ssl.truststore.type","PEM", ...
"ssl.truststore.location","kafka-boston.pem","retention.ms",500);

    获取所有提供程序属性的名称和类别。

    prop = getProviderProperties(ks)
    prop = 

  8×1 struct array with fields:

    name
    category

    显示属性类别和名称。

    string({prop.category})' + "/" + string({prop.name})'
    ans = 

  8×1 string array

    "Consumer/auto.offset.reset"
    "Consumer/security.protocol"
    "CreateTopic/retention.ms"
    "KafkaConnector/sasl.jaas.config"
    "Producer/security.protocol"
    "Uncategorized/ssl.truststore.location"
    "Uncategorized/ssl.truststore.type"
    "librdkafka/sasl.username"

    假设您有一个在网络地址 kafka.host.com:9092 上运行的 Kafka 服务器，该服务器有一个主题 CoolingFan。

    创建一个连接到 Kafka 主机的 KafkaStream 对象，并在对象创建期间指定 Kafka 提供程序属性。

    ks = kafkaStream("kafka.host.com",9092,"CoolingFan", ...
"security.protocol","SSL","ssl.truststore.type","PEM", ...
"ssl.truststore.location","kafka-boston.pem","retention.ms",500);

    获取两个属性的名称和类别。由于 max.poll.records 属性未在 ks 中设置，因此 getProviderProperties 函数不会返回该属性的数据。

    prop = getProviderProperties(ks,["max.poll.records" "retention.ms"])
    prop = 

  struct with fields:

        name: 'retention.ms'
    category: 'CreateTopic'

    假设您有一个在网络地址 kafka.host.com:9092 上运行的 Kafka 服务器，该服务器有一个主题 CoolingFan。

    创建一个连接到 Kafka 主机的 KafkaStream 对象，并在对象创建期间指定 Kafka 提供程序属性。

    ks = kafkaStream("kafka.host.com",9092,"CoolingFan", ...
"security.protocol","SSL","ssl.truststore.type","PEM", ...
"ssl.truststore.location","kafka-boston.pem","retention.ms",500);

    获取属于 CreateTopic 类别的属性的数据。此类别仅包括一个属性。

    prop = getProviderProperties(ks,Category="CreateTopic")
    prop = 

  struct with fields:

        name: 'retention.ms'
    category: 'CreateTopic'

    假设您有一个在网络地址 kafka.host.com:9092 上运行的 Kafka 服务器，该服务器有一个主题 CoolingFan。

    创建一个连接到 Kafka 主机的 KafkaStream 对象，并在对象创建期间指定 Kafka 提供程序属性。

    ks = kafkaStream("kafka.host.com",9092,"CoolingFan", ...
"security.protocol","SSL","ssl.truststore.type","PEM", ...
"ssl.truststore.location","kafka-boston.pem","retention.ms",500);

    显示类别、名称和值。sasl.jaas.config 属性值无法合成，因为 ks 缺少依赖属性。getProviderProperties 不会返回此属性的值，而是返回描述此错误的 MException 对象。

    [{"Category" "Name" "Value"};{prop.category}' {prop.name}' val']
    ans =

  3×3 cell array

    {["Category"    ]}    {["Name"           ]}    {["Value"     ]}
    {'KafkaConnector'}    {'sasl.jaas.config' }    {1×1 MException}
    {'Producer'      }    {'security.protocol'}    {["SSL"       ]}

    输入参数

    全部折叠

    连接到 Kafka 流主题的对象，指定为 KafkaStream 对象。

    Kafka 流提供程序属性名称，指定为字符串标量、字符向量、字符串数组或字符向量元胞数组。如果未在 ks 中设置属性，则 getProviderProperties 不会在 prop 中返回该属性的名称和类别，或在 val 中返回可选的对应值。

    示例: [prop, val] = getProviderProperties(ks,"retention.ms") 返回 retention.ms 属性的数据。

    数据类型: char | string | cell

    Kafka 流提供程序类别名称，指定为字符串标量、字符向量、字符串数组或字符向量元胞数组。

    指定的类别必须存在于 ks 中。要获取有效类别的列表，请使用 ks.PropertyCategories 属性。

    数据类型: char | string | cell

    输出参量

    全部折叠

    Kafka 流提供程序属性名称和类别，以结构体数组形式返回。每个结构体对应于 ks 中的一个提供程序属性，并具有以下字段：

    • name - 提供程序属性名称，以字符串形式返回

    • category - 提供程序属性所属的类别，以字符串形式返回

    由于属性可以属于多个类别，因此类别和名称可以唯一地标识一个属性。

    Kafka 流提供程序属性值，以 prop 中返回的属性的元胞数组形式返回。如果 ks 缺少派生属性值所需的依赖属性，则 getProviderProperties 将返回描述错误的 MException (MATLAB) 对象来代替该值。

    详细信息

    全部折叠

    版本历史记录

    在 R2022b 中推出

    另请参阅

    | |

    主题