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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListQueuesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListQueuesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	farmId()	The farm ID of the queue.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results to return.
String	nextToken()	The token for the next set of results, or null to start from the beginning.
String	principalId()	The principal ID.
List<SdkField<?>>	sdkFields()
static Class<? extends ListQueuesRequest.Builder>	serializableBuilderClass()
QueueStatus	status()	The status of the queues listed.
String	statusAsString()	The status of the queues listed.
ListQueuesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

QueueStatus

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:

QueueStatus

toBuilder

public ListQueuesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListQueuesRequest.Builder,ListQueuesRequest>

Specified by:

toBuilder in class DeadlineRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo