Show / Hide Table of Contents

Class DataflowBuiltInTransformationFilter

Dataflow BuiltIn Transformation filter properties.

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

Constructors

DataflowBuiltInTransformationFilter(IEnumerable<String>, String)

Initializes a new instance of DataflowBuiltInTransformationFilter.

Declaration
public DataflowBuiltInTransformationFilter (System.Collections.Generic.IEnumerable<string> inputs, string expression);
Parameters
System.Collections.Generic.IEnumerable<System.String> inputs

List of fields for filtering in JSON path expression.

System.String expression

Condition to filter data. Can reference input fields with {n} where n is the index of the input field starting from 1. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided).

Exceptions
System.ArgumentNullException

inputs or expression is null.

Properties

Description

A user provided optional description of the filter.

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

Expression

Condition to filter data. Can reference input fields with {n} where n is the index of the input field starting from 1. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided).

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

Inputs

List of fields for filtering in JSON path expression.

Declaration
public System.Collections.Generic.IList<string> Inputs { get; }
Property Value
System.Collections.Generic.IList<System.String>

Type

The type of dataflow operation.

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

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

A T representation of the JSON value.

Exceptions
System.FormatException

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

IJsonModel<DataflowBuiltInTransformationFilter>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

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

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

Converts the provided System.BinaryData into a model.

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

A T representation of the data.

Exceptions
System.FormatException

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

IPersistableModel<DataflowBuiltInTransformationFilter>.GetFormatFromOptions(ModelReaderWriterOptions)

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

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

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<DataflowBuiltInTransformationFilter>.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.

Back to top Azure SDK for .NET