/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.lambda.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class InvokeRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name 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. *
*/ private String functionName; /** ** 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.
*
* Set to Tail
to include the execution log in the response. Applies to synchronously invoked functions
* only.
*
* Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. *
*/ private String clientContext; /** ** 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
.
*
* Specify a version or alias to invoke a published version of the function. *
*/ private String qualifier; /** ** The name 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. *
* * @param functionName * The name 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. */ public void setFunctionName(String functionName) { this.functionName = functionName; } /** *
* The name 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. *
* * @return The name 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. */ public String getFunctionName() { return this.functionName; } /** *
* The name 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. *
* * @param functionName * The name 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. * @return Returns a reference to this object so that method calls can be chained together. */ public InvokeRequest withFunctionName(String functionName) { setFunctionName(functionName); return this; } /** *
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* Set to Tail
to include the execution log in the response. Applies to synchronously invoked functions
* only.
*
Tail
to include the execution log in the response. Applies to synchronously invoked
* functions only.
* @see LogType
*/
public void setLogType(String logType) {
this.logType = logType;
}
/**
*
* Set to Tail
to include the execution log in the response. Applies to synchronously invoked functions
* only.
*
Tail
to include the execution log in the response. Applies to synchronously invoked
* functions only.
* @see LogType
*/
public String getLogType() {
return this.logType;
}
/**
*
* Set to Tail
to include the execution log in the response. Applies to synchronously invoked functions
* only.
*
Tail
to include the execution log in the response. Applies to synchronously invoked
* functions only.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LogType
*/
public InvokeRequest withLogType(String logType) {
setLogType(logType);
return this;
}
/**
*
* Set to Tail
to include the execution log in the response. Applies to synchronously invoked functions
* only.
*
Tail
to include the execution log in the response. Applies to synchronously invoked
* functions only.
* @see LogType
*/
public void setLogType(LogType logType) {
withLogType(logType);
}
/**
*
* Set to Tail
to include the execution log in the response. Applies to synchronously invoked functions
* only.
*
Tail
to include the execution log in the response. Applies to synchronously invoked
* functions only.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LogType
*/
public InvokeRequest withLogType(LogType logType) {
this.logType = logType.toString();
return this;
}
/**
* * Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. *
* * @param clientContext * Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context * object. */ public void setClientContext(String clientContext) { this.clientContext = clientContext; } /** ** Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. *
* * @return Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context * object. */ public String getClientContext() { return this.clientContext; } /** ** Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. *
* * @param clientContext * Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context * object. * @return Returns a reference to this object so that method calls can be chained together. */ public InvokeRequest withClientContext(String clientContext) { setClientContext(clientContext); return this; } /** ** 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. *
* * @param 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
.
*/
public void setPayload(java.nio.ByteBuffer payload) {
this.payload = 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
.
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend * using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent * {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. * Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the * {@code position}. *
* * @return 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
.
*/
public java.nio.ByteBuffer getPayload() {
return this.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. *
* * @param 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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InvokeRequest withPayload(java.nio.ByteBuffer payload) {
setPayload(payload);
return this;
}
/**
*
* 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. *
* * @param 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
.
*/
public void setPayload(String payload) {
setPayload(new com.amazonaws.adapters.types.StringToByteBufferAdapter().adapt(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. *
* * @param 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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InvokeRequest withPayload(String payload) {
setPayload(new com.amazonaws.adapters.types.StringToByteBufferAdapter().adapt(payload));
return this;
}
/**
*
* Specify a version or alias to invoke a published version of the function. *
* * @param qualifier * Specify a version or alias to invoke a published version of the function. */ public void setQualifier(String qualifier) { this.qualifier = qualifier; } /** ** Specify a version or alias to invoke a published version of the function. *
* * @return Specify a version or alias to invoke a published version of the function. */ public String getQualifier() { return this.qualifier; } /** ** Specify a version or alias to invoke a published version of the function. *
* * @param qualifier * Specify a version or alias to invoke a published version of the function. * @return Returns a reference to this object so that method calls can be chained together. */ public InvokeRequest withQualifier(String qualifier) { setQualifier(qualifier); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getFunctionName() != null) sb.append("FunctionName: ").append(getFunctionName()).append(","); if (getInvocationType() != null) sb.append("InvocationType: ").append(getInvocationType()).append(","); if (getLogType() != null) sb.append("LogType: ").append(getLogType()).append(","); if (getClientContext() != null) sb.append("ClientContext: ").append(getClientContext()).append(","); if (getPayload() != null) sb.append("Payload: ").append("***Sensitive Data Redacted***").append(","); if (getQualifier() != null) sb.append("Qualifier: ").append(getQualifier()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof InvokeRequest == false) return false; InvokeRequest other = (InvokeRequest) obj; if (other.getFunctionName() == null ^ this.getFunctionName() == null) return false; if (other.getFunctionName() != null && other.getFunctionName().equals(this.getFunctionName()) == false) return false; if (other.getInvocationType() == null ^ this.getInvocationType() == null) return false; if (other.getInvocationType() != null && other.getInvocationType().equals(this.getInvocationType()) == false) return false; if (other.getLogType() == null ^ this.getLogType() == null) return false; if (other.getLogType() != null && other.getLogType().equals(this.getLogType()) == false) return false; if (other.getClientContext() == null ^ this.getClientContext() == null) return false; if (other.getClientContext() != null && other.getClientContext().equals(this.getClientContext()) == false) return false; if (other.getPayload() == null ^ this.getPayload() == null) return false; if (other.getPayload() != null && other.getPayload().equals(this.getPayload()) == false) return false; if (other.getQualifier() == null ^ this.getQualifier() == null) return false; if (other.getQualifier() != null && other.getQualifier().equals(this.getQualifier()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getFunctionName() == null) ? 0 : getFunctionName().hashCode()); hashCode = prime * hashCode + ((getInvocationType() == null) ? 0 : getInvocationType().hashCode()); hashCode = prime * hashCode + ((getLogType() == null) ? 0 : getLogType().hashCode()); hashCode = prime * hashCode + ((getClientContext() == null) ? 0 : getClientContext().hashCode()); hashCode = prime * hashCode + ((getPayload() == null) ? 0 : getPayload().hashCode()); hashCode = prime * hashCode + ((getQualifier() == null) ? 0 : getQualifier().hashCode()); return hashCode; } @Override public InvokeRequest clone() { return (InvokeRequest) super.clone(); } }