Package software.amazon.awssdk.services.lambda.model

Interface InvokeWithResponseStreamRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<InvokeWithResponseStreamRequest.Builder,InvokeWithResponseStreamRequest>, LambdaRequest.Builder, SdkBuilder<InvokeWithResponseStreamRequest.Builder,InvokeWithResponseStreamRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
InvokeWithResponseStreamRequest
public static interface InvokeWithResponseStreamRequest.Builder extends LambdaRequest.Builder, SdkPojo, CopyableBuilder<InvokeWithResponseStreamRequest.Builder,InvokeWithResponseStreamRequest>

  • Method Details

    • functionName

      InvokeWithResponseStreamRequest.Builder functionName(String functionName)

      The name or ARN of the Lambda function.

      Name formats

      • Function name – my-function.

      • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

      • Partial ARN – 123456789012:function:my-function.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

      Parameters:
      functionName - The name or ARN of the Lambda function.

      Name formats

      • Function name – my-function.

      • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

      • Partial ARN – 123456789012:function:my-function.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • invocationType

      InvokeWithResponseStreamRequest.Builder invocationType(String invocationType)

      Use one of the following options:

      • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.

      • DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.

      Parameters:
      invocationType - Use one of the following options:

      • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.

      • DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • invocationType

      InvokeWithResponseStreamRequest.Builder invocationType(ResponseStreamingInvocationType invocationType)

      Use one of the following options:

      • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.

      • DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.

      Parameters:
      invocationType - Use one of the following options:

      • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.

      • DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logType

      InvokeWithResponseStreamRequest.Builder logType(String logType)

      Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

      Parameters:
      logType - Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logType

      InvokeWithResponseStreamRequest.Builder logType(LogType logType)

      Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

      Parameters:
      logType - Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientContext

      InvokeWithResponseStreamRequest.Builder clientContext(String clientContext)

      Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

      Parameters:
      clientContext - Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qualifier

      InvokeWithResponseStreamRequest.Builder qualifier(String qualifier)

      The alias name.

      Parameters:
      qualifier - The alias name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      InvokeWithResponseStreamRequest.Builder payload(SdkBytes payload)

      The JSON that you want to provide to your Lambda function as input.

      You can enter the JSON directly. For example, --payload '{ "key": "value" }'. You can also specify a file path. For example, --payload file://payload.json.

      Parameters:
      payload - The JSON that you want to provide to your Lambda function as input.

      You can enter the JSON directly. For example, --payload '{ "key": "value" }'. You can also specify a file path. For example, --payload file://payload.json.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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