RunQueryFilter Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17
  • java.lang.Object
    • com.azure.analytics.synapse.artifacts.models.RunQueryFilter

Implements

JsonSerializable<RunQueryFilter>

public final class RunQueryFilter
implements JsonSerializable<RunQueryFilter>

Query filter option for listing runs.

Constructor Summary

Constructor Description
RunQueryFilter()

Creates an instance of RunQueryFilter class.

Method Summary

Modifier and Type Method and Description
static RunQueryFilter fromJson(JsonReader jsonReader)

Reads an instance of RunQueryFilter from the JsonReader.
RunQueryFilterOperand getOperand()

Get the operand property: Parameter name to be used for filter.
RunQueryFilterOperator getOperator()

Get the operator property: Operator to be used for filter.
List<String> getValues()

Get the values property: List of filter values.
RunQueryFilter setOperand(RunQueryFilterOperand operand)

Set the operand property: Parameter name to be used for filter.
RunQueryFilter setOperator(RunQueryFilterOperator operator)

Set the operator property: Operator to be used for filter.
RunQueryFilter setValues(List<String> values)

Set the values property: List of filter values.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RunQueryFilter

public RunQueryFilter()

Creates an instance of RunQueryFilter class.

Method Details

fromJson

public static RunQueryFilter fromJson(JsonReader jsonReader)

Reads an instance of RunQueryFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RunQueryFilter if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getOperand

public RunQueryFilterOperand getOperand()

Get the operand property: Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.

Returns:

the operand value.

getOperator

public RunQueryFilterOperator getOperator()

Get the operator property: Operator to be used for filter.

Returns:

the operator value.

getValues

public List<String> getValues()

Get the values property: List of filter values.

Returns:

the values value.

setOperand

public RunQueryFilter setOperand(RunQueryFilterOperand operand)

Set the operand property: Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.

Parameters:

operand - the operand value to set.

Returns:

the RunQueryFilter object itself.

setOperator

public RunQueryFilter setOperator(RunQueryFilterOperator operator)

Set the operator property: Operator to be used for filter.

Parameters:

operator - the operator value to set.

Returns:

the RunQueryFilter object itself.

setValues

public RunQueryFilter setValues(List<String> values)

Set the values property: List of filter values.

Parameters:

values - the values value to set.

Returns:

the RunQueryFilter object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to