software.aws.awsprototypingsdk.cdkgraph.CdkGraph Maven / Gradle / Ivy
Show all versions of cdk-graph Show documentation
package software.aws.awsprototypingsdk.cdkgraph;
/**
* (experimental) CdkGraph construct is the cdk-graph framework controller that is responsible for computing the graph, storing serialized graph, and instrumenting plugins per the plugin contract.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.82.0 (build 2d2ddd7)", date = "2023-08-15T05:45:13.657Z")
@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.CdkGraph")
public class CdkGraph extends software.constructs.Construct {
protected CdkGraph(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected CdkGraph(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
static {
ID = software.amazon.jsii.JsiiObject.jsiiStaticGet(software.aws.awsprototypingsdk.cdkgraph.CdkGraph.class, "ID", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
VERSION = software.amazon.jsii.JsiiObject.jsiiStaticGet(software.aws.awsprototypingsdk.cdkgraph.CdkGraph.class, "VERSION", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* @param root This parameter is required.
* @param props
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public CdkGraph(final @org.jetbrains.annotations.NotNull software.constructs.Construct root, final @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.ICdkGraphProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(root, "root is required"), props });
}
/**
* @param root This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public CdkGraph(final @org.jetbrains.annotations.NotNull software.constructs.Construct root) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(root, "root is required") });
}
/**
* (experimental) Asynchronous report generation. This operation enables running expensive and non-synchronous report generation by plugins post synthesis.
*
* If a given plugin requires performing asynchronous operations or is general expensive, it should
* utilize report rather than synthesize.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void report() {
software.amazon.jsii.Kernel.asyncCall(this, "report", software.amazon.jsii.NativeType.VOID);
}
/**
* (experimental) Fixed CdkGraph construct id.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static java.lang.String ID;
/**
* (experimental) Current CdkGraph semantic version.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static java.lang.String VERSION;
/**
* (experimental) Config.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.Map getConfig() {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.get(this, "config", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class))));
}
/**
* (experimental) List of plugins registered with this instance.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getPlugins() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "plugins", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin.class))));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.constructs.Construct getRoot() {
return software.amazon.jsii.Kernel.get(this, "root", software.amazon.jsii.NativeType.forClass(software.constructs.Construct.class));
}
/**
* (experimental) Get the context for the graph instance.
*
* This will be undefined before construct synthesis has initiated.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.cdkgraph.CdkGraphContext getGraphContext() {
return software.amazon.jsii.Kernel.get(this, "graphContext", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.CdkGraphContext.class));
}
/**
* (experimental) A fluent builder for {@link software.aws.awsprototypingsdk.cdkgraph.CdkGraph}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param root This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final software.constructs.Construct root) {
return new Builder(root);
}
private final software.constructs.Construct root;
private software.aws.awsprototypingsdk.cdkgraph.ICdkGraphProps.Builder props;
private Builder(final software.constructs.Construct root) {
this.root = root;
}
/**
* (experimental) List of plugins to extends the graph.
*
* Plugins are invoked at each phases in fifo order.
*
* @return {@code this}
* @param plugins List of plugins to extends the graph. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder plugins(final java.util.List plugins) {
this.props().plugins(plugins);
return this;
}
/**
* @return a newly built instance of {@link software.aws.awsprototypingsdk.cdkgraph.CdkGraph}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public software.aws.awsprototypingsdk.cdkgraph.CdkGraph build() {
return new software.aws.awsprototypingsdk.cdkgraph.CdkGraph(
this.root,
this.props != null ? this.props.build() : null
);
}
private software.aws.awsprototypingsdk.cdkgraph.ICdkGraphProps.Builder props() {
if (this.props == null) {
this.props = new software.aws.awsprototypingsdk.cdkgraph.ICdkGraphProps.Builder();
}
return this.props;
}
}
}