Class DataflowSourceOperationSettings

Dataflow Source Operation properties.

Inheritance

System.Object

DataflowSourceOperationSettings

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.ResourceManager.IotOperations.dll

Syntax

public class DataflowSourceOperationSettings : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotOperations.Models.DataflowSourceOperationSettings>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotOperations.Models.DataflowSourceOperationSettings>

Constructors

DataflowSourceOperationSettings(String, IEnumerable<String>)

Initializes a new instance of DataflowSourceOperationSettings.

Declaration

public DataflowSourceOperationSettings (string endpointRef, System.Collections.Generic.IEnumerable<string> dataSources);

Parameters

System.String endpointRef Reference to the Dataflow Endpoint resource. Can only be of Broker and Kafka type.

System.Collections.Generic.IEnumerable<System.String> dataSources List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +.

Exceptions

System.ArgumentNullException endpointRef or dataSources is null.

Properties

AssetRef

Reference to the resource in Azure Device Registry where the data in the endpoint originates from.

Declaration

public string AssetRef { get; set; }

Property Value

System.String

DataSources

List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +.

Declaration

public System.Collections.Generic.IList<string> DataSources { get; }

Property Value

System.Collections.Generic.IList<System.String>

EndpointRef

Reference to the Dataflow Endpoint resource. Can only be of Broker and Kafka type.

Declaration

public string EndpointRef { get; set; }

Property Value

System.String

SchemaRef

Schema CR reference. Data will be deserialized according to the schema, and dropped if it doesn't match.

Declaration

public string SchemaRef { get; set; }

Property Value

System.String

SerializationFormat

Content is a JSON Schema. Allowed: JSON Schema/draft-7.

Declaration

public Nullable<Azure.ResourceManager.IotOperations.Models.DataflowSourceSerializationFormat> SerializationFormat { get; set; }

Property Value

System.Nullable<DataflowSourceSerializationFormat>

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<DataflowSourceOperationSettings>.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.DataflowSourceOperationSettings IJsonModel<DataflowSourceOperationSettings>.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

DataflowSourceOperationSettings A T representation of the JSON value.

Exceptions

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

IJsonModel<DataflowSourceOperationSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

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

Declaration

void IJsonModel<DataflowSourceOperationSettings>.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<DataflowSourceOperationSettings>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration

Azure.ResourceManager.IotOperations.Models.DataflowSourceOperationSettings IPersistableModel<DataflowSourceOperationSettings>.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

DataflowSourceOperationSettings A T representation of the data.

Exceptions

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

IPersistableModel<DataflowSourceOperationSettings>.GetFormatFromOptions(ModelReaderWriterOptions)

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

Declaration

string IPersistableModel<DataflowSourceOperationSettings>.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<DataflowSourceOperationSettings>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration

BinaryData IPersistableModel<DataflowSourceOperationSettings>.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.