Class CreateResolverRequest

    • Method Detail

      • apiId

        public final String apiId()

        The ID for the GraphQL API for which the resolver is being created.

        Returns:
        The ID for the GraphQL API for which the resolver is being created.
      • typeName

        public final String typeName()

        The name of the Type.

        Returns:
        The name of the Type.
      • fieldName

        public final String fieldName()

        The name of the field to attach the resolver to.

        Returns:
        The name of the field to attach the resolver to.
      • dataSourceName

        public final String dataSourceName()

        The name of the data source for which the resolver is being created.

        Returns:
        The name of the data source for which the resolver is being created.
      • requestMappingTemplate

        public final String requestMappingTemplate()

        The mapping template to use for requests.

        A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

        VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

        Returns:
        The mapping template to use for requests.

        A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

        VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

      • responseMappingTemplate

        public final String responseMappingTemplate()

        The mapping template to use for responses from the data source.

        Returns:
        The mapping template to use for responses from the data source.
      • 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:
        ResolverKind
      • 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:
        ResolverKind
      • 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:
        ResolverLevelMetricsConfig
      • 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:
        ResolverLevelMetricsConfig
      • 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