com.hashicorp.cdktf.IResolveContext Maven / Gradle / Ivy
package com.hashicorp.cdktf;
/**
* (experimental) Current resolution context for tokens.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.98.0 (build 00b106d)", date = "2024-05-28T19:32:20.106Z")
@software.amazon.jsii.Jsii(module = com.hashicorp.cdktf.$Module.class, fqn = "cdktf.IResolveContext")
@software.amazon.jsii.Jsii.Proxy(IResolveContext.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface IResolveContext extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) True when we are still preparing, false if we're rendering the final output.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.Boolean getPreparing();
/**
* (experimental) The scope from which resolution has been initiated.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull software.constructs.IConstruct getScope();
/**
* (experimental) True when ${} should not be parsed, and treated as literals.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getIgnoreEscapes() {
return null;
}
/**
* (experimental) True when ${} should not be parsed, and treated as literals.
*/
@software.amazon.jsii.Optional
default void setIgnoreEscapes(final @org.jetbrains.annotations.Nullable java.lang.Boolean value) {
throw new UnsupportedOperationException("'void " + getClass().getCanonicalName() + "#setIgnoreEscapes(@org.jetbrains.annotations.Nullable java.lang.Boolean)' is not implemented!");
}
/**
* (experimental) TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getIteratorContext() {
return null;
}
/**
* (experimental) TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.
*/
@software.amazon.jsii.Optional
default void setIteratorContext(final @org.jetbrains.annotations.Nullable java.lang.String value) {
throw new UnsupportedOperationException("'void " + getClass().getCanonicalName() + "#setIteratorContext(@org.jetbrains.annotations.Nullable java.lang.String)' is not implemented!");
}
/**
* (experimental) True when ${} should be ommitted (because already inside them), false otherwise.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getSuppressBraces() {
return null;
}
/**
* (experimental) True when ${} should be ommitted (because already inside them), false otherwise.
*/
@software.amazon.jsii.Optional
default void setSuppressBraces(final @org.jetbrains.annotations.Nullable java.lang.Boolean value) {
throw new UnsupportedOperationException("'void " + getClass().getCanonicalName() + "#setSuppressBraces(@org.jetbrains.annotations.Nullable java.lang.Boolean)' is not implemented!");
}
/**
* (experimental) True when ${} should not be included in the string to be resolved, outputs a warning.
*
* Default: false
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getWarnEscapes() {
return null;
}
/**
* (experimental) True when ${} should not be included in the string to be resolved, outputs a warning.
*
* Default: false
*/
@software.amazon.jsii.Optional
default void setWarnEscapes(final @org.jetbrains.annotations.Nullable java.lang.Boolean value) {
throw new UnsupportedOperationException("'void " + getClass().getCanonicalName() + "#setWarnEscapes(@org.jetbrains.annotations.Nullable java.lang.Boolean)' is not implemented!");
}
/**
* (experimental) Use this postprocessor after the entire token structure has been resolved.
*
* @param postProcessor This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
void registerPostProcessor(final @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.IPostProcessor postProcessor);
/**
* (experimental) Resolve an inner object.
*
* @param x This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.Object resolve(final @org.jetbrains.annotations.NotNull java.lang.Object x);
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements com.hashicorp.cdktf.IResolveContext.Jsii$Default {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* (experimental) True when we are still preparing, false if we're rendering the final output.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.NotNull java.lang.Boolean getPreparing() {
return software.amazon.jsii.Kernel.get(this, "preparing", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) The scope from which resolution has been initiated.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.NotNull software.constructs.IConstruct getScope() {
return software.amazon.jsii.Kernel.get(this, "scope", software.amazon.jsii.NativeType.forClass(software.constructs.IConstruct.class));
}
/**
* (experimental) True when ${} should not be parsed, and treated as literals.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.Nullable java.lang.Boolean getIgnoreEscapes() {
return software.amazon.jsii.Kernel.get(this, "ignoreEscapes", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) True when ${} should not be parsed, and treated as literals.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final void setIgnoreEscapes(final @org.jetbrains.annotations.Nullable java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "ignoreEscapes", value);
}
/**
* (experimental) TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.Nullable java.lang.String getIteratorContext() {
return software.amazon.jsii.Kernel.get(this, "iteratorContext", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final void setIteratorContext(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "iteratorContext", value);
}
/**
* (experimental) True when ${} should be ommitted (because already inside them), false otherwise.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.Nullable java.lang.Boolean getSuppressBraces() {
return software.amazon.jsii.Kernel.get(this, "suppressBraces", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) True when ${} should be ommitted (because already inside them), false otherwise.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final void setSuppressBraces(final @org.jetbrains.annotations.Nullable java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "suppressBraces", value);
}
/**
* (experimental) True when ${} should not be included in the string to be resolved, outputs a warning.
*
* Default: false
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.Nullable java.lang.Boolean getWarnEscapes() {
return software.amazon.jsii.Kernel.get(this, "warnEscapes", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) True when ${} should not be included in the string to be resolved, outputs a warning.
*
* Default: false
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final void setWarnEscapes(final @org.jetbrains.annotations.Nullable java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "warnEscapes", value);
}
/**
* (experimental) Use this postprocessor after the entire token structure has been resolved.
*
* @param postProcessor This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final void registerPostProcessor(final @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.IPostProcessor postProcessor) {
software.amazon.jsii.Kernel.call(this, "registerPostProcessor", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(postProcessor, "postProcessor is required") });
}
/**
* (experimental) Resolve an inner object.
*
* @param x This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final @org.jetbrains.annotations.NotNull java.lang.Object resolve(final @org.jetbrains.annotations.NotNull java.lang.Object x) {
return software.amazon.jsii.Kernel.call(this, "resolve", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { x });
}
}
/**
* Internal default implementation for {@link IResolveContext}.
*/
@software.amazon.jsii.Internal
interface Jsii$Default extends IResolveContext {
/**
* (experimental) True when we are still preparing, false if we're rendering the final output.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.NotNull java.lang.Boolean getPreparing() {
return software.amazon.jsii.Kernel.get(this, "preparing", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) The scope from which resolution has been initiated.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.NotNull software.constructs.IConstruct getScope() {
return software.amazon.jsii.Kernel.get(this, "scope", software.amazon.jsii.NativeType.forClass(software.constructs.IConstruct.class));
}
/**
* (experimental) True when ${} should not be parsed, and treated as literals.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getIgnoreEscapes() {
return software.amazon.jsii.Kernel.get(this, "ignoreEscapes", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) True when ${} should not be parsed, and treated as literals.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default void setIgnoreEscapes(final @org.jetbrains.annotations.Nullable java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "ignoreEscapes", value);
}
/**
* (experimental) TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getIteratorContext() {
return software.amazon.jsii.Kernel.get(this, "iteratorContext", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default void setIteratorContext(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "iteratorContext", value);
}
/**
* (experimental) True when ${} should be ommitted (because already inside them), false otherwise.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getSuppressBraces() {
return software.amazon.jsii.Kernel.get(this, "suppressBraces", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) True when ${} should be ommitted (because already inside them), false otherwise.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default void setSuppressBraces(final @org.jetbrains.annotations.Nullable java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "suppressBraces", value);
}
/**
* (experimental) True when ${} should not be included in the string to be resolved, outputs a warning.
*
* Default: false
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getWarnEscapes() {
return software.amazon.jsii.Kernel.get(this, "warnEscapes", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
* (experimental) True when ${} should not be included in the string to be resolved, outputs a warning.
*
* Default: false
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default void setWarnEscapes(final @org.jetbrains.annotations.Nullable java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "warnEscapes", value);
}
/**
* (experimental) Use this postprocessor after the entire token structure has been resolved.
*
* @param postProcessor This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
default void registerPostProcessor(final @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.IPostProcessor postProcessor) {
software.amazon.jsii.Kernel.call(this, "registerPostProcessor", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(postProcessor, "postProcessor is required") });
}
/**
* (experimental) Resolve an inner object.
*
* @param x This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
default @org.jetbrains.annotations.NotNull java.lang.Object resolve(final @org.jetbrains.annotations.NotNull java.lang.Object x) {
return software.amazon.jsii.Kernel.call(this, "resolve", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { x });
}
}
}