Class FunctionConfiguration

java.lang.Object
software.amazon.awssdk.services.greengrass.model.FunctionConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FunctionConfiguration.Builder,FunctionConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class FunctionConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FunctionConfiguration.Builder,FunctionConfiguration>
The configuration of the Lambda function.
See Also:

  • Method Details

    • encodingType

      public final EncodingType encodingType()
      The expected encoding type of the input payload for the function. The default is ''json''.

      If the service returns an enum value that is not available in the current SDK version, encodingType will return EncodingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encodingTypeAsString().

      Returns:
      The expected encoding type of the input payload for the function. The default is ''json''.
      See Also:

    • encodingTypeAsString

      public final String encodingTypeAsString()
      The expected encoding type of the input payload for the function. The default is ''json''.

      If the service returns an enum value that is not available in the current SDK version, encodingType will return EncodingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encodingTypeAsString().

      Returns:
      The expected encoding type of the input payload for the function. The default is ''json''.
      See Also:

    • environment

      public final FunctionConfigurationEnvironment environment()
      The environment configuration of the function.
      Returns:
      The environment configuration of the function.

    • execArgs

      public final String execArgs()
      The execution arguments.
      Returns:
      The execution arguments.

    • executable

      public final String executable()
      The name of the function executable.
      Returns:
      The name of the function executable.

    • memorySize

      public final Integer memorySize()
      The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.
      Returns:
      The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.

    • pinned

      public final Boolean pinned()
      True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.
      Returns:
      True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.

    • timeout

      public final Integer timeout()
      The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
      Returns:
      The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.

    • functionRuntimeOverride

      public final String functionRuntimeOverride()
      The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.
      Returns:
      The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.

    • toBuilder

      public FunctionConfiguration.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<FunctionConfiguration.Builder,FunctionConfiguration>
      Returns:
      a builder for type T

    • builder

      public static FunctionConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.