software.amazon.awscdk.services.appsync

Class ObjectType

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appsync.InterfaceType

software.amazon.awscdk.services.appsync.ObjectType

All Implemented Interfaces:

IIntermediateType, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:01.084Z")
 @Stability(value=Experimental)
public class ObjectType
extends InterfaceType
implements IIntermediateType

(experimental) Object Types are types declared by you.

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 and Description
static class	ObjectType.Builder (experimental) A fluent builder for ObjectType.

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	ObjectType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ObjectType(software.amazon.jsii.JsiiObjectRef objRef)
	ObjectType(String name, ObjectTypeOptions props)

Method Summary

Modifier and Type	Method and Description
void	addField(AddFieldOptions options) (experimental) Add a field to this Object Type.
protected Resolver	generateResolver(IGraphqlApi api, String fieldName) (experimental) Generate the resolvers linked to this Object Type.
protected Resolver	generateResolver(IGraphqlApi api, String fieldName, ResolvableFieldOptions options) (experimental) Generate the resolvers linked to this Object Type.
List<InterfaceType>	getInterfaceTypes() (experimental) The Interface Types this Object Type implements.
List<Resolver>	getResolvers() (experimental) The resolvers linked to this data source.
void	setResolvers(List<Resolver> value) (experimental) The resolvers linked to this data source.
String	toString() (experimental) Generate the string of this object type.

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

attribute, attribute, getDefinition, getDirectives, getModes, getName, setModes

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

attribute, attribute, getDefinition, getDirectives, getIntermediateType, getName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ObjectType

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

ObjectType

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

ObjectType

@Stability(value=Experimental)
public ObjectType(@NotNull
                                                 String name,
                                                 @NotNull
                                                 ObjectTypeOptions 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 Object Type.

Object Types must have both fieldName and field options.

Specified by:

addField in interface IIntermediateType

Overrides:

addField in class InterfaceType

Parameters:

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

generateResolver

@Stability(value=Experimental)
 @NotNull
protected Resolver generateResolver(@NotNull
                                                                             IGraphqlApi api,
                                                                             @NotNull
                                                                             String fieldName,
                                                                             @Nullable
                                                                             ResolvableFieldOptions options)

(experimental) Generate the resolvers linked to this Object Type.

Parameters:

api - This parameter is required.

fieldName - This parameter is required.

options -

generateResolver

@Stability(value=Experimental)
 @NotNull
protected Resolver generateResolver(@NotNull
                                                                             IGraphqlApi api,
                                                                             @NotNull
                                                                             String fieldName)

(experimental) Generate the resolvers linked to this Object Type.

Parameters:

api - This parameter is required.

fieldName - This parameter is required.

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 InterfaceType

getInterfaceTypes

@Stability(value=Experimental)
 @Nullable
public List<InterfaceType> getInterfaceTypes()

(experimental) The Interface Types this Object Type implements.

Default: - no interface types

Specified by:

getInterfaceTypes in interface IIntermediateType

getResolvers

@Stability(value=Experimental)
 @Nullable
public List<Resolver> getResolvers()

(experimental) The resolvers linked to this data source.

Specified by:

getResolvers in interface IIntermediateType

setResolvers

@Stability(value=Experimental)
public void setResolvers(@Nullable
                                                        List<Resolver> value)

(experimental) The resolvers linked to this data source.

Specified by:

setResolvers in interface IIntermediateType