Class UpdateResolverRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateResolverRequest.Builder,
UpdateResolverRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
apiId()
The API ID.builder()
final CachingConfig
The caching configuration for the resolver.final String
code()
Theresolver
code that contains the request and response functions.final String
The new data source name.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The new field name.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final ResolverKind
kind()
The resolver type.final String
The resolver type.final Integer
The maximum batching size for a resolver.Enables or disables enhanced resolver metrics for specified resolvers.final String
Enables or disables enhanced resolver metrics for specified resolvers.final PipelineConfig
ThePipelineConfig
.final String
The new request mapping template.final String
The new response mapping template.final AppSyncRuntime
runtime()
Returns the value of the Runtime property for this object.static Class
<? extends UpdateResolverRequest.Builder> final SyncConfig
TheSyncConfig
for a resolver attached to a versioned data source.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
typeName()
The new type name.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
apiId
The API ID.
- Returns:
- The API ID.
-
typeName
The new type name.
- Returns:
- The new type name.
-
fieldName
The new field name.
- Returns:
- The new field name.
-
dataSourceName
The new data source name.
- Returns:
- The new data source name.
-
requestMappingTemplate
The new request mapping template.
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 new request mapping template.
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
The new response mapping template.
- Returns:
- The new response mapping template.
-
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 returnResolverKind.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkindAsString()
.- 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
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 returnResolverKind.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkindAsString()
.- 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
The
PipelineConfig
.- Returns:
- The
PipelineConfig
.
-
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
The caching configuration for the resolver.
- Returns:
- The caching configuration for the resolver.
-
maxBatchSize
The maximum batching size for a resolver.
- Returns:
- The maximum batching size for a resolver.
-
runtime
Returns the value of the Runtime property for this object.- Returns:
- The value of the Runtime property for this object.
-
code
The
resolver
code that contains the request and response functions. When code is used, theruntime
is required. Theruntime
value must beAPPSYNC_JS
.- Returns:
- The
resolver
code that contains the request and response functions. When code is used, theruntime
is required. Theruntime
value must beAPPSYNC_JS
.
-
metricsConfig
Enables or disables enhanced resolver metrics for specified resolvers. Note that
metricsConfig
won't be used unless theresolverLevelMetricsBehavior
value is set toPER_RESOLVER_METRICS
. If theresolverLevelMetricsBehavior
is set toFULL_REQUEST_RESOLVER_METRICS
instead,metricsConfig
will be ignored. However, you can still set its value.metricsConfig
can beENABLED
orDISABLED
.If the service returns an enum value that is not available in the current SDK version,
metricsConfig
will returnResolverLevelMetricsConfig.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricsConfigAsString()
.- Returns:
- Enables or disables enhanced resolver metrics for specified resolvers. Note that
metricsConfig
won't be used unless theresolverLevelMetricsBehavior
value is set toPER_RESOLVER_METRICS
. If theresolverLevelMetricsBehavior
is set toFULL_REQUEST_RESOLVER_METRICS
instead,metricsConfig
will be ignored. However, you can still set its value.metricsConfig
can beENABLED
orDISABLED
. - See Also:
-
metricsConfigAsString
Enables or disables enhanced resolver metrics for specified resolvers. Note that
metricsConfig
won't be used unless theresolverLevelMetricsBehavior
value is set toPER_RESOLVER_METRICS
. If theresolverLevelMetricsBehavior
is set toFULL_REQUEST_RESOLVER_METRICS
instead,metricsConfig
will be ignored. However, you can still set its value.metricsConfig
can beENABLED
orDISABLED
.If the service returns an enum value that is not available in the current SDK version,
metricsConfig
will returnResolverLevelMetricsConfig.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricsConfigAsString()
.- Returns:
- Enables or disables enhanced resolver metrics for specified resolvers. Note that
metricsConfig
won't be used unless theresolverLevelMetricsBehavior
value is set toPER_RESOLVER_METRICS
. If theresolverLevelMetricsBehavior
is set toFULL_REQUEST_RESOLVER_METRICS
instead,metricsConfig
will be ignored. However, you can still set its value.metricsConfig
can beENABLED
orDISABLED
. - See Also:
-
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 interfaceToCopyableBuilder<UpdateResolverRequest.Builder,
UpdateResolverRequest> - Specified by:
toBuilder
in classAppSyncRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-