Package software.amazon.awscdk.services.appsync

Interface IField

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IField.Jsii$Default

All Known Implementing Classes:

Field, GraphqlType, IField.Jsii$Proxy, ResolvableField

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-31T18:44:21.192Z")
@Stability(Experimental)
public interface IField
extends software.amazon.jsii.JsiiSerializable

(experimental) A Graphql Field.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IField.Jsii$Default	Internal default implementation for IField.
static final class	IField.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	argsToString()	(experimental) Generate the arguments for this field.
String	directivesToString()	(experimental) Generate the directives for this field.
String	directivesToString(List<AuthorizationType> modes)	(experimental) Generate the directives for this field.
default ResolvableFieldOptions	getFieldOptions()	(experimental) The options to make this field resolvable.
default IIntermediateType	getIntermediateType()	(experimental) the intermediate type linked to this attribute (i.e.
Boolean	getIsList()	(experimental) property determining if this attribute is a list i.e.
Boolean	getIsRequired()	(experimental) property determining if this attribute is non-nullable i.e.
Boolean	getIsRequiredList()	(experimental) property determining if this attribute is a non-nullable list i.e.
Type	getType()	(experimental) the type of attribute.
String	toString()	(experimental) Generate the string for this attribute.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIsList

@Stability(Experimental)
@NotNull
Boolean getIsList()

(experimental) property determining if this attribute is a list i.e. if true, attribute would be `[Type]`.

Default: false

getIsRequired

@Stability(Experimental)
@NotNull
Boolean getIsRequired()

(experimental) property determining if this attribute is non-nullable i.e. if true, attribute would be `Type!` and this attribute must always have a value.

Default: false

getIsRequiredList

@Stability(Experimental)
@NotNull
Boolean getIsRequiredList()

(experimental) property determining if this attribute is a non-nullable list i.e. if true, attribute would be `[ Type ]!` and this attribute's list must always have a value.

Default: false

getType

@Stability(Experimental)
@NotNull
Type getType()

(experimental) the type of attribute.

getFieldOptions

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

(experimental) The options to make this field resolvable.

Default: - not a resolvable field

getIntermediateType

@Stability(Experimental)
@Nullable
default IIntermediateType getIntermediateType()

(experimental) the intermediate type linked to this attribute (i.e. an interface or an object).

Default: - no intermediate type

argsToString

@Stability(Experimental)
@NotNull
String argsToString()

(experimental) Generate the arguments for this field.

directivesToString

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

(experimental) Generate the directives for this field.

Default: - no authorization modes

Parameters:

modes - the authorization modes of the graphql api.

directivesToString

@Stability(Experimental)
@NotNull
String directivesToString()

(experimental) Generate the directives for this field.

Default: - no authorization modes

toString

@Stability(Experimental)
@NotNull
String toString()

(experimental) Generate the string for this attribute.

Overrides:

toString in class Object