Interface ReturnControlPayload.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ReturnControlPayload.Builder,ReturnControlPayload>, SdkBuilder<ReturnControlPayload.Builder,ReturnControlPayload>, SdkPojo
All Known Subinterfaces:
DefaultReturnControl.Builder
All Known Implementing Classes:
ReturnControlPayload.BuilderImpl
Enclosing class:
ReturnControlPayload

@Mutable @NotThreadSafe public static interface ReturnControlPayload.Builder extends SdkPojo, CopyableBuilder<ReturnControlPayload.Builder,ReturnControlPayload>
  • Method Details

    • invocationId

      ReturnControlPayload.Builder invocationId(String invocationId)

      The identifier of the action group invocation.

      Parameters:
      invocationId - The identifier of the action group invocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • invocationInputs

      ReturnControlPayload.Builder invocationInputs(Collection<InvocationInputMember> invocationInputs)

      A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.

      Parameters:
      invocationInputs - A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • invocationInputs

      ReturnControlPayload.Builder invocationInputs(InvocationInputMember... invocationInputs)

      A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.

      Parameters:
      invocationInputs - A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • invocationInputs

      A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.

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

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

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