Class CreateLimitRequest

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

  • 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.

    • displayName

      public final String displayName()

      The display name of the limit.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      The display name of the limit.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • amountRequirementName

      public final String amountRequirementName()

      The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.

      Returns:
      The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.

    • maxCount

      public final Integer maxCount()

      The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

      The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

      Returns:
      The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

      The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

    • farmId

      public final String farmId()

      The farm ID of the farm that contains the limit.

      Returns:
      The farm ID of the farm that contains the limit.

    • description

      public final String description()

      A description of the limit. A description helps you identify the purpose of the limit.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      A description of the limit. A description helps you identify the purpose of the limit.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • toBuilder

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

    • builder

      public static CreateLimitRequest.Builder builder()

    • serializableBuilderClass

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