software.aws.awsprototypingsdk.cdkgraph.Node Maven / Gradle / Ivy
Show all versions of cdk-graph Show documentation
package software.aws.awsprototypingsdk.cdkgraph;
/**
* (experimental) Node class is the base definition of node entities in the graph, as in standard graph theory.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.82.0 (build 2d2ddd7)", date = "2023-08-15T05:45:13.806Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.aws.awsprototypingsdk.cdkgraph.$Module.class, fqn = "@aws-prototyping-sdk/cdk-graph.Node")
public class Node extends software.aws.awsprototypingsdk.cdkgraph.BaseEntity implements software.aws.awsprototypingsdk.cdkgraph.ISerializableNode {
protected Node(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected Node(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Node(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.INodeProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* (experimental) Add child node.
*
* @param node This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addChild(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node node) {
software.amazon.jsii.Kernel.call(this, "addChild", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(node, "node is required") });
}
/**
* (experimental) Add link to another node.
*
* @param edge This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addLink(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Edge edge) {
software.amazon.jsii.Kernel.call(this, "addLink", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(edge, "edge is required") });
}
/**
* (experimental) Add link from another node.
*
* @param edge This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addReverseLink(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Edge edge) {
software.amazon.jsii.Kernel.call(this, "addReverseLink", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(edge, "edge is required") });
}
/**
* (experimental) Indicates if this node depends on another node.
*
* @param node This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean doesDependOn(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node node) {
return software.amazon.jsii.Kernel.call(this, "doesDependOn", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(node, "node is required") });
}
/**
* (experimental) Indicates if this node references another node.
*
* @param node This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean doesReference(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node node) {
return software.amazon.jsii.Kernel.call(this, "doesReference", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(node, "node is required") });
}
/**
* (experimental) Recursively find the nearest sub-node matching predicate.
*
* @param predicate This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.Node find(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.INodePredicate predicate) {
return software.amazon.jsii.Kernel.call(this, "find", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required") });
}
/**
* (experimental) Return this construct and all of its sub-nodes in the given order.
*
* Optionally filter nodes based on predicate.
*
* @param options
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List findAll(final @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.IFindNodeOptions options) {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "findAll", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class)), new Object[] { options }));
}
/**
* (experimental) Return this construct and all of its sub-nodes in the given order.
*
* Optionally filter nodes based on predicate.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List findAll() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "findAll", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class))));
}
/**
* (experimental) Return all direct links of this node and that of all sub-nodes.
*
* Optionally filter links based on predicate.
*
* @param options
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List findAllLinks(final @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.IFindEdgeOptions options) {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "findAllLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class)), new Object[] { options }));
}
/**
* (experimental) Return all direct links of this node and that of all sub-nodes.
*
* Optionally filter links based on predicate.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List findAllLinks() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "findAllLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class))));
}
/**
* (experimental) Find nearest ancestor of this node matching given predicate.
*
* @param predicate
- Predicate to match ancestor.
This parameter is required.
* @param max
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.Node findAncestor(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.INodePredicate predicate, final @org.jetbrains.annotations.Nullable java.lang.Number max) {
return software.amazon.jsii.Kernel.call(this, "findAncestor", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required"), max });
}
/**
* (experimental) Find nearest ancestor of this node matching given predicate.
*
* @param predicate
- Predicate to match ancestor.
This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.Node findAncestor(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.INodePredicate predicate) {
return software.amazon.jsii.Kernel.call(this, "findAncestor", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required") });
}
/**
* (experimental) Find child with given id.
*
* Similar to find but does not throw error if no child found.
*
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.Node findChild(final @org.jetbrains.annotations.NotNull java.lang.String id) {
return software.amazon.jsii.Kernel.call(this, "findChild", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class), new Object[] { java.util.Objects.requireNonNull(id, "id is required") });
}
/**
* (experimental) Find link of this node based on predicate.
*
* By default this will follow link
* chains to evaluate the predicate against and return the matching direct link
* of this node.
*
* @param predicate Edge predicate function to match edge. This parameter is required.
* @param reverse Indicates if links are search in reverse order.
* @param follow Indicates if link chain is followed.
* @param direct Indicates that only direct links should be searched.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.Edge findLink(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IEdgePredicate predicate, final @org.jetbrains.annotations.Nullable java.lang.Boolean reverse, final @org.jetbrains.annotations.Nullable java.lang.Boolean follow, final @org.jetbrains.annotations.Nullable java.lang.Boolean direct) {
return software.amazon.jsii.Kernel.call(this, "findLink", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required"), reverse, follow, direct });
}
/**
* (experimental) Find link of this node based on predicate.
*
* By default this will follow link
* chains to evaluate the predicate against and return the matching direct link
* of this node.
*
* @param predicate Edge predicate function to match edge. This parameter is required.
* @param reverse Indicates if links are search in reverse order.
* @param follow Indicates if link chain is followed.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.Edge findLink(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IEdgePredicate predicate, final @org.jetbrains.annotations.Nullable java.lang.Boolean reverse, final @org.jetbrains.annotations.Nullable java.lang.Boolean follow) {
return software.amazon.jsii.Kernel.call(this, "findLink", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required"), reverse, follow });
}
/**
* (experimental) Find link of this node based on predicate.
*
* By default this will follow link
* chains to evaluate the predicate against and return the matching direct link
* of this node.
*
* @param predicate Edge predicate function to match edge. This parameter is required.
* @param reverse Indicates if links are search in reverse order.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.Edge findLink(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IEdgePredicate predicate, final @org.jetbrains.annotations.Nullable java.lang.Boolean reverse) {
return software.amazon.jsii.Kernel.call(this, "findLink", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required"), reverse });
}
/**
* (experimental) Find link of this node based on predicate.
*
* By default this will follow link
* chains to evaluate the predicate against and return the matching direct link
* of this node.
*
* @param predicate Edge predicate function to match edge. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.Edge findLink(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IEdgePredicate predicate) {
return software.amazon.jsii.Kernel.call(this, "findLink", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required") });
}
/**
* (experimental) Find all links of this node based on predicate.
*
* By default this will follow link
* chains to evaluate the predicate against and return the matching direct links
* of this node.
*
* @param predicate Edge predicate function to match edge. This parameter is required.
* @param reverse Indicates if links are search in reverse order.
* @param follow Indicates if link chain is followed.
* @param direct Indicates that only direct links should be searched.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List findLinks(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IEdgePredicate predicate, final @org.jetbrains.annotations.Nullable java.lang.Boolean reverse, final @org.jetbrains.annotations.Nullable java.lang.Boolean follow, final @org.jetbrains.annotations.Nullable java.lang.Boolean direct) {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "findLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class)), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required"), reverse, follow, direct }));
}
/**
* (experimental) Find all links of this node based on predicate.
*
* By default this will follow link
* chains to evaluate the predicate against and return the matching direct links
* of this node.
*
* @param predicate Edge predicate function to match edge. This parameter is required.
* @param reverse Indicates if links are search in reverse order.
* @param follow Indicates if link chain is followed.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List findLinks(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IEdgePredicate predicate, final @org.jetbrains.annotations.Nullable java.lang.Boolean reverse, final @org.jetbrains.annotations.Nullable java.lang.Boolean follow) {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "findLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class)), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required"), reverse, follow }));
}
/**
* (experimental) Find all links of this node based on predicate.
*
* By default this will follow link
* chains to evaluate the predicate against and return the matching direct links
* of this node.
*
* @param predicate Edge predicate function to match edge. This parameter is required.
* @param reverse Indicates if links are search in reverse order.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List findLinks(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IEdgePredicate predicate, final @org.jetbrains.annotations.Nullable java.lang.Boolean reverse) {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "findLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class)), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required"), reverse }));
}
/**
* (experimental) Find all links of this node based on predicate.
*
* By default this will follow link
* chains to evaluate the predicate against and return the matching direct links
* of this node.
*
* @param predicate Edge predicate function to match edge. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List findLinks(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IEdgePredicate predicate) {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "findLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class)), new Object[] { java.util.Objects.requireNonNull(predicate, "predicate is required") }));
}
/**
* (experimental) Get specific CloudFormation property.
*
* @param key This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.Object getCfnProp(final @org.jetbrains.annotations.NotNull java.lang.String key) {
return software.amazon.jsii.Kernel.call(this, "getCfnProp", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { java.util.Objects.requireNonNull(key, "key is required") });
}
/**
* (experimental) Get child node with given id.
*
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node getChild(final @org.jetbrains.annotations.NotNull java.lang.String id) {
return software.amazon.jsii.Kernel.call(this, "getChild", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class), new Object[] { java.util.Objects.requireNonNull(id, "id is required") });
}
/**
* (experimental) Resolve all link chains.
*
* @see {@link EdgeChain }
* @param reverse
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List> getLinkChains(final @org.jetbrains.annotations.Nullable java.lang.Boolean reverse) {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "getLinkChains", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class))), new Object[] { reverse }));
}
/**
* (experimental) Resolve all link chains.
*
* @see {@link EdgeChain }
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List> getLinkChains() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "getLinkChains", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class)))));
}
/**
* (experimental) Gets the nearest common ancestor shared between this node and another node.
*
* @param node This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node getNearestAncestor(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node node) {
return software.amazon.jsii.Kernel.call(this, "getNearestAncestor", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class), new Object[] { java.util.Objects.requireNonNull(node, "node is required") });
}
/**
* (experimental) Indicates if a specific node is an ancestor of this node.
*
* @param ancestor This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean isAncestor(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node ancestor) {
return software.amazon.jsii.Kernel.call(this, "isAncestor", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(ancestor, "ancestor is required") });
}
/**
* (experimental) Indicates if specific node is a child of this node.
*
* @param node This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean isChild(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node node) {
return software.amazon.jsii.Kernel.call(this, "isChild", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(node, "node is required") });
}
/**
* (experimental) Collapses all sub-nodes of this node into this node.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void mutateCollapse() {
software.amazon.jsii.Kernel.call(this, "mutateCollapse", software.amazon.jsii.NativeType.VOID);
}
/**
* (experimental) Collapses this node into an ancestor.
*
* @param ancestor This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node mutateCollapseTo(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node ancestor) {
return software.amazon.jsii.Kernel.call(this, "mutateCollapseTo", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class), new Object[] { java.util.Objects.requireNonNull(ancestor, "ancestor is required") });
}
/**
* (experimental) Collapses this node into it's parent node.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node mutateCollapseToParent() {
return software.amazon.jsii.Kernel.call(this, "mutateCollapseToParent", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class));
}
/**
* (experimental) Destroys this node by removing all references and removing this node from the store.
*
* @param strict
- Indicates that this node must not have references.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public void mutateDestroy(final @org.jetbrains.annotations.Nullable java.lang.Boolean strict) {
software.amazon.jsii.Kernel.call(this, "mutateDestroy", software.amazon.jsii.NativeType.VOID, new Object[] { strict });
}
/**
* (experimental) Destroys this node by removing all references and removing this node from the store.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public void mutateDestroy() {
software.amazon.jsii.Kernel.call(this, "mutateDestroy", software.amazon.jsii.NativeType.VOID);
}
/**
* (experimental) Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.
*
* @param newParent This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void mutateHoist(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node newParent) {
software.amazon.jsii.Kernel.call(this, "mutateHoist", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(newParent, "newParent is required") });
}
/**
* (experimental) Move this node into a new parent node.
*
* @param newParent
- The parent to move this node to.
This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void mutateMove(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node newParent) {
software.amazon.jsii.Kernel.call(this, "mutateMove", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(newParent, "newParent is required") });
}
/**
* (experimental) Remove a child node from this node.
*
* @param node This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean mutateRemoveChild(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Node node) {
return software.amazon.jsii.Kernel.call(this, "mutateRemoveChild", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(node, "node is required") });
}
/**
* (experimental) Remove a link from this node.
*
* @param link This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean mutateRemoveLink(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Edge link) {
return software.amazon.jsii.Kernel.call(this, "mutateRemoveLink", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(link, "link is required") });
}
/**
* (experimental) Remove a link to this node.
*
* @param link This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean mutateRemoveReverseLink(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Edge link) {
return software.amazon.jsii.Kernel.call(this, "mutateRemoveReverseLink", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(link, "link is required") });
}
/**
* (experimental) Hoist all children to parent and collapse node to parent.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void mutateUncluster() {
software.amazon.jsii.Kernel.call(this, "mutateUncluster", software.amazon.jsii.NativeType.VOID);
}
/**
* (experimental) Get string representation of this node.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String toString() {
return software.amazon.jsii.Kernel.call(this, "toString", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) Indicates if this node allows destructive mutations.
*
* @see {@link Store.allowDestructiveMutations }
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getAllowDestructiveMutations() {
return software.amazon.jsii.Kernel.get(this, "allowDestructiveMutations", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Get all direct child nodes.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getChildren() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "children", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class))));
}
/**
* (experimental) Get list of Nodes that depend on this node.
*
* @see {@link Node.reverseDependencyLinks }
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getDependedOnBy() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "dependedOnBy", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class))));
}
/**
* (experimental) Get list of Nodes that this node depends on.
*
* @see {@link Node.dependencyLinks }
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getDependencies() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "dependencies", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class))));
}
/**
* (experimental) Gets list of {@link Dependency} links (edges) where this node is the **source**.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getDependencyLinks() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "dependencyLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Dependency.class))));
}
/**
* (experimental) Indicates the depth of the node relative to root (0).
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Number getDepth() {
return software.amazon.jsii.Kernel.get(this, "depth", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
/**
* (experimental) Node id, which is only unique within parent scope.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getId() {
return software.amazon.jsii.Kernel.get(this, "id", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) Indicates if this node is considered a {@link FlagEnum.ASSET}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getIsAsset() {
return software.amazon.jsii.Kernel.get(this, "isAsset", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Indicates if node ConstructInfoFqn denotes a aws-cdk-lib.*.Cfn* construct.
*
* @see {@link FlagEnum.CFN_FQN }
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getIsCfnFqn() {
return software.amazon.jsii.Kernel.get(this, "isCfnFqn", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getIsCluster() {
return software.amazon.jsii.Kernel.get(this, "isCluster", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Indicates if node is a Custom Resource.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getIsCustomResource() {
return software.amazon.jsii.Kernel.get(this, "isCustomResource", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getIsExtraneous() {
return software.amazon.jsii.Kernel.get(this, "isExtraneous", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getIsGraphContainer() {
return software.amazon.jsii.Kernel.get(this, "isGraphContainer", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Indicates if this node is a leaf node, which means it does not have children.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getIsLeaf() {
return software.amazon.jsii.Kernel.get(this, "isLeaf", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Indicates if node is direct child of the graph root node.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getIsTopLevel() {
return software.amazon.jsii.Kernel.get(this, "isTopLevel", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Gets all links (edges) in which this node is the source.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getLinks() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "links", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class))));
}
/**
* (experimental) Type of node.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.NodeTypeEnum getNodeType() {
return software.amazon.jsii.Kernel.get(this, "nodeType", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.NodeTypeEnum.class));
}
/**
* (experimental) Path of the node.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getPath() {
return software.amazon.jsii.Kernel.get(this, "path", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) Get list of Nodes that reference this node.
*
* @see {@link Node.reverseReferenceLinks }
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getReferencedBy() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "referencedBy", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class))));
}
/**
* (experimental) Gets list of {@link Reference} links (edges) where this node is the **source**.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getReferenceLinks() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "referenceLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Reference.class))));
}
/**
* (experimental) Get list of Nodes that this node references.
*
* @see {@link Node.referenceLinks }
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getReferences() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "references", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class))));
}
/**
* (experimental) Gets list of {@link Dependency} links (edges) where this node is the **target**.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getReverseDependencyLinks() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "reverseDependencyLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Dependency.class))));
}
/**
* (experimental) Gets all links (edges) in which this node is the target.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getReverseLinks() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "reverseLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Edge.class))));
}
/**
* (experimental) Gets list of {@link Reference} links (edges) where this node is the **target**.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getReverseReferenceLinks() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "reverseReferenceLinks", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Reference.class))));
}
/**
* (experimental) Gets descending ordered list of ancestors from the root.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getScopes() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "scopes", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class))));
}
/**
* (experimental) Get list of siblings of this node.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getSiblings() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "siblings", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class))));
}
/**
* (experimental) Gets CloudFormation properties for this node.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.PlainObject getCfnProps() {
return software.amazon.jsii.Kernel.get(this, "cfnProps", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.PlainObject.class));
}
/**
* (experimental) Get the CloudFormation resource type for this node.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getCfnType() {
return software.amazon.jsii.Kernel.get(this, "cfnType", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) Synthesized construct information defining jii resolution data.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.ConstructInfo getConstructInfo() {
return software.amazon.jsii.Kernel.get(this, "constructInfo", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.ConstructInfo.class));
}
/**
* (experimental) Synthesized construct information defining jii resolution data.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getConstructInfoFqn() {
return software.amazon.jsii.Kernel.get(this, "constructInfoFqn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) Logical id of the node, which is only unique within containing stack.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getLogicalId() {
return software.amazon.jsii.Kernel.get(this, "logicalId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) Parent node.
*
* Only the root node should not have parent.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.Node getParent() {
return software.amazon.jsii.Kernel.get(this, "parent", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Node.class));
}
/**
* (experimental) Get root stack.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.StackNode getRootStack() {
return software.amazon.jsii.Kernel.get(this, "rootStack", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.StackNode.class));
}
/**
* (experimental) Stack the node is contained in.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.StackNode getStack() {
return software.amazon.jsii.Kernel.get(this, "stack", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.StackNode.class));
}
}