Package software.aws.awsprototypingsdk.cdkgraph

Class CdkGraphContext

java.lang.Object

software.amazon.jsii.JsiiObject

software.aws.awsprototypingsdk.cdkgraph.CdkGraphContext

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.82.0 (build 2d2ddd7)",
           date="2023-08-24T23:07:44.310Z")
@Stability(Experimental)
public class CdkGraphContext
extends software.amazon.jsii.JsiiObject

(experimental) CdkGraph context.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CdkGraphContext(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CdkGraphContext(software.amazon.jsii.JsiiObjectRef objRef)
	CdkGraphContext(Store store, String outdir)

Method Summary

Modifier and Type	Method	Description
CdkGraphArtifact	getArtifact(String id)	(experimental) Get CdkGraph artifact by id.
Map<String,CdkGraphArtifact>	getArtifacts()	(experimental) Get record of all graph artifacts keyed by artifact id.
CdkGraphArtifact	getGraphJson()	(experimental) Get CdkGraph core graph.json artifact.
String	getOutdir()
Store	getStore()
Boolean	hasArtifactFile(String filename)	(experimental) Indicates if context has an artifact with filename defined.
CdkGraphArtifact	logArtifact(Object source, String id, String filepath)	(experimental) Logs an artifact entry.
CdkGraphArtifact	logArtifact(Object source, String id, String filepath, String description)	(experimental) Logs an artifact entry.
CdkGraphArtifact	writeArtifact(Object source, String id, String filename, String data)	(experimental) Writes artifact data to outdir and logs the entry.
CdkGraphArtifact	writeArtifact(Object source, String id, String filename, String data, String description)	(experimental) Writes artifact data to outdir and logs the entry.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CdkGraphContext

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

CdkGraphContext

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

CdkGraphContext

@Stability(Experimental)
public CdkGraphContext(@NotNull
                       Store store,
                       @NotNull
                       String outdir)

Parameters:

store - This parameter is required.

outdir - This parameter is required.

Method Detail

getArtifact

@Stability(Experimental)
@NotNull
public CdkGraphArtifact getArtifact(@NotNull
                                    String id)

(experimental) Get CdkGraph artifact by id.

Parameters:

id - This parameter is required.

hasArtifactFile

@Stability(Experimental)
@NotNull
public Boolean hasArtifactFile(@NotNull
                               String filename)

(experimental) Indicates if context has an artifact with filename defined.

Parameters:

filename - This parameter is required.

logArtifact

@Stability(Experimental)
@NotNull
public CdkGraphArtifact logArtifact(@NotNull
                                    Object source,
                                    @NotNull
                                    String id,
                                    @NotNull
                                    String filepath,
                                    @Nullable
                                    String description)

(experimental) Logs an artifact entry.

In general this should not be called directly, as writeArtifact should be utilized to perform writing and logging artifacts. However some plugins utilize other tools that generate the artifacts, in which case the plugin would call this method to log the entry.

Parameters:

source - The source of the artifact, such as the name of plugin. This parameter is required.

id - Unique id of the artifact. This parameter is required.

filepath - Full path where the artifact is stored. This parameter is required.

description - Description of the artifact.

logArtifact

@Stability(Experimental)
@NotNull
public CdkGraphArtifact logArtifact(@NotNull
                                    Object source,
                                    @NotNull
                                    String id,
                                    @NotNull
                                    String filepath)

(experimental) Logs an artifact entry.

In general this should not be called directly, as writeArtifact should be utilized to perform writing and logging artifacts. However some plugins utilize other tools that generate the artifacts, in which case the plugin would call this method to log the entry.

Parameters:

source - The source of the artifact, such as the name of plugin. This parameter is required.

id - Unique id of the artifact. This parameter is required.

filepath - Full path where the artifact is stored. This parameter is required.

writeArtifact

@Stability(Experimental)
@NotNull
public CdkGraphArtifact writeArtifact(@NotNull
                                      Object source,
                                      @NotNull
                                      String id,
                                      @NotNull
                                      String filename,
                                      @NotNull
                                      String data,
                                      @Nullable
                                      String description)

(experimental) Writes artifact data to outdir and logs the entry.

Parameters:

source - The source of the artifact, such as the name of plugin. This parameter is required.

id - Unique id of the artifact. This parameter is required.

filename - Relative name of the file. This parameter is required.

data - This parameter is required.

description - Description of the artifact.

writeArtifact

@Stability(Experimental)
@NotNull
public CdkGraphArtifact writeArtifact(@NotNull
                                      Object source,
                                      @NotNull
                                      String id,
                                      @NotNull
                                      String filename,
                                      @NotNull
                                      String data)

(experimental) Writes artifact data to outdir and logs the entry.

Parameters:

source - The source of the artifact, such as the name of plugin. This parameter is required.

id - Unique id of the artifact. This parameter is required.

filename - Relative name of the file. This parameter is required.

data - This parameter is required.

getArtifacts

@Stability(Experimental)
@NotNull
public Map<String,CdkGraphArtifact> getArtifacts()

(experimental) Get record of all graph artifacts keyed by artifact id.

getGraphJson

@Stability(Experimental)
@NotNull
public CdkGraphArtifact getGraphJson()

(experimental) Get CdkGraph core graph.json artifact.

getOutdir

@Stability(Experimental)
@NotNull
public String getOutdir()

getStore

@Stability(Experimental)
@NotNull
public Store getStore()