Interface InvocationStep.Builder

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

  • Method Details

    • invocationId

      InvocationStep.Builder invocationId(String invocationId)

      The unique identifier (in UUID format) for the invocation that includes the invocation step.

      Parameters:
      invocationId - The unique identifier (in UUID format) for the invocation that includes the invocation step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • invocationStepId

      InvocationStep.Builder invocationStepId(String invocationStepId)

      The unique identifier (in UUID format) for the invocation step.

      Parameters:
      invocationStepId - The unique identifier (in UUID format) for the invocation step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • invocationStepTime

      InvocationStep.Builder invocationStepTime(Instant invocationStepTime)

      The timestamp for when the invocation step was created.

      Parameters:
      invocationStepTime - The timestamp for when the invocation step was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      InvocationStep.Builder payload(InvocationStepPayload payload)

      Payload content, such as text and images, for the invocation step.

      Parameters:
      payload - Payload content, such as text and images, for the invocation step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      default InvocationStep.Builder payload(Consumer<InvocationStepPayload.Builder> payload)

      Payload content, such as text and images, for the invocation step.

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

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

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

    • sessionId

      InvocationStep.Builder sessionId(String sessionId)

      The unique identifier of the session containing the invocation step.

      Parameters:
      sessionId - The unique identifier of the session containing the invocation step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.