Class ProvisionedModelSummary

java.lang.Object
software.amazon.awssdk.services.bedrock.model.ProvisionedModelSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ProvisionedModelSummary.Builder,ProvisionedModelSummary>
@Generated("software.amazon.awssdk:codegen") public final class ProvisionedModelSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProvisionedModelSummary.Builder,ProvisionedModelSummary>

A summary of information about a Provisioned Throughput.

This data type is used in the following API operations:

See Also:

  • Method Details

    • provisionedModelName

      public final String provisionedModelName()

      The name of the Provisioned Throughput.

      Returns:
      The name of the Provisioned Throughput.

    • provisionedModelArn

      public final String provisionedModelArn()

      The Amazon Resource Name (ARN) of the Provisioned Throughput.

      Returns:
      The Amazon Resource Name (ARN) of the Provisioned Throughput.

    • modelArn

      public final String modelArn()

      The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.

      Returns:
      The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.

    • desiredModelArn

      public final String desiredModelArn()

      The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.

      Returns:
      The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.

    • foundationModelArn

      public final String foundationModelArn()

      The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.

      Returns:
      The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.

    • modelUnits

      public final Integer modelUnits()

      The number of model units allocated to the Provisioned Throughput.

      Returns:
      The number of model units allocated to the Provisioned Throughput.

    • desiredModelUnits

      public final Integer desiredModelUnits()

      The number of model units that was requested to be allocated to the Provisioned Throughput.

      Returns:
      The number of model units that was requested to be allocated to the Provisioned Throughput.

    • status

      public final ProvisionedModelStatus status()

      The status of the Provisioned Throughput.

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

      Returns:
      The status of the Provisioned Throughput.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the Provisioned Throughput.

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

      Returns:
      The status of the Provisioned Throughput.
      See Also:

    • commitmentDuration

      public final CommitmentDuration commitmentDuration()

      The duration for which the Provisioned Throughput was committed.

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

      Returns:
      The duration for which the Provisioned Throughput was committed.
      See Also:

    • commitmentDurationAsString

      public final String commitmentDurationAsString()

      The duration for which the Provisioned Throughput was committed.

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

      Returns:
      The duration for which the Provisioned Throughput was committed.
      See Also:

    • commitmentExpirationTime

      public final Instant commitmentExpirationTime()

      The timestamp for when the commitment term of the Provisioned Throughput expires.

      Returns:
      The timestamp for when the commitment term of the Provisioned Throughput expires.

    • creationTime

      public final Instant creationTime()

      The time that the Provisioned Throughput was created.

      Returns:
      The time that the Provisioned Throughput was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time that the Provisioned Throughput was last modified.

      Returns:
      The time that the Provisioned Throughput was last modified.

    • toBuilder

      public ProvisionedModelSummary.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<ProvisionedModelSummary.Builder,ProvisionedModelSummary>
      Returns:
      a builder for type T

    • builder

      public static ProvisionedModelSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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