software.amazon.awscdk.services.appsync

Class UnionType

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appsync.UnionType

All Implemented Interfaces:

IIntermediateType, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:42.889Z")
 @Stability(value=Experimental)
public class UnionType
extends software.amazon.jsii.JsiiObject
implements IIntermediateType

(experimental) Union Types are abstract types that are similar to Interface Types, but they cannot to specify any common fields between types.

Note that fields of a union type need to be object types. In other words, you can't create a union type out of interfaces, other unions, or inputs.

Example:

 GraphqlApi api;
 GraphqlType string = GraphqlType.string();
 ObjectType human = ObjectType.Builder.create("Human").definition(Map.of("name", string)).build();
 ObjectType droid = ObjectType.Builder.create("Droid").definition(Map.of("name", string)).build();
 ObjectType starship = ObjectType.Builder.create("Starship").definition(Map.of("name", string)).build();
 UnionType search = UnionType.Builder.create("Search")
         .definition(List.of(human, droid, starship))
         .build();
 api.addType(search);
 

Nested Class Summary

Nested Classes

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

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	UnionType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UnionType(software.amazon.jsii.JsiiObjectRef objRef)
	UnionType(String name, UnionTypeOptions options)

Method Summary

Modifier and Type	Method and Description
void	addField(AddFieldOptions options) (experimental) Add a field to this Union Type.
GraphqlType	attribute() (experimental) Create a GraphQL Type representing this Union Type.
GraphqlType	attribute(BaseTypeOptions options) (experimental) Create a GraphQL Type representing this Union Type.
Map<String,IField>	getDefinition() (experimental) the attributes of this type.
protected List<AuthorizationType>	getModes() (experimental) the authorization modes supported by this intermediate type.
String	getName() (experimental) the name of this type.
protected void	setModes(List<AuthorizationType> value) (experimental) the authorization modes supported by this intermediate type.
String	toString() (experimental) Generate the string of this Union 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

getDirectives, getInterfaceTypes, getIntermediateType, getResolvers, setResolvers

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

UnionType

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

UnionType

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

UnionType

@Stability(value=Experimental)
public UnionType(@NotNull
                                                String name,
                                                @NotNull
                                                UnionTypeOptions options)

Parameters:

name - This parameter is required.

options - This parameter is required.

Method Detail

addField

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

(experimental) Add a field to this Union Type.

Input Types must have field options and the IField must be an Object Type.

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 Union 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 Union Type.

Specified by:

attribute in interface IIntermediateType

toString

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

(experimental) Generate the string of this Union 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

getModes

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

(experimental) the authorization modes supported by this intermediate type.

setModes

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

(experimental) the authorization modes supported by this intermediate type.