@Generated(value="software.amazon.awssdk:codegen") public final class InvokeRequest extends LambdaRequest implements ToCopyableBuilder<InvokeRequest.Builder,InvokeRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
InvokeRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static InvokeRequest.Builder |
builder() |
String |
clientContext()
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
functionName()
The name of the Lambda function, version, or alias.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
InvocationType |
invocationType()
Choose from the following options.
|
String |
invocationTypeAsString()
Choose from the following options.
|
LogType |
logType()
Set to
Tail to include the execution log in the response. |
String |
logTypeAsString()
Set to
Tail to include the execution log in the response. |
SdkBytes |
payload()
The JSON that you want to provide to your Lambda function as input.
|
String |
qualifier()
Specify a version or alias to invoke a published version of the function.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends InvokeRequest.Builder> |
serializableBuilderClass() |
InvokeRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String 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.
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 final 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 it's 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.
If the service returns an enum value that is not available in the current SDK version, invocationType
will return InvocationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from invocationTypeAsString()
.
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 it's 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.
InvocationType
public final String invocationTypeAsString()
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 it's 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.
If the service returns an enum value that is not available in the current SDK version, invocationType
will return InvocationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from invocationTypeAsString()
.
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 it's 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.
InvocationType
public final LogType logType()
Set to Tail
to include the execution log in the response. Applies to synchronously invoked functions
only.
If the service returns an enum value that is not available in the current SDK version, logType
will
return LogType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
logTypeAsString()
.
Tail
to include the execution log in the response. Applies to synchronously invoked
functions only.LogType
public final String logTypeAsString()
Set to Tail
to include the execution log in the response. Applies to synchronously invoked functions
only.
If the service returns an enum value that is not available in the current SDK version, logType
will
return LogType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
logTypeAsString()
.
Tail
to include the execution log in the response. Applies to synchronously invoked
functions only.LogType
public final String clientContext()
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
public final 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
.
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 final String qualifier()
Specify a version or alias to invoke a published version of the function.
public InvokeRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<InvokeRequest.Builder,InvokeRequest>
toBuilder
in class LambdaRequest
public static InvokeRequest.Builder builder()
public static Class<? extends InvokeRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.