software.amazon.awssdk.services.lambda.model.InvokeResponse Maven / Gradle / Ivy
/*
* Copyright 2013-2018 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 software.amazon.awssdk.services.lambda.model;
import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.adapter.StandardMemberCopier;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.PayloadTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Upon success, returns an empty response. Otherwise, throws an exception.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class InvokeResponse extends LambdaResponse implements ToCopyableBuilder {
private static final SdkField STATUS_CODE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(InvokeResponse::statusCode)).setter(setter(Builder::statusCode))
.traits(LocationTrait.builder().location(MarshallLocation.STATUS_CODE).locationName("StatusCode").build()).build();
private static final SdkField FUNCTION_ERROR_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(InvokeResponse::functionError)).setter(setter(Builder::functionError))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("X-Amz-Function-Error").build())
.build();
private static final SdkField LOG_RESULT_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(InvokeResponse::logResult)).setter(setter(Builder::logResult))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("X-Amz-Log-Result").build()).build();
private static final SdkField PAYLOAD_FIELD = SdkField
. builder(MarshallingType.SDK_BYTES)
.getter(getter(InvokeResponse::payload))
.setter(setter(Builder::payload))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Payload").build(),
PayloadTrait.create()).build();
private static final SdkField EXECUTED_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(InvokeResponse::executedVersion)).setter(setter(Builder::executedVersion))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("X-Amz-Executed-Version").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STATUS_CODE_FIELD,
FUNCTION_ERROR_FIELD, LOG_RESULT_FIELD, PAYLOAD_FIELD, EXECUTED_VERSION_FIELD));
private final Integer statusCode;
private final String functionError;
private final String logResult;
private final SdkBytes payload;
private final String executedVersion;
private InvokeResponse(BuilderImpl builder) {
super(builder);
this.statusCode = builder.statusCode;
this.functionError = builder.functionError;
this.logResult = builder.logResult;
this.payload = builder.payload;
this.executedVersion = builder.executedVersion;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Integer statusCode() {
return statusCode;
}
/**
*
* 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.
*
*
* @return 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.
*/
public String functionError() {
return functionError;
}
/**
*
* 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.
*
*
* @return 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.
*/
public String logResult() {
return logResult;
}
/**
*
* 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.
*
*
* @return 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.
*/
public SdkBytes payload() {
return payload;
}
/**
*
* The function version that has been executed. This value is returned only if the invocation type is
* RequestResponse. For more information, see Traffic Shifting
* Using Aliases.
*
*
* @return The function version that has been executed. This value is returned only if the invocation type is
* RequestResponse. For more information, see Traffic
* Shifting Using Aliases.
*/
public String executedVersion() {
return executedVersion;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(statusCode());
hashCode = 31 * hashCode + Objects.hashCode(functionError());
hashCode = 31 * hashCode + Objects.hashCode(logResult());
hashCode = 31 * hashCode + Objects.hashCode(payload());
hashCode = 31 * hashCode + Objects.hashCode(executedVersion());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof InvokeResponse)) {
return false;
}
InvokeResponse other = (InvokeResponse) obj;
return Objects.equals(statusCode(), other.statusCode()) && Objects.equals(functionError(), other.functionError())
&& Objects.equals(logResult(), other.logResult()) && Objects.equals(payload(), other.payload())
&& Objects.equals(executedVersion(), other.executedVersion());
}
@Override
public String toString() {
return ToString.builder("InvokeResponse").add("StatusCode", statusCode()).add("FunctionError", functionError())
.add("LogResult", logResult()).add("Payload", payload()).add("ExecutedVersion", executedVersion()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StatusCode":
return Optional.ofNullable(clazz.cast(statusCode()));
case "FunctionError":
return Optional.ofNullable(clazz.cast(functionError()));
case "LogResult":
return Optional.ofNullable(clazz.cast(logResult()));
case "Payload":
return Optional.ofNullable(clazz.cast(payload()));
case "ExecutedVersion":
return Optional.ofNullable(clazz.cast(executedVersion()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((InvokeResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends LambdaResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statusCode(Integer statusCode);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder functionError(String functionError);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder logResult(String logResult);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder payload(SdkBytes payload);
/**
*
* The function version that has been executed. This value is returned only if the invocation type is
* RequestResponse. For more information, see Traffic
* Shifting Using Aliases.
*
*
* @param executedVersion
* The function version that has been executed. This value is returned only if the invocation type is
* RequestResponse. For more information, see Traffic
* Shifting Using Aliases.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder executedVersion(String executedVersion);
}
static final class BuilderImpl extends LambdaResponse.BuilderImpl implements Builder {
private Integer statusCode;
private String functionError;
private String logResult;
private SdkBytes payload;
private String executedVersion;
private BuilderImpl() {
}
private BuilderImpl(InvokeResponse model) {
super(model);
statusCode(model.statusCode);
functionError(model.functionError);
logResult(model.logResult);
payload(model.payload);
executedVersion(model.executedVersion);
}
public final Integer getStatusCode() {
return statusCode;
}
@Override
public final Builder statusCode(Integer statusCode) {
this.statusCode = statusCode;
return this;
}
public final void setStatusCode(Integer statusCode) {
this.statusCode = statusCode;
}
public final String getFunctionError() {
return functionError;
}
@Override
public final Builder functionError(String functionError) {
this.functionError = functionError;
return this;
}
public final void setFunctionError(String functionError) {
this.functionError = functionError;
}
public final String getLogResult() {
return logResult;
}
@Override
public final Builder logResult(String logResult) {
this.logResult = logResult;
return this;
}
public final void setLogResult(String logResult) {
this.logResult = logResult;
}
public final ByteBuffer getPayload() {
return payload == null ? null : payload.asByteBuffer();
}
@Override
public final Builder payload(SdkBytes payload) {
this.payload = StandardMemberCopier.copy(payload);
return this;
}
public final void setPayload(ByteBuffer payload) {
payload(payload == null ? null : SdkBytes.fromByteBuffer(payload));
}
public final String getExecutedVersion() {
return executedVersion;
}
@Override
public final Builder executedVersion(String executedVersion) {
this.executedVersion = executedVersion;
return this;
}
public final void setExecutedVersion(String executedVersion) {
this.executedVersion = executedVersion;
}
@Override
public InvokeResponse build() {
return new InvokeResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}