Class InvokeHarnessRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.InvokeHarnessRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<InvokeHarnessRequest.Builder,InvokeHarnessRequest>
@Generated("software.amazon.awssdk:codegen") public final class InvokeHarnessRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<InvokeHarnessRequest.Builder,InvokeHarnessRequest>

  • Method Details

    • harnessArn

      public final String harnessArn()

      The ARN of the harness to invoke.

      Returns:
      The ARN of the harness to invoke.

    • runtimeSessionId

      public final String runtimeSessionId()

      The session ID for the invocation. Use the same session ID across requests to continue a conversation.

      Returns:
      The session ID for the invocation. Use the same session ID across requests to continue a conversation.

    • hasMessages

      public final boolean hasMessages()
      For responses, this returns true if the service returned a value for the Messages 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.

    • messages

      public final List<HarnessMessage> messages()

      The messages to send to the agent.

      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 hasMessages() method.

      Returns:
      The messages to send to the agent.

    • model

      public final HarnessModelConfiguration model()

      The model configuration to use for this invocation. If specified, overrides the harness default.

      Returns:
      The model configuration to use for this invocation. If specified, overrides the harness default.

    • hasSystemPrompt

      public final boolean hasSystemPrompt()
      For responses, this returns true if the service returned a value for the SystemPrompt 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.

    • systemPrompt

      public final List<HarnessSystemContentBlock> systemPrompt()

      The system prompt to use for this invocation. If specified, overrides the harness default.

      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 hasSystemPrompt() method.

      Returns:
      The system prompt to use for this invocation. If specified, overrides the harness default.

    • hasTools

      public final boolean hasTools()
      For responses, this returns true if the service returned a value for the Tools 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.

    • tools

      public final List<HarnessTool> tools()

      The tools available to the agent for this invocation. If specified, overrides the harness default.

      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 hasTools() method.

      Returns:
      The tools available to the agent for this invocation. If specified, overrides the harness default.

    • hasSkills

      public final boolean hasSkills()
      For responses, this returns true if the service returned a value for the Skills 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.

    • skills

      public final List<HarnessSkill> skills()

      The skills available to the agent for this invocation. If specified, overrides the harness default.

      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 hasSkills() method.

      Returns:
      The skills available to the agent for this invocation. If specified, overrides the harness default.

    • hasAllowedTools

      public final boolean hasAllowedTools()
      For responses, this returns true if the service returned a value for the AllowedTools 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.

    • allowedTools

      public final List<String> allowedTools()

      The tools that the agent is allowed to use for this invocation. If specified, overrides the harness default.

      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 hasAllowedTools() method.

      Returns:
      The tools that the agent is allowed to use for this invocation. If specified, overrides the harness default.

    • maxIterations

      public final Integer maxIterations()

      The maximum number of iterations the agent loop can execute. If specified, overrides the harness default.

      Returns:
      The maximum number of iterations the agent loop can execute. If specified, overrides the harness default.

    • maxTokens

      public final Integer maxTokens()

      The maximum number of tokens the agent can generate per iteration. If specified, overrides the harness default.

      Returns:
      The maximum number of tokens the agent can generate per iteration. If specified, overrides the harness default.

    • timeoutSeconds

      public final Integer timeoutSeconds()

      The maximum duration in seconds for the agent loop execution. If specified, overrides the harness default.

      Returns:
      The maximum duration in seconds for the agent loop execution. If specified, overrides the harness default.

    • actorId

      public final String actorId()

      The actor ID for memory operations. Overrides the actor ID configured on the harness.

      Returns:
      The actor ID for memory operations. Overrides the actor ID configured on the harness.

    • toBuilder

      public InvokeHarnessRequest.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<InvokeHarnessRequest.Builder,InvokeHarnessRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest
      Returns:
      a builder for type T

    • builder

      public static InvokeHarnessRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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