Class Resolver

java.lang.Object
software.amazon.awssdk.services.appsync.model.Resolver
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Resolver.Builder,Resolver>
@Generated("software.amazon.awssdk:codegen") public final class Resolver extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Resolver.Builder,Resolver>

Describes a resolver.

See Also:

  • Method Details

    • typeName

      public final String typeName()

      The resolver type name.

      Returns:
      The resolver type name.

    • fieldName

      public final String fieldName()

      The resolver field name.

      Returns:
      The resolver field name.

    • dataSourceName

      public final String dataSourceName()

      The resolver data source name.

      Returns:
      The resolver data source name.

    • resolverArn

      public final String resolverArn()

      The resolver Amazon Resource Name (ARN).

      Returns:
      The resolver Amazon Resource Name (ARN).

    • requestMappingTemplate

      public final String requestMappingTemplate()

      The request mapping template.

      Returns:
      The request mapping template.

    • responseMappingTemplate

      public final String responseMappingTemplate()

      The response mapping template.

      Returns:
      The response mapping template.

    • kind

      public final ResolverKind kind()

      The resolver type.

      • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

      • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

      If the service returns an enum value that is not available in the current SDK version, kind will return ResolverKind.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from kindAsString().

      Returns:
      The resolver type.

      • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

      • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

      See Also:

    • kindAsString

      public final String kindAsString()

      The resolver type.

      • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

      • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

      If the service returns an enum value that is not available in the current SDK version, kind will return ResolverKind.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from kindAsString().

      Returns:
      The resolver type.

      • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

      • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

      See Also:

    • pipelineConfig

      public final PipelineConfig pipelineConfig()

      The PipelineConfig.

      Returns:
      The PipelineConfig.

    • syncConfig

      public final SyncConfig syncConfig()

      The SyncConfig for a resolver attached to a versioned data source.

      Returns:
      The SyncConfig for a resolver attached to a versioned data source.

    • cachingConfig

      public final CachingConfig cachingConfig()

      The caching configuration for the resolver.

      Returns:
      The caching configuration for the resolver.

    • 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 resolver 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 resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

    • metricsConfig

      public final ResolverLevelMetricsConfig metricsConfig()

      Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

      metricsConfig can be ENABLED or DISABLED.

      If the service returns an enum value that is not available in the current SDK version, metricsConfig will return ResolverLevelMetricsConfig.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricsConfigAsString().

      Returns:
      Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

      metricsConfig can be ENABLED or DISABLED.

      See Also:

    • metricsConfigAsString

      public final String metricsConfigAsString()

      Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

      metricsConfig can be ENABLED or DISABLED.

      If the service returns an enum value that is not available in the current SDK version, metricsConfig will return ResolverLevelMetricsConfig.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricsConfigAsString().

      Returns:
      Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

      metricsConfig can be ENABLED or DISABLED.

      See Also:

    • toBuilder

      public Resolver.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<Resolver.Builder,Resolver>
      Returns:
      a builder for type T

    • builder

      public static Resolver.Builder builder()

    • serializableBuilderClass

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