Package software.aws.awsprototypingsdk.cdkgraph

Class Reference

java.lang.Object

software.amazon.jsii.JsiiObject

software.aws.awsprototypingsdk.cdkgraph.BaseEntity

software.aws.awsprototypingsdk.cdkgraph.Edge

software.aws.awsprototypingsdk.cdkgraph.Reference

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, ISerializableEdge, ISerializableEntity

Direct Known Subclasses:

AttributeReference, ImportReference

@Generated(value="jsii-pacmak/1.82.0 (build 2d2ddd7)",
           date="2023-08-24T23:07:44.485Z")
@Stability(Experimental)
public class Reference
extends Edge

(experimental) Reference edge class defines a directed relationship between nodes.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.aws.awsprototypingsdk.cdkgraph.ISerializableEdge

ISerializableEdge.Jsii$Default, ISerializableEdge.Jsii$Proxy

Nested classes/interfaces inherited from interface software.aws.awsprototypingsdk.cdkgraph.ISerializableEntity

ISerializableEntity.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATT_TYPE	(experimental) Attribute defining the type of reference.
static String	PREFIX	(experimental) Edge prefix to denote Ref type reference edge.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Reference(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Reference(software.amazon.jsii.JsiiObjectRef objRef)
	Reference(IReferenceProps props)

Method Summary

Modifier and Type	Method	Description
ReferenceTypeEnum	getReferenceType()	(experimental) Get type of reference.
static Boolean	isRef(Edge edge)	(experimental) Indicates if edge is a **Ref** based Reference edge.
static Boolean	isReference(Edge edge)	(experimental) Indicates if edge is a Reference.
List<Object>	resolveChain()	(experimental) Resolve reference chain.
List<Node>	resolveTargets()	(experimental) Resolve targets by following potential edge chain.

Methods inherited from class software.aws.awsprototypingsdk.cdkgraph.Edge

findAllInChain, findInChain, getAllowDestructiveMutations, getDirection, getEdgeType, getIsClosed, getIsCrossStack, getIsExtraneous, getSource, getTarget, isEquivalent, mutateConsume, mutateDestroy, mutateDestroy, mutateDirection, mutateSource, mutateTarget, toString

Methods inherited from class software.aws.awsprototypingsdk.cdkgraph.BaseEntity

addAttribute, addFlag, addMetadata, addTag, applyData, applyData, applyData, findMetadata, getAttribute, getAttributes, getFlags, getIsDestroyed, getIsMutated, getMetadata, getStore, getTag, getTags, getUuid, hasAttribute, hasAttribute, hasFlag, hasMetadata, hasTag, hasTag, setAttribute, setTag

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.jsii.JsiiSerializable

$jsii$toJson

Field Detail

ATT_TYPE

@Stability(Experimental)
public static final String ATT_TYPE

(experimental) Attribute defining the type of reference.

PREFIX

@Stability(Experimental)
public static final String PREFIX

(experimental) Edge prefix to denote Ref type reference edge.

Constructor Detail

Reference

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

Reference

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

Reference

@Stability(Experimental)
public Reference(@NotNull
                 IReferenceProps props)

Parameters:

props - This parameter is required.

Method Detail

isRef

@Stability(Experimental)
@NotNull
public static Boolean isRef(@NotNull
                            Edge edge)

(experimental) Indicates if edge is a **Ref** based Reference edge.

Parameters:

edge - This parameter is required.

isReference

@Stability(Experimental)
@NotNull
public static Boolean isReference(@NotNull
                                  Edge edge)

(experimental) Indicates if edge is a Reference.

Parameters:

edge - This parameter is required.

resolveChain

@Stability(Experimental)
@NotNull
public List<Object> resolveChain()

(experimental) Resolve reference chain.

resolveTargets

@Stability(Experimental)
@NotNull
public List<Node> resolveTargets()

(experimental) Resolve targets by following potential edge chain.

See Also:

EdgeChain

getReferenceType

@Stability(Experimental)
@NotNull
public ReferenceTypeEnum getReferenceType()

(experimental) Get type of reference.