Interface IngestDataRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentCoreRequest.Builder, Buildable, CopyableBuilder<IngestDataRequest.Builder,IngestDataRequest>, SdkBuilder<IngestDataRequest.Builder,IngestDataRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
IngestDataRequest
@Mutable @NotThreadSafe public static interface IngestDataRequest.Builder extends BedrockAgentCoreRequest.Builder, SdkPojo, CopyableBuilder<IngestDataRequest.Builder,IngestDataRequest>

  • Method Details

    • memoryId

      IngestDataRequest.Builder memoryId(String memoryId)

      The identifier of the AgentCore Memory resource to ingest content into.

      Parameters:
      memoryId - The identifier of the AgentCore Memory resource to ingest content into.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      IngestDataRequest.Builder source(ContentSource source)

      The content to ingest. Only inline content is supported.

      Parameters:
      source - The content to ingest. Only inline content is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      default IngestDataRequest.Builder source(Consumer<ContentSource.Builder> source)

      The content to ingest. Only inline content is supported.

      This is a convenience method that creates an instance of the ContentSource.Builder avoiding the need to create one manually via ContentSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to source(ContentSource).

      Parameters:
      source - a consumer that will call methods on ContentSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentTimestamp

      IngestDataRequest.Builder contentTimestamp(Instant contentTimestamp)

      The timestamp of when the content occurred.

      Parameters:
      contentTimestamp - The timestamp of when the content occurred.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actorId

      IngestDataRequest.Builder actorId(String actorId)

      The identifier of the actor associated with this content. An actor represents an entity that participates in sessions and generates content.

      Parameters:
      actorId - The identifier of the actor associated with this content. An actor represents an entity that participates in sessions and generates content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionId

      IngestDataRequest.Builder sessionId(String sessionId)

      The identifier of the session that the content belongs to. If not provided, a session identifier is generated and returned in the response.

      Parameters:
      sessionId - The identifier of the session that the content belongs to. If not provided, a session identifier is generated and returned in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • extractionConfig

      IngestDataRequest.Builder extractionConfig(ExtractionConfig extractionConfig)

      The extraction configuration for long-term memory records. Use this parameter to specify namespace variable keys and their values for namespace substitution during extraction.

      Parameters:
      extractionConfig - The extraction configuration for long-term memory records. Use this parameter to specify namespace variable keys and their values for namespace substitution during extraction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • extractionConfig

      default IngestDataRequest.Builder extractionConfig(Consumer<ExtractionConfig.Builder> extractionConfig)

      The extraction configuration for long-term memory records. Use this parameter to specify namespace variable keys and their values for namespace substitution during extraction.

      This is a convenience method that creates an instance of the ExtractionConfig.Builder avoiding the need to create one manually via ExtractionConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to extractionConfig(ExtractionConfig).

      Parameters:
      extractionConfig - a consumer that will call methods on ExtractionConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadata

      IngestDataRequest.Builder metadata(Map<String,MetadataValue> metadata)

      The key-value metadata to attach to the content.

      Parameters:
      metadata - The key-value metadata to attach to the content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      IngestDataRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, AgentCore ignores the request, but does not return an error.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, AgentCore ignores the request, but does not return an error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      IngestDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      IngestDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.