Class InvocationInput

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

Contains information pertaining to the action group or knowledge base that is being invoked.

See Also:

  • Method Details

    • actionGroupInvocationInput

      public final ActionGroupInvocationInput actionGroupInvocationInput()

      Contains information about the action group to be invoked.

      Returns:
      Contains information about the action group to be invoked.

    • codeInterpreterInvocationInput

      public final CodeInterpreterInvocationInput codeInterpreterInvocationInput()

      Contains information about the code interpreter to be invoked.

      Returns:
      Contains information about the code interpreter to be invoked.

    • invocationType

      public final InvocationType invocationType()

      Specifies whether the agent is invoking an action group or a knowledge base.

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

      Returns:
      Specifies whether the agent is invoking an action group or a knowledge base.
      See Also:

    • invocationTypeAsString

      public final String invocationTypeAsString()

      Specifies whether the agent is invoking an action group or a knowledge base.

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

      Returns:
      Specifies whether the agent is invoking an action group or a knowledge base.
      See Also:

    • knowledgeBaseLookupInput

      public final KnowledgeBaseLookupInput knowledgeBaseLookupInput()

      Contains details about the knowledge base to look up and the query to be made.

      Returns:
      Contains details about the knowledge base to look up and the query to be made.

    • traceId

      public final String traceId()

      The unique identifier of the trace.

      Returns:
      The unique identifier of the trace.

    • toBuilder

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

    • builder

      public static InvocationInput.Builder builder()

    • serializableBuilderClass

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