Package 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("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	Description
static interface	FunctionConfiguration.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
String	execArgs()	The execution arguments.
String	executable()	The name of the function executable.
String	functionRuntimeOverride()	The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.
<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()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

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:

EncodingType

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:

EncodingType

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

Specified by:

toBuilder in interface ToCopyableBuilder<FunctionConfiguration.Builder,FunctionConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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