Class DataflowEndpointKafka

Kafka endpoint properties.

Inheritance
System.Object
DataflowEndpointKafka
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.IotOperations.dll
Syntax
public class DataflowEndpointKafka : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotOperations.Models.DataflowEndpointKafka>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotOperations.Models.DataflowEndpointKafka>

Constructors

DataflowEndpointKafka(DataflowEndpointKafkaAuthentication, String)

Initializes a new instance of DataflowEndpointKafka.

Declaration
public DataflowEndpointKafka (Azure.ResourceManager.IotOperations.Models.DataflowEndpointKafkaAuthentication authentication, string host);
Parameters
DataflowEndpointKafkaAuthentication authentication

Authentication configuration. NOTE - only authentication property is allowed per entry.
System.String host

Kafka endpoint host.
Exceptions
System.ArgumentNullException

authentication or host is null.

Properties

Authentication

Authentication configuration. NOTE - only authentication property is allowed per entry.

Declaration
public Azure.ResourceManager.IotOperations.Models.DataflowEndpointKafkaAuthentication Authentication { get; set; }
Property Value
DataflowEndpointKafkaAuthentication

Batching

Batching configuration.

Declaration
public Azure.ResourceManager.IotOperations.Models.DataflowEndpointKafkaBatching Batching { get; set; }
Property Value
DataflowEndpointKafkaBatching

CloudEventAttributes

Cloud event mapping config.

Declaration
public Nullable<Azure.ResourceManager.IotOperations.Models.CloudEventAttributeType> CloudEventAttributes { get; set; }
Property Value
System.Nullable<CloudEventAttributeType>

Compression

Compression. Can be none, gzip, lz4, or snappy. No effect if the endpoint is used as a source.

Declaration
public Nullable<Azure.ResourceManager.IotOperations.Models.DataflowEndpointKafkaCompression> Compression { get; set; }
Property Value
System.Nullable<DataflowEndpointKafkaCompression>

ConsumerGroupId

Consumer group ID.

Declaration
public string ConsumerGroupId { get; set; }
Property Value
System.String

CopyMqttProperties

Copy Broker properties. No effect if the endpoint is used as a source or if the dataflow doesn't have an Broker source.

Declaration
public Nullable<Azure.ResourceManager.IotOperations.Models.IotOperationsOperationalMode> CopyMqttProperties { get; set; }
Property Value
System.Nullable<IotOperationsOperationalMode>

Host

Kafka endpoint host.

Declaration
public string Host { get; set; }
Property Value
System.String

KafkaAcks

Kafka acks. Can be all, one, or zero. No effect if the endpoint is used as a source.

Declaration
public Nullable<Azure.ResourceManager.IotOperations.Models.DataflowEndpointKafkaAck> KafkaAcks { get; set; }
Property Value
System.Nullable<DataflowEndpointKafkaAck>

PartitionStrategy

Partition handling strategy. Can be default or static. No effect if the endpoint is used as a source.

Declaration
public Nullable<Azure.ResourceManager.IotOperations.Models.DataflowEndpointKafkaPartitionStrategy> PartitionStrategy { get; set; }
Property Value
System.Nullable<DataflowEndpointKafkaPartitionStrategy>

Tls

TLS configuration.

Declaration
public Azure.ResourceManager.IotOperations.Models.IotOperationsTlsProperties Tls { get; set; }
Property Value
IotOperationsTlsProperties

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<DataflowEndpointKafka>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.IotOperations.Models.DataflowEndpointKafka IJsonModel<DataflowEndpointKafka>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
DataflowEndpointKafka

A T representation of the JSON value.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<DataflowEndpointKafka>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<DataflowEndpointKafka>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<DataflowEndpointKafka>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.IotOperations.Models.DataflowEndpointKafka IPersistableModel<DataflowEndpointKafka>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
DataflowEndpointKafka

A T representation of the data.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<DataflowEndpointKafka>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<DataflowEndpointKafka>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.
Returns
System.String

The format that the model uses when communicating with the service.

IPersistableModel<DataflowEndpointKafka>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<DataflowEndpointKafka>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
System.BinaryData

A binary representation of the written model.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.