Class RunQueryOrderBy


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

      • RunQueryOrderBy

        public RunQueryOrderBy()
    • Method Detail

      • orderBy

        public RunQueryOrderByField orderBy()
        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.
      • withOrderBy

        public RunQueryOrderBy withOrderBy​(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.
      • order

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

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

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.