Package software.amazon.awssdk.services.greengrass.model

Class FunctionConfigurationEnvironment

java.lang.Object

software.amazon.awssdk.services.greengrass.model.FunctionConfigurationEnvironment

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class FunctionConfigurationEnvironment
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FunctionConfigurationEnvironment.Builder,FunctionConfigurationEnvironment>

The environment configuration of the function.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FunctionConfigurationEnvironment.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	accessSysfs()	If true, the Lambda function is allowed to access the host's /sys folder.
static FunctionConfigurationEnvironment.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FunctionExecutionConfig	execution()	Configuration related to executing the Lambda function
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceAccessPolicies()	For responses, this returns true if the service returned a value for the ResourceAccessPolicies property.
boolean	hasVariables()	For responses, this returns true if the service returned a value for the Variables property.
List<ResourceAccessPolicy>	resourceAccessPolicies()	A list of the resources, with their permissions, to which the Lambda function will be granted access.
List<SdkField<?>>	sdkFields()
static Class<? extends FunctionConfigurationEnvironment.Builder>	serializableBuilderClass()
FunctionConfigurationEnvironment.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Map<String,String>	variables()	Environment variables for the Lambda function's configuration.

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

accessSysfs

public final Boolean accessSysfs()

If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.

Returns:

If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.

execution

public final FunctionExecutionConfig execution()

Configuration related to executing the Lambda function

Returns:

Configuration related to executing the Lambda function

hasResourceAccessPolicies

public final boolean hasResourceAccessPolicies()

For responses, this returns true if the service returned a value for the ResourceAccessPolicies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

resourceAccessPolicies

public final List<ResourceAccessPolicy> resourceAccessPolicies()

A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceAccessPolicies() method.

Returns:

A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container.

hasVariables

public final boolean hasVariables()

For responses, this returns true if the service returned a value for the Variables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

variables

public final Map<String,String> variables()

Environment variables for the Lambda function's configuration.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVariables() method.

Returns:

Environment variables for the Lambda function's configuration.

toBuilder

public FunctionConfigurationEnvironment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FunctionConfigurationEnvironment.Builder,FunctionConfigurationEnvironment>

builder

public static FunctionConfigurationEnvironment.Builder builder()

serializableBuilderClass

public static Class<? extends FunctionConfigurationEnvironment.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