Class RunQueryOrderBy

java.lang.Object
com.azure.analytics.synapse.artifacts.models.RunQueryOrderBy

public final class RunQueryOrderBy extends Object
An object to provide order by options for listing runs.
  • Constructor Details

    • RunQueryOrderBy

      public RunQueryOrderBy()
  • Method Details

    • getOrderBy

      public RunQueryOrderByField getOrderBy()
      Get the orderBy property: Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.
      Returns:
      the orderBy value.
    • setOrderBy

      public RunQueryOrderBy setOrderBy(RunQueryOrderByField orderBy)
      Set the orderBy property: Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.
      Parameters:
      orderBy - the orderBy value to set.
      Returns:
      the RunQueryOrderBy object itself.
    • getOrder

      public RunQueryOrder getOrder()
      Get the order property: Sorting order of the parameter.
      Returns:
      the order value.
    • setOrder

      public RunQueryOrderBy setOrder(RunQueryOrder order)
      Set the order property: Sorting order of the parameter.
      Parameters:
      order - the order value to set.
      Returns:
      the RunQueryOrderBy object itself.