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:

  • Method Details

    • 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()
      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<FunctionConfigurationEnvironment.Builder,FunctionConfigurationEnvironment>
      Returns:
      a builder for type T

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