Package software.amazon.awscdk.services.appsync

Class ResolvableField

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appsync.GraphqlType

software.amazon.awscdk.services.appsync.Field

software.amazon.awscdk.services.appsync.ResolvableField

All Implemented Interfaces:

IField, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.568Z")
@Stability(Experimental)
public class ResolvableField
extends Field
implements IField

(experimental) Resolvable Fields build upon Graphql Types and provide fields that can resolve into operations on a data source.

Example:

 GraphqlApi api;
 MappingTemplate dummyRequest;
 MappingTemplate dummyResponse;
 ObjectType info = ObjectType.Builder.create("Info")
         .definition(Map.of(
                 "node", ResolvableField.Builder.create()
                         .returnType(GraphqlType.string())
                         .args(Map.of(
                                 "id", GraphqlType.string()))
                         .dataSource(api.addNoneDataSource("none"))
                         .requestMappingTemplate(dummyRequest)
                         .responseMappingTemplate(dummyResponse)
                         .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResolvableField.Builder	(experimental) A fluent builder for ResolvableField.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appsync.IField

IField.Jsii$Default, IField.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	ResolvableField(ResolvableFieldOptions options)
protected	ResolvableField(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ResolvableField(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
ResolvableFieldOptions	getFieldOptions()	(experimental) The options to make this field resolvable.

Methods inherited from class software.amazon.awscdk.services.appsync.Field

argsToString, directivesToString, directivesToString

Methods inherited from class software.amazon.awscdk.services.appsync.GraphqlType

awsDate, awsDate, awsDateTime, awsDateTime, awsEmail, awsEmail, awsIpAddress, awsIpAddress, awsJson, awsJson, awsPhone, awsPhone, awsTime, awsTime, awsTimestamp, awsTimestamp, awsUrl, awsUrl, doBoolean, doBoolean, doFloat, doFloat, doInt, doInt, getIntermediateType, getIsList, getIsRequired, getIsRequiredList, getType, id, id, intermediate, intermediate, string, string, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.appsync.IField

argsToString, directivesToString, directivesToString, getIntermediateType, getIsList, getIsRequired, getIsRequiredList, getType, toString

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ResolvableField

protected ResolvableField(software.amazon.jsii.JsiiObjectRef objRef)

ResolvableField

protected ResolvableField(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ResolvableField

@Stability(Experimental)
public ResolvableField(@NotNull
 ResolvableFieldOptions options)

Parameters:

options - This parameter is required.

Method Details

getFieldOptions

@Stability(Experimental)
@Nullable
public ResolvableFieldOptions getFieldOptions()

(experimental) The options to make this field resolvable.

Default: - not a resolvable field

Specified by:

getFieldOptions in interface IField

Overrides:

getFieldOptions in class Field