All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InvokeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  InvokeRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  InvokeRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getClientContext () Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
  String	getFunctionName () The name or ARN of the Lambda function, version, or alias.
  String	getInvocationType () Choose from the following options.
  String	getLogType () Set to Tail to include the execution log in the response.
  ByteBuffer	getPayload () The JSON that you want to provide to your Lambda function as input.
  String	getQualifier () Specify a version or alias to invoke a published version of the function.
  int	hashCode ()
  void	setClientContext (String clientContext) Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
  void	setFunctionName (String functionName) The name or ARN of the Lambda function, version, or alias.
  void	setInvocationType (InvocationType invocationType) Choose from the following options.
  void	setInvocationType (String invocationType) Choose from the following options.
  void	setLogType (LogType logType) Set to Tail to include the execution log in the response.
  void	setLogType (String logType) Set to Tail to include the execution log in the response.
  void	setPayload (ByteBuffer payload) The JSON that you want to provide to your Lambda function as input.
  void	setPayload (String payload) The JSON that you want to provide to your Lambda function as input.
  void	setQualifier (String qualifier) Specify a version or alias to invoke a published version of the function.
  String	toString () Returns a string representation of this object.
  InvokeRequest	withClientContext (String clientContext) Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
  InvokeRequest	withFunctionName (String functionName) The name or ARN of the Lambda function, version, or alias.
  InvokeRequest	withInvocationType (InvocationType invocationType) Choose from the following options.
  InvokeRequest	withInvocationType (String invocationType) Choose from the following options.
  InvokeRequest	withLogType (LogType logType) Set to Tail to include the execution log in the response.
  InvokeRequest	withLogType (String logType) Set to Tail to include the execution log in the response.
  InvokeRequest	withPayload (ByteBuffer payload) The JSON that you want to provide to your Lambda function as input.
  InvokeRequest	withPayload (String payload) The JSON that you want to provide to your Lambda function as input.
  InvokeRequest	withQualifier (String qualifier) Specify a version or alias to invoke a published version of the function.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • InvokeRequest

    public InvokeRequest()

• Method Detail

  • setFunctionName

    public void setFunctionName(String functionName)

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

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

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

    You can append a version number or alias to any of the formats. 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, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

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

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

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • getFunctionName

    public String getFunctionName()

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

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

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

    You can append a version number or alias to any of the formats. 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:

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

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

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

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • withFunctionName

    public InvokeRequest withFunctionName(String functionName)

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

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

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

    You can append a version number or alias to any of the formats. 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, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

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

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

    You can append a version number or alias to any of the formats. 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.

  • setInvocationType

    public void setInvocationType(String invocationType)

    Choose from the following options.

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

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

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

    Parameters:

    invocationType - Choose from the following options.

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

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

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

    See Also:

    InvocationType

  • getInvocationType

    public String getInvocationType()

    Choose from the following options.

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

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

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

    Returns:

    Choose from the following options.

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

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

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

    See Also:

    InvocationType

  • withInvocationType

    public InvokeRequest withInvocationType(String invocationType)

    Choose from the following options.

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

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

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

    Parameters:

    invocationType - Choose from the following options.

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

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

    • DryRun – Validate parameter values and verify that the 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

  • setInvocationType

    public void setInvocationType(InvocationType invocationType)

    Choose from the following options.

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

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

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

    Parameters:

    invocationType - Choose from the following options.

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

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

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

    See Also:

    InvocationType

  • withInvocationType

    public InvokeRequest withInvocationType(InvocationType invocationType)

    Choose from the following options.

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

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

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

    Parameters:

    invocationType - Choose from the following options.

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

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

    • DryRun – Validate parameter values and verify that the 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

  • setLogType

    public void setLogType(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.

    See Also:

    LogType

  • getLogType

    public String getLogType()

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

    Returns:

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

    See Also:

    LogType

  • withLogType

    public InvokeRequest withLogType(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

  • setLogType

    public void setLogType(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.

    See Also:

    LogType

  • withLogType

    public InvokeRequest withLogType(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:

    LogType

  • setClientContext

    public void setClientContext(String clientContext)

    Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

    Parameters:

    clientContext - Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

  • getClientContext

    public String getClientContext()

    Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

    Returns:

    Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

  • withClientContext

    public InvokeRequest withClientContext(String clientContext)

    Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

    Parameters:

    clientContext - Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

    Returns:

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

  • setPayload

    public void setPayload(ByteBuffer 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.

    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

    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.

  • getPayload

    public ByteBuffer getPayload()

    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.

    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

    Returns:

    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.

  • withPayload

    public InvokeRequest withPayload(ByteBuffer 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.

    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

    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.

  • setPayload

    public void setPayload(String 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.

    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

    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.

  • withPayload

    public InvokeRequest withPayload(String 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.

    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

    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.

  • setQualifier

    public void setQualifier(String qualifier)

    Specify a version or alias to invoke a published version of the function.

    Parameters:

    qualifier - Specify a version or alias to invoke a published version of the function.

  • getQualifier

    public String getQualifier()

    Specify a version or alias to invoke a published version of the function.

    Returns:

    Specify a version or alias to invoke a published version of the function.

  • withQualifier

    public InvokeRequest withQualifier(String qualifier)

    Specify a version or alias to invoke a published version of the function.

    Parameters:

    qualifier - Specify a version or alias to invoke a published version of the function.

    Returns:

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

  • toString

    public String toString()

    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

    Overrides:

    toString in class Object

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public InvokeRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()