Interface ListBacklogTasksRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListBacklogTasksRequest.Builder,ListBacklogTasksRequest>, DevOpsAgentRequest.Builder, SdkBuilder<ListBacklogTasksRequest.Builder,ListBacklogTasksRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListBacklogTasksRequest
@Mutable @NotThreadSafe public static interface ListBacklogTasksRequest.Builder extends DevOpsAgentRequest.Builder, SdkPojo, CopyableBuilder<ListBacklogTasksRequest.Builder,ListBacklogTasksRequest>

  • Method Details

    • agentSpaceId

      ListBacklogTasksRequest.Builder agentSpaceId(String agentSpaceId)

      The unique identifier for the agent space containing the tasks

      Parameters:
      agentSpaceId - The unique identifier for the agent space containing the tasks
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      ListBacklogTasksRequest.Builder filter(TaskFilter filter)

      Filter criteria to apply when listing tasks

      Filtering restrictions:

      • Each filter field list is limited to a single value
      • Filtering by Priority and Status at the same time when not filtering by Type is not permitted
      • Timestamp filters (createdAfter, createdBefore) can be combined with other filters when not sorting by priority
      Parameters:
      filter - Filter criteria to apply when listing tasks

      Filtering restrictions:

      • Each filter field list is limited to a single value
      • Filtering by Priority and Status at the same time when not filtering by Type is not permitted
      • Timestamp filters (createdAfter, createdBefore) can be combined with other filters when not sorting by priority
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      default ListBacklogTasksRequest.Builder filter(Consumer<TaskFilter.Builder> filter)

      Filter criteria to apply when listing tasks

      Filtering restrictions:

      • Each filter field list is limited to a single value
      • Filtering by Priority and Status at the same time when not filtering by Type is not permitted
      • Timestamp filters (createdAfter, createdBefore) can be combined with other filters when not sorting by priority
      This is a convenience method that creates an instance of the TaskFilter.Builder avoiding the need to create one manually via TaskFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(TaskFilter).

      Parameters:
      filter - a consumer that will call methods on TaskFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • limit

      ListBacklogTasksRequest.Builder limit(Integer limit)

      Maximum number of tasks to return in a single response (1-1000, default: 100)

      Parameters:
      limit - Maximum number of tasks to return in a single response (1-1000, default: 100)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListBacklogTasksRequest.Builder nextToken(String nextToken)

      Token for retrieving the next page of results

      Parameters:
      nextToken - Token for retrieving the next page of results
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortField

      ListBacklogTasksRequest.Builder sortField(String sortField)

      Field to sort by 

       Sorting restrictions:
      • Only sorting on createdAt is supported when using priority or status filters alone.
      • Sorting by priority is not supported when using Timestamp filters (createdAfter, createdBefore)
      Parameters:
      sortField - Field to sort by

       Sorting restrictions:
      • Only sorting on createdAt is supported when using priority or status filters alone.
      • Sorting by priority is not supported when using Timestamp filters (createdAfter, createdBefore)
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortField

      ListBacklogTasksRequest.Builder sortField(TaskSortField sortField)

      Field to sort by 

       Sorting restrictions:
      • Only sorting on createdAt is supported when using priority or status filters alone.
      • Sorting by priority is not supported when using Timestamp filters (createdAfter, createdBefore)
      Parameters:
      sortField - Field to sort by

       Sorting restrictions:
      • Only sorting on createdAt is supported when using priority or status filters alone.
      • Sorting by priority is not supported when using Timestamp filters (createdAfter, createdBefore)
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • order

      ListBacklogTasksRequest.Builder order(String order)

      Sort order for the tasks based on sortField (default: DESC)

      Parameters:
      order - Sort order for the tasks based on sortField (default: DESC)
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • order

      ListBacklogTasksRequest.Builder order(TaskSortOrder order)

      Sort order for the tasks based on sortField (default: DESC)

      Parameters:
      order - Sort order for the tasks based on sortField (default: DESC)
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ListBacklogTasksRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListBacklogTasksRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.