Class InvokeResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.lambda.model.LambdaResponse
software.amazon.awssdk.services.lambda.model.InvokeResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<InvokeResponse.Builder,InvokeResponse>
@Generated("software.amazon.awssdk:codegen") public final class InvokeResponse extends LambdaResponse implements ToCopyableBuilder<InvokeResponse.Builder,InvokeResponse>

  • Method Details

    • statusCode

      public final Integer statusCode()

      The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.

      Returns:
      The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.

    • functionError

      public final String functionError()

      If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.

      Returns:
      If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.

    • logResult

      public final String logResult()

      The last 4 KB of the execution log, which is base64-encoded.

      Returns:
      The last 4 KB of the execution log, which is base64-encoded.

    • payload

      public final SdkBytes payload()

      The response from the function, or an error object.

      Returns:
      The response from the function, or an error object.

    • executedVersion

      public final String executedVersion()

      The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

      Returns:
      The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

    • toBuilder

      public InvokeResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<InvokeResponse.Builder,InvokeResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static InvokeResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InvokeResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.