Class InferenceProfileSummary

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

Contains information about an inference profile.

See Also:

  • Method Details

    • inferenceProfileName

      public final String inferenceProfileName()

      The name of the inference profile.

      Returns:
      The name of the inference profile.

    • description

      public final String description()

      The description of the inference profile.

      Returns:
      The description of the inference profile.

    • createdAt

      public final Instant createdAt()

      The time at which the inference profile was created.

      Returns:
      The time at which the inference profile was created.

    • updatedAt

      public final Instant updatedAt()

      The time at which the inference profile was last updated.

      Returns:
      The time at which the inference profile was last updated.

    • inferenceProfileArn

      public final String inferenceProfileArn()

      The Amazon Resource Name (ARN) of the inference profile.

      Returns:
      The Amazon Resource Name (ARN) of the inference profile.

    • hasModels

      public final boolean hasModels()
      For responses, this returns true if the service returned a value for the Models property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • models

      public final List<InferenceProfileModel> models()

      A list of information about each model in the inference profile.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasModels() method.

      Returns:
      A list of information about each model in the inference profile.

    • inferenceProfileId

      public final String inferenceProfileId()

      The unique identifier of the inference profile.

      Returns:
      The unique identifier of the inference profile.

    • status

      public final InferenceProfileStatus status()

      The status of the inference profile. ACTIVE means that the inference profile is ready to be used.

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

      Returns:
      The status of the inference profile. ACTIVE means that the inference profile is ready to be used.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the inference profile. ACTIVE means that the inference profile is ready to be used.

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

      Returns:
      The status of the inference profile. ACTIVE means that the inference profile is ready to be used.
      See Also:

    • type

      public final InferenceProfileType type()

      The type of the inference profile. The following types are possible:

      • SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

      • APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

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

      Returns:
      The type of the inference profile. The following types are possible:

      • SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

      • APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the inference profile. The following types are possible:

      • SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

      • APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

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

      Returns:
      The type of the inference profile. The following types are possible:

      • SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

      • APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

      See Also:

    • toBuilder

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

    • builder

      public static InferenceProfileSummary.Builder builder()

    • serializableBuilderClass

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