Interface CreateEventRequest.Builder

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

  • Method Details

    • memoryId

      CreateEventRequest.Builder memoryId(String memoryId)

      The identifier of the memory store in which to create the event.

      Parameters:
      memoryId - The identifier of the memory store in which to create the event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actorId

      CreateEventRequest.Builder actorId(String actorId)

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

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

    • sessionId

      CreateEventRequest.Builder sessionId(String sessionId)

      The identifier of the session in which this event occurs. A session represents a sequence of related events.

      Parameters:
      sessionId - The identifier of the session in which this event occurs. A session represents a sequence of related events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventTimestamp

      CreateEventRequest.Builder eventTimestamp(Instant eventTimestamp)

      The timestamp when the event occurred. If not specified, the current time is used.

      Parameters:
      eventTimestamp - The timestamp when the event occurred. If not specified, the current time is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      CreateEventRequest.Builder payload(Collection<PayloadType> payload)

      The content payload of the event. This can include conversational data or binary content.

      Parameters:
      payload - The content payload of the event. This can include conversational data or binary content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      CreateEventRequest.Builder payload(PayloadType... payload)

      The content payload of the event. This can include conversational data or binary content.

      Parameters:
      payload - The content payload of the event. This can include conversational data or binary content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      CreateEventRequest.Builder payload(Consumer<PayloadType.Builder>... payload)

      The content payload of the event. This can include conversational data or binary content.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to payload(List<PayloadType>).

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

    • branch

      CreateEventRequest.Builder branch(Branch branch)

      The branch information for this event. Branches allow for organizing events into different conversation threads or paths.

      Parameters:
      branch - The branch information for this event. Branches allow for organizing events into different conversation threads or paths.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • branch

      default CreateEventRequest.Builder branch(Consumer<Branch.Builder> branch)

      The branch information for this event. Branches allow for organizing events into different conversation threads or paths.

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

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

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

    • clientToken

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

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

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