Class BedrockFunctionTarget

java.lang.Object
software.amazon.awssdk.services.elementalinference.model.BedrockFunctionTarget
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BedrockFunctionTarget.Builder,BedrockFunctionTarget>

@Generated("software.amazon.awssdk:codegen") public final class BedrockFunctionTarget extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BedrockFunctionTarget.Builder,BedrockFunctionTarget>

An Amazon Bedrock model to invoke. Elemental Inference invokes the model in your account by assuming the feed's access role, so a feed that runs this function must specify an accessRoleArn. The invocation is subject to your Amazon Bedrock quotas and appears on your bill.

See Also:
  • Method Details

    • api

      public final BedrockApi api()

      The Amazon Bedrock API to call. The only valid value is INVOKE_MODEL.

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

      Returns:
      The Amazon Bedrock API to call. The only valid value is INVOKE_MODEL.
      See Also:
    • apiAsString

      public final String apiAsString()

      The Amazon Bedrock API to call. The only valid value is INVOKE_MODEL.

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

      Returns:
      The Amazon Bedrock API to call. The only valid value is INVOKE_MODEL.
      See Also:
    • model

      public final String model()

      The model to invoke. Specify one of the following:

      • A model ID.

      • An inference profile ID.

      • The ARN of a custom model.

      • The ARN of a provisioned model.

      Elemental Inference invokes the model in the Region of the feed. To use a model in other Regions, specify a cross-Region inference profile ID. A custom or provisioned model must be in the Region of the feed.

      The request expression must produce a request body that this model accepts, and the model must accept the kind of media that the request expression references. For example, a text-only model can't accept a request that references media.frames.

      Returns:
      The model to invoke. Specify one of the following:

      • A model ID.

      • An inference profile ID.

      • The ARN of a custom model.

      • The ARN of a provisioned model.

      Elemental Inference invokes the model in the Region of the feed. To use a model in other Regions, specify a cross-Region inference profile ID. A custom or provisioned model must be in the Region of the feed.

      The request expression must produce a request body that this model accepts, and the model must accept the kind of media that the request expression references. For example, a text-only model can't accept a request that references media.frames.

    • toBuilder

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

      public static BedrockFunctionTarget.Builder builder()
    • serializableBuilderClass

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