CreateResolverRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.appsync.model.AppSyncRequest
    - - software.amazon.awssdk.services.appsync.model.CreateResolverRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateResolverRequest.Builder,CreateResolverRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateResolverRequest
extends AppSyncRequest
implements ToCopyableBuilder<CreateResolverRequest.Builder,CreateResolverRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateResolverRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateResolverRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`apiId()` The ID for the GraphQL API for which the resolver is being created.
`static CreateResolverRequest.Builder`	`builder()`
`CachingConfig`	`cachingConfig()` The caching configuration for the resolver.
`String`	`code()` The `resolver` code that contains the request and response functions.
`String`	`dataSourceName()` The name of the data source for which the resolver is being created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fieldName()` The name of the field to attach the resolver to.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`ResolverKind`	`kind()` The resolver type.
`String`	`kindAsString()` The resolver type.
`Integer`	`maxBatchSize()` The maximum batching size for a resolver.
`PipelineConfig`	`pipelineConfig()` The `PipelineConfig`.
`String`	`requestMappingTemplate()` The mapping template to use for requests.
`String`	`responseMappingTemplate()` The mapping template to use for responses from the data source.
`AppSyncRuntime`	`runtime()` Returns the value of the Runtime property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateResolverRequest.Builder>`	`serializableBuilderClass()`
`SyncConfig`	`syncConfig()` The `SyncConfig` for a resolver attached to a versioned data source.
`CreateResolverRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`typeName()` The name of the `Type`.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- 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.
  - toBuilder
```
public CreateResolverRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateResolverRequest.Builder,CreateResolverRequest>
    
    Specified by:
    
    toBuilder in class AppSyncRequest
  - builder
```
public static CreateResolverRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateResolverRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateResolverRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

apiId

typeName

fieldName

dataSourceName

requestMappingTemplate

responseMappingTemplate

kind

kindAsString

pipelineConfig

syncConfig

cachingConfig

maxBatchSize

runtime

code

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields