java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.lambda.model.LambdaRequest
    - - software.amazon.awssdk.services.lambda.model.InvokeRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<InvokeRequest.Builder,InvokeRequest>

@Generated("software.amazon.awssdk:codegen")
public final class InvokeRequest
extends LambdaRequest
implements ToCopyableBuilder<InvokeRequest.Builder,InvokeRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InvokeRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static InvokeRequest.Builder`	`builder()`
`String`	`clientContext()`	Up to 3,583 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 or ARN 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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - functionName
```
public final 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.
    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.
  - invocationType
```
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 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.
    
    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().
    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
  - invocationTypeAsString
```
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 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.
    
    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().
    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
  - logType
```
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().
    
    Returns:
    
    Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
    
    See Also:
    
    LogType
  - logTypeAsString
```
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().
    
    Returns:
    
    Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
    
    See Also:
    
    LogType
  - clientContext
```
public final 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.
    
    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.
  - payload
```
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.
    
    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.
  - qualifier
```
public final String qualifier()
```
    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.
  - toBuilder
```
public InvokeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InvokeRequest.Builder,InvokeRequest>
    
    Specified by:
    
    toBuilder in class LambdaRequest
  - builder
```
public static InvokeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InvokeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class InvokeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

functionName

invocationType

invocationTypeAsString

logType

logTypeAsString

clientContext

payload

qualifier

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields