software.amazon.awssdk.services.appsync.model

Interface CreateResolverRequest.Builder

All Superinterfaces:

AppSyncRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateResolverRequest.Builder,CreateResolverRequest>, SdkBuilder<CreateResolverRequest.Builder,CreateResolverRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateResolverRequest

public static interface CreateResolverRequest.Builder
extends AppSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateResolverRequest.Builder,CreateResolverRequest>

Method Summary

Modifier and Type	Method and Description
CreateResolverRequest.Builder	apiId(String apiId) The ID for the GraphQL API for which the resolver is being created.
CreateResolverRequest.Builder	cachingConfig(CachingConfig cachingConfig) The caching configuration for the resolver.
default CreateResolverRequest.Builder	cachingConfig(Consumer<CachingConfig.Builder> cachingConfig) The caching configuration for the resolver.
CreateResolverRequest.Builder	code(String code) The resolver code that contains the request and response functions.
CreateResolverRequest.Builder	dataSourceName(String dataSourceName) The name of the data source for which the resolver is being created.
CreateResolverRequest.Builder	fieldName(String fieldName) The name of the field to attach the resolver to.
CreateResolverRequest.Builder	kind(ResolverKind kind) The resolver type.
CreateResolverRequest.Builder	kind(String kind) The resolver type.
CreateResolverRequest.Builder	maxBatchSize(Integer maxBatchSize) The maximum batching size for a resolver.
CreateResolverRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateResolverRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default CreateResolverRequest.Builder	pipelineConfig(Consumer<PipelineConfig.Builder> pipelineConfig) The PipelineConfig.
CreateResolverRequest.Builder	pipelineConfig(PipelineConfig pipelineConfig) The PipelineConfig.
CreateResolverRequest.Builder	requestMappingTemplate(String requestMappingTemplate) The mapping template to use for requests.
CreateResolverRequest.Builder	responseMappingTemplate(String responseMappingTemplate) The mapping template to use for responses from the data source.
CreateResolverRequest.Builder	runtime(AppSyncRuntime runtime) Sets the value of the Runtime property for this object.
default CreateResolverRequest.Builder	runtime(Consumer<AppSyncRuntime.Builder> runtime) Sets the value of the Runtime property for this object.
default CreateResolverRequest.Builder	syncConfig(Consumer<SyncConfig.Builder> syncConfig) The SyncConfig for a resolver attached to a versioned data source.
CreateResolverRequest.Builder	syncConfig(SyncConfig syncConfig) The SyncConfig for a resolver attached to a versioned data source.
CreateResolverRequest.Builder	typeName(String typeName) The name of the Type.

Methods inherited from interface software.amazon.awssdk.services.appsync.model.AppSyncRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

apiId

CreateResolverRequest.Builder apiId(String apiId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

typeName

CreateResolverRequest.Builder typeName(String typeName)

The name of the Type.

Parameters:

typeName - The name of the Type.

Returns:

Returns a reference to this object so that method calls can be chained together.

fieldName

CreateResolverRequest.Builder fieldName(String fieldName)

The name of the field to attach the resolver to.

Parameters:

fieldName - The name of the field to attach the resolver to.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSourceName

CreateResolverRequest.Builder dataSourceName(String dataSourceName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

requestMappingTemplate

CreateResolverRequest.Builder requestMappingTemplate(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

responseMappingTemplate

CreateResolverRequest.Builder responseMappingTemplate(String responseMappingTemplate)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

kind

CreateResolverRequest.Builder kind(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResolverKind, ResolverKind

kind

CreateResolverRequest.Builder kind(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResolverKind, ResolverKind

pipelineConfig

CreateResolverRequest.Builder pipelineConfig(PipelineConfig pipelineConfig)

The PipelineConfig.

Parameters:

pipelineConfig - The PipelineConfig.

Returns:

Returns a reference to this object so that method calls can be chained together.

pipelineConfig

default CreateResolverRequest.Builder pipelineConfig(Consumer<PipelineConfig.Builder> pipelineConfig)

The PipelineConfig.

This is a convenience method that creates an instance of the PipelineConfig.Builder avoiding the need to create one manually via PipelineConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pipelineConfig(PipelineConfig).

Parameters:

pipelineConfig - a consumer that will call methods on PipelineConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

pipelineConfig(PipelineConfig)

syncConfig

CreateResolverRequest.Builder syncConfig(SyncConfig syncConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

syncConfig

default CreateResolverRequest.Builder syncConfig(Consumer<SyncConfig.Builder> syncConfig)

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

This is a convenience method that creates an instance of the SyncConfig.Builder avoiding the need to create one manually via SyncConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to syncConfig(SyncConfig).

Parameters:

syncConfig - a consumer that will call methods on SyncConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

syncConfig(SyncConfig)

cachingConfig

CreateResolverRequest.Builder cachingConfig(CachingConfig cachingConfig)

The caching configuration for the resolver.

Parameters:

cachingConfig - The caching configuration for the resolver.

Returns:

Returns a reference to this object so that method calls can be chained together.

cachingConfig

default CreateResolverRequest.Builder cachingConfig(Consumer<CachingConfig.Builder> cachingConfig)

The caching configuration for the resolver.

This is a convenience method that creates an instance of the CachingConfig.Builder avoiding the need to create one manually via CachingConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cachingConfig(CachingConfig).

Parameters:

cachingConfig - a consumer that will call methods on CachingConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

cachingConfig(CachingConfig)

maxBatchSize

CreateResolverRequest.Builder maxBatchSize(Integer maxBatchSize)

The maximum batching size for a resolver.

Parameters:

maxBatchSize - The maximum batching size for a resolver.

Returns:

Returns a reference to this object so that method calls can be chained together.

runtime

CreateResolverRequest.Builder runtime(AppSyncRuntime runtime)

Sets the value of the Runtime property for this object.

Parameters:

runtime - The new value for the Runtime property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

runtime

default CreateResolverRequest.Builder runtime(Consumer<AppSyncRuntime.Builder> runtime)

Sets the value of the Runtime property for this object. This is a convenience method that creates an instance of the AppSyncRuntime.Builder avoiding the need to create one manually via AppSyncRuntime.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to runtime(AppSyncRuntime).

Parameters:

runtime - a consumer that will call methods on AppSyncRuntime.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

runtime(AppSyncRuntime)

code

CreateResolverRequest.Builder code(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateResolverRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateResolverRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder