Class CustomModelSummary

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

Summary information for a custom model.

See Also:

  • Method Details

    • modelArn

      public final String modelArn()

      The Amazon Resource Name (ARN) of the custom model.

      Returns:
      The Amazon Resource Name (ARN) of the custom model.

    • modelName

      public final String modelName()

      The name of the custom model.

      Returns:
      The name of the custom model.

    • creationTime

      public final Instant creationTime()

      Creation time of the model.

      Returns:
      Creation time of the model.

    • baseModelArn

      public final String baseModelArn()

      The base model Amazon Resource Name (ARN).

      Returns:
      The base model Amazon Resource Name (ARN).

    • baseModelName

      public final String baseModelName()

      The base model name.

      Returns:
      The base model name.

    • customizationType

      public final CustomizationType customizationType()

      Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

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

      Returns:
      Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.
      See Also:

    • customizationTypeAsString

      public final String customizationTypeAsString()

      Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

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

      Returns:
      Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.
      See Also:

    • ownerAccountId

      public final String ownerAccountId()

      The unique identifier of the account that owns the model.

      Returns:
      The unique identifier of the account that owns the model.

    • modelStatus

      public final ModelStatus modelStatus()

      The current status of the custom model. Possible values include:

      • Creating - The model is being created and validated.

      • Active - The model has been successfully created and is ready for use.

      • Failed - The model creation process failed.

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

      Returns:
      The current status of the custom model. Possible values include:

      • Creating - The model is being created and validated.

      • Active - The model has been successfully created and is ready for use.

      • Failed - The model creation process failed.

      See Also:

    • modelStatusAsString

      public final String modelStatusAsString()

      The current status of the custom model. Possible values include:

      • Creating - The model is being created and validated.

      • Active - The model has been successfully created and is ready for use.

      • Failed - The model creation process failed.

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

      Returns:
      The current status of the custom model. Possible values include:

      • Creating - The model is being created and validated.

      • Active - The model has been successfully created and is ready for use.

      • Failed - The model creation process failed.

      See Also:

    • toBuilder

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

    • builder

      public static CustomModelSummary.Builder builder()

    • serializableBuilderClass

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