Package software.amazon.awscdk.services.appsync

Class Field

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appsync.GraphqlType

software.amazon.awscdk.services.appsync.Field

All Implemented Interfaces:

IField, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

ResolvableField

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

(experimental) Fields build upon Graphql Types and provide typing and arguments.

Example:

 Field field = Field.Builder.create()
         .returnType(GraphqlType.string())
         .args(Map.of(
                 "argument", GraphqlType.string()))
         .build();
 InterfaceType type = InterfaceType.Builder.create("Node")
         .definition(Map.of("test", field))
         .build();
 

Nested Class Summary

Nested Classes

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

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
	Field(FieldOptions options)
protected	Field(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Field(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	argsToString()	(experimental) Generate the args string of this resolvable field.
String	directivesToString()	(experimental) Generate the directives for this field.
String	directivesToString(List<AuthorizationType> modes)	(experimental) Generate the directives for this field.
ResolvableFieldOptions	getFieldOptions()	(experimental) The options for this field.

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

getIntermediateType, getIsList, getIsRequired, getIsRequiredList, getType, toString

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Field

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

Field

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

Field

@Stability(Experimental)
public Field(@NotNull
 FieldOptions options)

Parameters:

options - This parameter is required.

Method Details

argsToString

@Stability(Experimental)
@NotNull
public String argsToString()

(experimental) Generate the args string of this resolvable field.

Specified by:

argsToString in interface IField

Overrides:

argsToString in class GraphqlType

directivesToString

@Stability(Experimental)
@NotNull
public String directivesToString(@Nullable
 List<AuthorizationType> modes)

(experimental) Generate the directives for this field.

Specified by:

directivesToString in interface IField

Overrides:

directivesToString in class GraphqlType

Parameters:

modes -

directivesToString

@Stability(Experimental)
@NotNull
public String directivesToString()

(experimental) Generate the directives for this field.

Specified by:

directivesToString in interface IField

Overrides:

directivesToString in class GraphqlType

getFieldOptions

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

(experimental) The options for this field.

Default: - no arguments

Specified by:

getFieldOptions in interface IField