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

Class CreateQueueEnvironmentRequest

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.CreateQueueEnvironmentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateQueueEnvironmentRequest.Builder,CreateQueueEnvironmentRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateQueueEnvironmentRequest extends DeadlineRequest implements ToCopyableBuilder<CreateQueueEnvironmentRequest.Builder,CreateQueueEnvironmentRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      The unique token which the server uses to recognize retries of the same request.

      Returns:
      The unique token which the server uses to recognize retries of the same request.

    • farmId

      public final String farmId()

      The farm ID of the farm to connect to the environment.

      Returns:
      The farm ID of the farm to connect to the environment.

    • priority

      public final Integer priority()

      Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority. If two environments share the same priority value, the environment created first takes higher priority.

      Returns:
      Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority. If two environments share the same priority value, the environment created first takes higher priority.

    • queueId

      public final String queueId()

      The queue ID to connect the queue and environment.

      Returns:
      The queue ID to connect the queue and environment.

    • template

      public final String template()

      The environment template to use in the queue.

      Returns:
      The environment template to use in the queue.

    • templateType

      public final EnvironmentTemplateType templateType()

      The template's file type, JSON or YAML.

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

      Returns:
      The template's file type, JSON or YAML.
      See Also:

    • templateTypeAsString

      public final String templateTypeAsString()

      The template's file type, JSON or YAML.

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

      Returns:
      The template's file type, JSON or YAML.
      See Also:

    • toBuilder

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

    • builder

      public static CreateQueueEnvironmentRequest.Builder builder()

    • serializableBuilderClass

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