Class FunctionConfiguration

java.lang.Object
software.amazon.awssdk.services.appsync.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>

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

See Also:

  • Method Details

    • functionId

      public final String functionId()

      A unique ID representing the Function object.

      Returns:
      A unique ID representing the Function object.

    • functionArn

      public final String functionArn()

      The Amazon Resource Name (ARN) of the Function object.

      Returns:
      The Amazon Resource Name (ARN) of the Function object.

    • name

      public final String name()

      The name of the Function object.

      Returns:
      The name of the Function object.

    • description

      public final String description()

      The Function description.

      Returns:
      The Function description.

    • dataSourceName

      public final String dataSourceName()

      The name of the DataSource.

      Returns:
      The name of the DataSource.

    • requestMappingTemplate

      public final String requestMappingTemplate()

      The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

      Returns:
      The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

    • responseMappingTemplate

      public final String responseMappingTemplate()

      The Function response mapping template.

      Returns:
      The Function response mapping template.

    • functionVersion

      public final String functionVersion()

      The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.

      Returns:
      The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.

    • syncConfig

      public final SyncConfig syncConfig()
      Returns the value of the SyncConfig property for this object.
      Returns:
      The value of the SyncConfig property for this object.

    • maxBatchSize

      public final Integer maxBatchSize()

      The maximum batching size for a resolver.

      Returns:
      The maximum batching size for a resolver.

    • runtime

      public final AppSyncRuntime runtime()
      Returns the value of the Runtime property for this object.
      Returns:
      The value of the Runtime property for this object.

    • code

      public final String code()

      The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

      Returns:
      The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

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