Class GetQueueResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.deadline.model.DeadlineResponse
-
- software.amazon.awssdk.services.deadline.model.GetQueueResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetQueueResponse.Builder,GetQueueResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetQueueResponse extends DeadlineResponse implements ToCopyableBuilder<GetQueueResponse.Builder,GetQueueResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetQueueResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>allowedStorageProfileIds()The storage profile IDs for the queue.QueueBlockedReasonblockedReason()The reason the queue was blocked.StringblockedReasonAsString()The reason the queue was blocked.static GetQueueResponse.Builderbuilder()InstantcreatedAt()The date and time the resource was created.StringcreatedBy()The user or system that created this resource.DefaultQueueBudgetActiondefaultBudgetAction()The default action taken on a queue if a budget wasn't configured.StringdefaultBudgetActionAsString()The default action taken on a queue if a budget wasn't configured.Stringdescription()The description of the queue.StringdisplayName()The display name of the queue.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfarmId()The farm ID for the queue.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAllowedStorageProfileIds()For responses, this returns true if the service returned a value for the AllowedStorageProfileIds property.inthashCode()booleanhasRequiredFileSystemLocationNames()For responses, this returns true if the service returned a value for the RequiredFileSystemLocationNames property.JobAttachmentSettingsjobAttachmentSettings()The job attachment settings for the queue.JobRunAsUserjobRunAsUser()The jobs in the queue ran as this specified POSIX user.StringqueueId()The queue ID.List<String>requiredFileSystemLocationNames()A list of the required file system location names in the queue.StringroleArn()The IAM role ARN.List<SdkField<?>>sdkFields()static Class<? extends GetQueueResponse.Builder>serializableBuilderClass()QueueStatusstatus()The status of the queue.StringstatusAsString()The status of the queue.GetQueueResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedAt()The date and time the resource was updated.StringupdatedBy()The user or system that updated this resource.-
Methods inherited from class software.amazon.awssdk.services.deadline.model.DeadlineResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
hasAllowedStorageProfileIds
public final boolean hasAllowedStorageProfileIds()
For responses, this returns true if the service returned a value for the AllowedStorageProfileIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
allowedStorageProfileIds
public final List<String> allowedStorageProfileIds()
The storage profile IDs for the queue.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAllowedStorageProfileIds()method.- Returns:
- The storage profile IDs for the queue.
-
blockedReason
public final QueueBlockedReason blockedReason()
The reason the queue was blocked.
If the service returns an enum value that is not available in the current SDK version,
blockedReasonwill returnQueueBlockedReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromblockedReasonAsString().- Returns:
- The reason the queue was blocked.
- See Also:
QueueBlockedReason
-
blockedReasonAsString
public final String blockedReasonAsString()
The reason the queue was blocked.
If the service returns an enum value that is not available in the current SDK version,
blockedReasonwill returnQueueBlockedReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromblockedReasonAsString().- Returns:
- The reason the queue was blocked.
- See Also:
QueueBlockedReason
-
createdAt
public final Instant createdAt()
The date and time the resource was created.
- Returns:
- The date and time the resource was created.
-
createdBy
public final String createdBy()
The user or system that created this resource.
- Returns:
- The user or system that created this resource.
-
defaultBudgetAction
public final DefaultQueueBudgetAction defaultBudgetAction()
The default action taken on a queue if a budget wasn't configured.
If the service returns an enum value that is not available in the current SDK version,
defaultBudgetActionwill returnDefaultQueueBudgetAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdefaultBudgetActionAsString().- Returns:
- The default action taken on a queue if a budget wasn't configured.
- See Also:
DefaultQueueBudgetAction
-
defaultBudgetActionAsString
public final String defaultBudgetActionAsString()
The default action taken on a queue if a budget wasn't configured.
If the service returns an enum value that is not available in the current SDK version,
defaultBudgetActionwill returnDefaultQueueBudgetAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdefaultBudgetActionAsString().- Returns:
- The default action taken on a queue if a budget wasn't configured.
- See Also:
DefaultQueueBudgetAction
-
description
public final String description()
The description of the queue.
- Returns:
- The description of the queue.
-
displayName
public final String displayName()
The display name of the queue.
- Returns:
- The display name of the queue.
-
farmId
public final String farmId()
The farm ID for the queue.
- Returns:
- The farm ID for the queue.
-
jobAttachmentSettings
public final JobAttachmentSettings jobAttachmentSettings()
The job attachment settings for the queue.
- Returns:
- The job attachment settings for the queue.
-
jobRunAsUser
public final JobRunAsUser jobRunAsUser()
The jobs in the queue ran as this specified POSIX user.
- Returns:
- The jobs in the queue ran as this specified POSIX user.
-
queueId
public final String queueId()
The queue ID.
- Returns:
- The queue ID.
-
hasRequiredFileSystemLocationNames
public final boolean hasRequiredFileSystemLocationNames()
For responses, this returns true if the service returned a value for the RequiredFileSystemLocationNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
requiredFileSystemLocationNames
public final List<String> requiredFileSystemLocationNames()
A list of the required file system location names in the queue.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRequiredFileSystemLocationNames()method.- Returns:
- A list of the required file system location names in the queue.
-
roleArn
public final String roleArn()
The IAM role ARN.
- Returns:
- The IAM role ARN.
-
status
public final QueueStatus status()
The status of the queue.
-
ACTIVE–The queue is active. -
SCHEDULING–The queue is scheduling. -
SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnQueueStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the queue.
-
ACTIVE–The queue is active. -
SCHEDULING–The queue is scheduling. -
SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.
-
- See Also:
QueueStatus
-
-
statusAsString
public final String statusAsString()
The status of the queue.
-
ACTIVE–The queue is active. -
SCHEDULING–The queue is scheduling. -
SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnQueueStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the queue.
-
ACTIVE–The queue is active. -
SCHEDULING–The queue is scheduling. -
SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.
-
- See Also:
QueueStatus
-
-
updatedAt
public final Instant updatedAt()
The date and time the resource was updated.
- Returns:
- The date and time the resource was updated.
-
updatedBy
public final String updatedBy()
The user or system that updated this resource.
- Returns:
- The user or system that updated this resource.
-
toBuilder
public GetQueueResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetQueueResponse.Builder,GetQueueResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetQueueResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetQueueResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-