Class ListBacklogTasksRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.devopsagent.model.DevOpsAgentRequest
software.amazon.awssdk.services.devopsagent.model.ListBacklogTasksRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListBacklogTasksRequest.Builder,ListBacklogTasksRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListBacklogTasksRequest extends DevOpsAgentRequest implements ToCopyableBuilder<ListBacklogTasksRequest.Builder,ListBacklogTasksRequest>

Request structure for listing backlog tasks with filtering, sorting, and pagination support

  • Method Details

    • agentSpaceId

      public final String agentSpaceId()

      The unique identifier for the agent space containing the tasks

      Returns:
      The unique identifier for the agent space containing the tasks

    • filter

      public final 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
      Returns:
      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

    • limit

      public final Integer limit()

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

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

    • nextToken

      public final String nextToken()

      Token for retrieving the next page of results

      Returns:
      Token for retrieving the next page of results

    • sortField

      public final 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)

      If the service returns an enum value that is not available in the current SDK version, sortField will return TaskSortField.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortFieldAsString().

      Returns:
      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)
      See Also:

    • sortFieldAsString

      public final String sortFieldAsString()

      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)

      If the service returns an enum value that is not available in the current SDK version, sortField will return TaskSortField.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortFieldAsString().

      Returns:
      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)
      See Also:

    • order

      public final TaskSortOrder order()

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

      If the service returns an enum value that is not available in the current SDK version, order will return TaskSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

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

    • orderAsString

      public final String orderAsString()

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

      If the service returns an enum value that is not available in the current SDK version, order will return TaskSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

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

    • toBuilder

      public ListBacklogTasksRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListBacklogTasksRequest.Builder,ListBacklogTasksRequest>
      Specified by:
      toBuilder in class DevOpsAgentRequest
      Returns:
      a builder for type T

    • builder

      public static ListBacklogTasksRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListBacklogTasksRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.