Class GetLimitResponse

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

  • Method Details

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

    • createdAt

      public final Instant createdAt()

      The Unix timestamp of the date and time that the limit was created.

      Returns:
      The Unix timestamp of the date and time that the limit was created.

    • createdBy

      public final String createdBy()

      The user identifier of the person that created the limit.

      Returns:
      The user identifier of the person that created the limit.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp of the date and time that the limit was last updated.

      Returns:
      The Unix timestamp of the date and time that the limit was last updated.

    • updatedBy

      public final String updatedBy()

      The user identifier of the person that last updated the limit.

      Returns:
      The user identifier of the person that last updated the limit.

    • farmId

      public final String farmId()

      The unique identifier of the farm that contains the limit.

      Returns:
      The unique identifier of the farm that contains the limit.

    • limitId

      public final String limitId()

      The unique identifier of the limit.

      Returns:
      The unique identifier of the limit.

    • currentCount

      public final Integer currentCount()

      The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.

      Returns:
      The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.

    • description

      public final String description()

      The description of the limit that helps identify what the limit is used for.

      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 description of the limit that helps identify what the limit is used for.

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

    • builder

      public static GetLimitResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetLimitResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.