@Generated(value="software.amazon.awssdk:codegen") public class InvokeResponse extends LambdaResponse implements ToCopyableBuilder<InvokeResponse.Builder,InvokeResponse>
Upon success, returns an empty response. Otherwise, throws an exception.
Modifier and Type | Class and Description |
---|---|
static interface |
InvokeResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static InvokeResponse.Builder |
builder() |
boolean |
equals(Object obj) |
String |
executedVersion()
The function version that has been executed.
|
String |
functionError()
Indicates whether an error occurred while executing the Lambda function.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
String |
logResult()
It is the base64-encoded logs for the Lambda function invocation.
|
ByteBuffer |
payload()
It is the JSON representation of the object returned by the Lambda function.
|
static Class<? extends InvokeResponse.Builder> |
serializableBuilderClass() |
Integer |
statusCode()
The HTTP status code will be in the 200 range for successful request.
|
InvokeResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public Integer statusCode()
The HTTP status code will be in the 200 range for successful request. For the RequestResponse
invocation type this status code will be 200. For the Event
invocation type this status code will be
202. For the DryRun
invocation type the status code will be 204.
RequestResponse
invocation type this status code will be 200. For the Event
invocation type this status code will be 202. For the DryRun
invocation type the status code
will be 204.public String functionError()
Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will
have one of two values; Handled
or Unhandled
. Handled
errors are errors
that are reported by the function while the Unhandled
errors are those detected and reported by AWS
Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report
an Handled
error, see Programming Model.
Handled
or Unhandled
. Handled
errors
are errors that are reported by the function while the Unhandled
errors are those detected
and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For
information about how to report an Handled
error, see Programming Model.public String logResult()
It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is
RequestResponse
and the logs were requested.
RequestResponse
and the logs were requested.public ByteBuffer payload()
It is the JSON representation of the object returned by the Lambda function. This is present only if the
invocation type is RequestResponse
.
In the event of a function error this field contains a message describing the error. For the Handled
errors the Lambda function will report this message. For Unhandled
errors AWS Lambda reports the
message.
This method will return a new read-only ByteBuffer
each time it is invoked.
RequestResponse
.
In the event of a function error this field contains a message describing the error. For the
Handled
errors the Lambda function will report this message. For Unhandled
errors AWS Lambda reports the message.
public String executedVersion()
The function version that has been executed. This value is returned only if the invocation type is
RequestResponse
. For more information, see lambda-traffic-shifting-using-aliases.
RequestResponse
. For more information, see lambda-traffic-shifting-using-aliases.public InvokeResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<InvokeResponse.Builder,InvokeResponse>
toBuilder
in class AwsResponse
public static InvokeResponse.Builder builder()
public static Class<? extends InvokeResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.