Class DescribeReservedCapacityResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
software.amazon.awssdk.services.sagemaker.model.DescribeReservedCapacityResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeReservedCapacityResponse.Builder,DescribeReservedCapacityResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeReservedCapacityResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeReservedCapacityResponse.Builder,DescribeReservedCapacityResponse>

  • Method Details

    • reservedCapacityArn

      public final String reservedCapacityArn()

      ARN of the reserved capacity.

      Returns:
      ARN of the reserved capacity.

    • reservedCapacityType

      public final ReservedCapacityType reservedCapacityType()

      The type of reserved capacity.

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

      Returns:
      The type of reserved capacity.
      See Also:

    • reservedCapacityTypeAsString

      public final String reservedCapacityTypeAsString()

      The type of reserved capacity.

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

      Returns:
      The type of reserved capacity.
      See Also:

    • status

      public final ReservedCapacityStatus status()

      The current status of the reserved capacity.

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

      Returns:
      The current status of the reserved capacity.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the reserved capacity.

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

      Returns:
      The current status of the reserved capacity.
      See Also:

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone where the reserved capacity is provisioned.

      Returns:
      The Availability Zone where the reserved capacity is provisioned.

    • durationHours

      public final Long durationHours()

      The total duration of the reserved capacity in hours.

      Returns:
      The total duration of the reserved capacity in hours.

    • durationMinutes

      public final Long durationMinutes()

      The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35.

      Returns:
      The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35.

    • startTime

      public final Instant startTime()

      The timestamp when the reserved capacity becomes active.

      Returns:
      The timestamp when the reserved capacity becomes active.

    • endTime

      public final Instant endTime()

      The timestamp when the reserved capacity expires.

      Returns:
      The timestamp when the reserved capacity expires.

    • instanceType

      public final ReservedCapacityInstanceType instanceType()

      The Amazon EC2 instance type used in the reserved capacity.

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

      Returns:
      The Amazon EC2 instance type used in the reserved capacity.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The Amazon EC2 instance type used in the reserved capacity.

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

      Returns:
      The Amazon EC2 instance type used in the reserved capacity.
      See Also:

    • totalInstanceCount

      public final Integer totalInstanceCount()

      The total number of instances allocated to this reserved capacity.

      Returns:
      The total number of instances allocated to this reserved capacity.

    • availableInstanceCount

      public final Integer availableInstanceCount()

      The number of instances currently available for use in this reserved capacity.

      Returns:
      The number of instances currently available for use in this reserved capacity.

    • inUseInstanceCount

      public final Integer inUseInstanceCount()

      The number of instances currently in use from this reserved capacity.

      Returns:
      The number of instances currently in use from this reserved capacity.

    • ultraServerSummary

      public final UltraServerSummary ultraServerSummary()

      A summary of the UltraServer associated with this reserved capacity.

      Returns:
      A summary of the UltraServer associated with this reserved capacity.

    • toBuilder

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

    • builder

      public static DescribeReservedCapacityResponse.Builder builder()

    • serializableBuilderClass

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