software.aws.awsprototypingsdk.cdkgraph.BaseEntity Maven / Gradle / Ivy
Show all versions of cdk-graph Show documentation
package software.aws.awsprototypingsdk.cdkgraph;
/**
* (experimental) Base class for all store entities (Node and Edges).
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.82.0 (build 2d2ddd7)", date = "2023-08-15T05:45:13.643Z")
@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.BaseEntity")
public abstract class BaseEntity extends software.amazon.jsii.JsiiObject implements software.aws.awsprototypingsdk.cdkgraph.ISerializableEntity {
protected BaseEntity(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected BaseEntity(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)
protected BaseEntity(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IBaseEntityProps 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 attribute.
*
* @param key This parameter is required.
* @param value This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addAttribute(final @org.jetbrains.annotations.NotNull java.lang.String key, final @org.jetbrains.annotations.NotNull java.lang.Object value) {
software.amazon.jsii.Kernel.call(this, "addAttribute", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(key, "key is required"), value });
}
/**
* (experimental) Add flag.
*
* @param flag This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addFlag(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.FlagEnum flag) {
software.amazon.jsii.Kernel.call(this, "addFlag", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(flag, "flag is required") });
}
/**
* (experimental) Add metadata entry.
*
* @param metadataType This parameter is required.
* @param data This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addMetadata(final @org.jetbrains.annotations.NotNull java.lang.String metadataType, final @org.jetbrains.annotations.NotNull java.lang.Object data) {
software.amazon.jsii.Kernel.call(this, "addMetadata", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(metadataType, "metadataType is required"), data });
}
/**
* (experimental) Add tag.
*
* @param key This parameter is required.
* @param value This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addTag(final @org.jetbrains.annotations.NotNull java.lang.String key, final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.call(this, "addTag", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(key, "key is required"), java.util.Objects.requireNonNull(value, "value is required") });
}
/**
* (experimental) Applies data (attributes, metadata, tags, flag) to entity.
*
* Generally used only for mutations such as collapse and consume to retain data.
*
* @param data
- The data to apply.
This parameter is required.
* @param overwrite
* @param applyFlags - Indicates if data is overwritten - Indicates if flags should be applied.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void applyData(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IBaseEntityDataProps data, final @org.jetbrains.annotations.Nullable java.lang.Boolean overwrite, final @org.jetbrains.annotations.Nullable java.lang.Boolean applyFlags) {
software.amazon.jsii.Kernel.call(this, "applyData", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(data, "data is required"), overwrite, applyFlags });
}
/**
* (experimental) Applies data (attributes, metadata, tags, flag) to entity.
*
* Generally used only for mutations such as collapse and consume to retain data.
*
* @param data
- The data to apply.
This parameter is required.
* @param overwrite
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void applyData(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IBaseEntityDataProps data, final @org.jetbrains.annotations.Nullable java.lang.Boolean overwrite) {
software.amazon.jsii.Kernel.call(this, "applyData", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(data, "data is required"), overwrite });
}
/**
* (experimental) Applies data (attributes, metadata, tags, flag) to entity.
*
* Generally used only for mutations such as collapse and consume to retain data.
*
* @param data
- The data to apply.
This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void applyData(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.IBaseEntityDataProps data) {
software.amazon.jsii.Kernel.call(this, "applyData", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(data, "data is required") });
}
/**
* (experimental) Retrieves all metadata entries of a given type.
*
* @param metadataType This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List findMetadata(final @org.jetbrains.annotations.NotNull java.lang.String metadataType) {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "findMetadata", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.constructs.MetadataEntry.class)), new Object[] { java.util.Objects.requireNonNull(metadataType, "metadataType is required") }));
}
/**
* (experimental) Get attribute by key.
*
* @param key This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Object getAttribute(final @org.jetbrains.annotations.NotNull java.lang.String key) {
return software.amazon.jsii.Kernel.call(this, "getAttribute", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { java.util.Objects.requireNonNull(key, "key is required") });
}
/**
* (experimental) Get tag by key.
*
* @param key This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getTag(final @org.jetbrains.annotations.NotNull java.lang.String key) {
return software.amazon.jsii.Kernel.call(this, "getTag", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(key, "key is required") });
}
/**
* (experimental) Indicates if entity has a given attribute defined, and optionally with a specific value.
*
* @param key This parameter is required.
* @param value
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean hasAttribute(final @org.jetbrains.annotations.NotNull java.lang.String key, final @org.jetbrains.annotations.Nullable java.lang.Object value) {
return software.amazon.jsii.Kernel.call(this, "hasAttribute", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(key, "key is required"), value });
}
/**
* (experimental) Indicates if entity has a given attribute defined, and optionally with a specific value.
*
* @param key This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean hasAttribute(final @org.jetbrains.annotations.NotNull java.lang.String key) {
return software.amazon.jsii.Kernel.call(this, "hasAttribute", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(key, "key is required") });
}
/**
* (experimental) Indicates if entity has a given flag.
*
* @param flag This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean hasFlag(final @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.FlagEnum flag) {
return software.amazon.jsii.Kernel.call(this, "hasFlag", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(flag, "flag is required") });
}
/**
* (experimental) Indicates if entity has matching metadata entry.
*
* @param metadataType This parameter is required.
* @param data This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean hasMetadata(final @org.jetbrains.annotations.NotNull java.lang.String metadataType, final @org.jetbrains.annotations.NotNull java.lang.Object data) {
return software.amazon.jsii.Kernel.call(this, "hasMetadata", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(metadataType, "metadataType is required"), data });
}
/**
* (experimental) Indicates if entity has tag, optionally verifying tag value.
*
* @param key This parameter is required.
* @param value
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean hasTag(final @org.jetbrains.annotations.NotNull java.lang.String key, final @org.jetbrains.annotations.Nullable java.lang.String value) {
return software.amazon.jsii.Kernel.call(this, "hasTag", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(key, "key is required"), value });
}
/**
* (experimental) Indicates if entity has tag, optionally verifying tag value.
*
* @param key This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean hasTag(final @org.jetbrains.annotations.NotNull java.lang.String key) {
return software.amazon.jsii.Kernel.call(this, "hasTag", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(key, "key is required") });
}
/**
* (experimental) Destroy the entity be removing all references and removing from store.
*
* @param strict
- If
strict, then entity must not have any references remaining when attempting to destroy.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract void mutateDestroy(final @org.jetbrains.annotations.Nullable java.lang.Boolean strict);
/**
* (experimental) Destroy the entity be removing all references and removing from store.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract void mutateDestroy();
/**
* (experimental) Set attribute.
*
* This will overwrite existing attribute.
*
* @param key This parameter is required.
* @param value This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void setAttribute(final @org.jetbrains.annotations.NotNull java.lang.String key, final @org.jetbrains.annotations.NotNull java.lang.Object value) {
software.amazon.jsii.Kernel.call(this, "setAttribute", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(key, "key is required"), value });
}
/**
* (experimental) Set tag.
*
* Will overwrite existing tag.
*
* @param key This parameter is required.
* @param value This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void setTag(final @org.jetbrains.annotations.NotNull java.lang.String key, final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.call(this, "setTag", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(key, "key is required"), java.util.Objects.requireNonNull(value, "value is required") });
}
/**
* (experimental) Get readonly record of all attributes.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.Map getAttributes() {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.get(this, "attributes", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class))));
}
/**
* (experimental) Get readonly list of all flags.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getFlags() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "flags", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.FlagEnum.class))));
}
/**
* (experimental) Indicates if the entity has been destroyed (eg: removed from store).
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getIsDestroyed() {
return software.amazon.jsii.Kernel.get(this, "isDestroyed", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Indicates if the entity has had destructive mutations applied.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getIsMutated() {
return software.amazon.jsii.Kernel.get(this, "isMutated", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) Get readonly list of all metadata entries.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getMetadata() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "metadata", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.constructs.MetadataEntry.class))));
}
/**
* (experimental) Reference to the store.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.cdkgraph.Store getStore() {
return software.amazon.jsii.Kernel.get(this, "store", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.cdkgraph.Store.class));
}
/**
* (experimental) Get readonly record of all tags.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.Map getTags() {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class))));
}
/**
* (experimental) Universally unique identifier.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getUuid() {
return software.amazon.jsii.Kernel.get(this, "uuid", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
private static final class Jsii$Proxy extends software.aws.awsprototypingsdk.cdkgraph.BaseEntity implements software.aws.awsprototypingsdk.cdkgraph.ISerializableEntity.Jsii$Default {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* (experimental) Destroy the entity be removing all references and removing from store.
*
* @param strict
- If
strict, then entity must not have any references remaining when attempting to destroy.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final 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) Destroy the entity be removing all references and removing from store.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final void mutateDestroy() {
software.amazon.jsii.Kernel.call(this, "mutateDestroy", software.amazon.jsii.NativeType.VOID);
}
}
}