software.amazon.awssdk.services.greengrass.model

Class FunctionConfiguration

java.lang.Object

software.amazon.awssdk.services.greengrass.model.FunctionConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FunctionConfiguration.Builder,FunctionConfiguration>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FunctionConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static FunctionConfiguration.Builder	builder()
EncodingType	encodingType() The expected encoding type of the input payload for the function.
String	encodingTypeAsString() The expected encoding type of the input payload for the function.
FunctionConfigurationEnvironment	environment() The environment configuration of the function.
boolean	equals(Object obj)
String	execArgs() The execution arguments.
String	executable() The name of the function executable.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	memorySize() The memory size, in KB, which the function requires.
Boolean	pinned() True if the function is pinned.
List<SdkField<?>>	sdkFields()
static Class<? extends FunctionConfiguration.Builder>	serializableBuilderClass()
Integer	timeout() The allowed function execution time, after which Lambda should terminate the function.
FunctionConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

encodingType

public 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:

EncodingType

encodingTypeAsString

public 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:

EncodingType

environment

public FunctionConfigurationEnvironment environment()

The environment configuration of the function.

Returns:

The environment configuration of the function.

execArgs

public String execArgs()

The execution arguments.

Returns:

The execution arguments.

executable

public String executable()

The name of the function executable.

Returns:

The name of the function executable.

memorySize

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

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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