Class InvokeAgentRuntimeRequest

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.InvokeAgentRuntimeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<InvokeAgentRuntimeRequest.Builder,InvokeAgentRuntimeRequest>
@Generated("software.amazon.awssdk:codegen") public final class InvokeAgentRuntimeRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<InvokeAgentRuntimeRequest.Builder,InvokeAgentRuntimeRequest>

  • Method Details

    • contentType

      public final String contentType()

      The MIME type of the input data in the payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.

      Returns:
      The MIME type of the input data in the payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.

    • accept

      public final String accept()

      The desired MIME type for the response from the agent runtime. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.

      Returns:
      The desired MIME type for the response from the agent runtime. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.

    • mcpSessionId

      public final String mcpSessionId()

      The identifier of the MCP session.

      Returns:
      The identifier of the MCP session.

    • runtimeSessionId

      public final String runtimeSessionId()

      The identifier of the runtime session.

      Returns:
      The identifier of the runtime session.

    • mcpProtocolVersion

      public final String mcpProtocolVersion()

      The version of the MCP protocol being used.

      Returns:
      The version of the MCP protocol being used.

    • runtimeUserId

      public final String runtimeUserId()

      The identifier of the runtime user.

      Returns:
      The identifier of the runtime user.

    • traceId

      public final String traceId()

      The trace identifier for request tracking.

      Returns:
      The trace identifier for request tracking.

    • traceParent

      public final String traceParent()

      The parent trace information for distributed tracing.

      Returns:
      The parent trace information for distributed tracing.

    • traceState

      public final String traceState()

      The trace state information for distributed tracing.

      Returns:
      The trace state information for distributed tracing.

    • baggage

      public final String baggage()

      Additional context information for distributed tracing.

      Returns:
      Additional context information for distributed tracing.

    • agentRuntimeArn

      public final String agentRuntimeArn()

      The Amazon Web Services Resource Name (ARN) of the agent runtime to invoke. The ARN uniquely identifies the agent runtime resource in Amazon Bedrock.

      Returns:
      The Amazon Web Services Resource Name (ARN) of the agent runtime to invoke. The ARN uniquely identifies the agent runtime resource in Amazon Bedrock.

    • qualifier

      public final String qualifier()

      The qualifier to use for the agent runtime. This can be a version number or an alias name that points to a specific version. If not specified, Amazon Bedrock uses the default version of the agent runtime.

      Returns:
      The qualifier to use for the agent runtime. This can be a version number or an alias name that points to a specific version. If not specified, Amazon Bedrock uses the default version of the agent runtime.

    • payload

      public final SdkBytes payload()

      The input data to send to the agent runtime. The format of this data depends on the specific agent configuration and must match the specified content type. For most agents, this is a JSON object containing the user's request.

      Returns:
      The input data to send to the agent runtime. The format of this data depends on the specific agent configuration and must match the specified content type. For most agents, this is a JSON object containing the user's request.

    • toBuilder

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

    • builder

      public static InvokeAgentRuntimeRequest.Builder builder()

    • serializableBuilderClass

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