Package software.amazon.awssdk.services.deadline.model

Class ListQueuesRequest

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

  • Method Details

    • farmId

      public final String farmId()

      The farm ID of the queue.

      Returns:
      The farm ID of the queue.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

      Returns:
      The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

    • nextToken

      public final String nextToken()

      The token for the next set of results, or null to start from the beginning.

      Returns:
      The token for the next set of results, or null to start from the beginning.

    • principalId

      public final String principalId()

      The principal ID. This filter is only valid when using Nimble Studio credentials and should match the user ID in the credentials of the caller.

      Returns:
      The principal ID. This filter is only valid when using Nimble Studio credentials and should match the user ID in the credentials of the caller.

    • status

      public final QueueStatus status()

      The status of the queues listed.

      • ACTIVE–The queues are active.

      • SCHEDULING–The queues are scheduling.

      • SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

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

      Returns:
      The status of the queues listed.

      • ACTIVE–The queues are active.

      • SCHEDULING–The queues are scheduling.

      • SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the queues listed.

      • ACTIVE–The queues are active.

      • SCHEDULING–The queues are scheduling.

      • SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

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

      Returns:
      The status of the queues listed.

      • ACTIVE–The queues are active.

      • SCHEDULING–The queues are scheduling.

      • SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

      See Also:

    • toBuilder

      public ListQueuesRequest.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<ListQueuesRequest.Builder,ListQueuesRequest>
      Specified by:
      toBuilder in class DeadlineRequest
      Returns:
      a builder for type T

    • builder

      public static ListQueuesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListQueuesRequest.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.