software.amazon.awscdk.services.appsync

Class InterfaceType

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appsync.InterfaceType

All Implemented Interfaces:

IIntermediateType, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

ObjectType

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:24.842Z")
 @Stability(value=Experimental)
public class InterfaceType
extends software.amazon.jsii.JsiiObject
implements IIntermediateType

(experimental) Interface Types are abstract types that includes a certain set of fields that other types must include if they implement the interface.

Example:

 InterfaceType node = InterfaceType.Builder.create("Node")
         .definition(Map.of(
                 "id", GraphqlType.string(BaseTypeOptions.builder().isRequired(true).build())))
         .build();
 ObjectType demo = ObjectType.Builder.create("Demo")
         .interfaceTypes(List.of(node))
         .definition(Map.of(
                 "version", GraphqlType.string(BaseTypeOptions.builder().isRequired(true).build())))
         .build();
 

Nested Class Summary

Nested Classes

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

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.IIntermediateType

IIntermediateType.Jsii$Default, IIntermediateType.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InterfaceType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	InterfaceType(software.amazon.jsii.JsiiObjectRef objRef)
	InterfaceType(String name, IntermediateTypeOptions props)

Method Summary

Modifier and Type	Method and Description
void	addField(AddFieldOptions options) (experimental) Add a field to this Interface Type.
GraphqlType	attribute() (experimental) Create a GraphQL Type representing this Intermediate Type.
GraphqlType	attribute(BaseTypeOptions options) (experimental) Create a GraphQL Type representing this Intermediate Type.
Map<String,IField>	getDefinition() (experimental) the attributes of this type.
List<Directive>	getDirectives() (experimental) the directives for this object type.
protected List<AuthorizationType>	getModes() (experimental) the authorization modes for this intermediate type.
String	getName() (experimental) the name of this type.
protected void	setModes(List<AuthorizationType> value) (experimental) the authorization modes for this intermediate type.
String	toString() (experimental) Generate the string of this object type.

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.IIntermediateType

getInterfaceTypes, getIntermediateType, getResolvers, setResolvers

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

InterfaceType

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

InterfaceType

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

InterfaceType

@Stability(value=Experimental)
public InterfaceType(@NotNull
                                                    String name,
                                                    @NotNull
                                                    IntermediateTypeOptions props)

Parameters:

name - This parameter is required.

props - This parameter is required.

Method Detail

addField

@Stability(value=Experimental)
public void addField(@NotNull
                                                    AddFieldOptions options)

(experimental) Add a field to this Interface Type.

Interface Types must have both fieldName and field options.

Specified by:

addField in interface IIntermediateType

Parameters:

options - the options to add a field. This parameter is required.

attribute

@Stability(value=Experimental)
 @NotNull
public GraphqlType attribute(@Nullable
                                                                      BaseTypeOptions options)

(experimental) Create a GraphQL Type representing this Intermediate Type.

Specified by:

attribute in interface IIntermediateType

Parameters:

options - the options to configure this attribute.

attribute

@Stability(value=Experimental)
 @NotNull
public GraphqlType attribute()

(experimental) Create a GraphQL Type representing this Intermediate Type.

Specified by:

attribute in interface IIntermediateType

toString

@Stability(value=Experimental)
 @NotNull
public String toString()

(experimental) Generate the string of this object type.

Specified by:

toString in interface IIntermediateType

Overrides:

toString in class Object

getDefinition

@Stability(value=Experimental)
 @NotNull
public Map<String,IField> getDefinition()

(experimental) the attributes of this type.

Specified by:

getDefinition in interface IIntermediateType

getName

@Stability(value=Experimental)
 @NotNull
public String getName()

(experimental) the name of this type.

Specified by:

getName in interface IIntermediateType

getDirectives

@Stability(value=Experimental)
 @Nullable
public List<Directive> getDirectives()

(experimental) the directives for this object type.

Default: - no directives

Specified by:

getDirectives in interface IIntermediateType

getModes

@Stability(value=Experimental)
 @Nullable
protected List<AuthorizationType> getModes()

(experimental) the authorization modes for this intermediate type.

setModes

@Stability(value=Experimental)
protected void setModes(@Nullable
                                                       List<AuthorizationType> value)

(experimental) the authorization modes for this intermediate type.