io.cloudshiftdev.awscdk.GetContextValueOptions.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Any
import kotlin.Boolean
import kotlin.String
import kotlin.Unit
import kotlin.collections.Map
/**
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.*;
* Object dummyValue;
* Object props;
* GetContextValueOptions getContextValueOptions = GetContextValueOptions.builder()
* .dummyValue(dummyValue)
* .provider("provider")
* // the properties below are optional
* .ignoreErrorOnMissingContext(false)
* .includeEnvironment(false)
* .props(Map.of(
* "propsKey", props))
* .build();
* ```
*/
public interface GetContextValueOptions : GetContextKeyOptions {
/**
* The value to return if the context value was not found and a missing context is reported.
*/
public fun dummyValue(): Any
/**
* When True, the context provider will not throw an error if missing context is reported.
*
* Default: false
*/
public fun ignoreErrorOnMissingContext(): Boolean? = unwrap(this).getIgnoreErrorOnMissingContext()
/**
* A builder for [GetContextValueOptions]
*/
@CdkDslMarker
public interface Builder {
/**
* @param dummyValue The value to return if the context value was not found and a missing
* context is reported.
*/
public fun dummyValue(dummyValue: Any)
/**
* @param ignoreErrorOnMissingContext When True, the context provider will not throw an error if
* missing context is reported.
*/
public fun ignoreErrorOnMissingContext(ignoreErrorOnMissingContext: Boolean)
/**
* @param includeEnvironment Whether to include the stack's account and region automatically.
*/
public fun includeEnvironment(includeEnvironment: Boolean)
/**
* @param props Provider-specific properties.
*/
public fun props(props: Map)
/**
* @param provider The context provider to query.
*/
public fun provider(provider: String)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.GetContextValueOptions.Builder =
software.amazon.awscdk.GetContextValueOptions.builder()
/**
* @param dummyValue The value to return if the context value was not found and a missing
* context is reported.
*/
override fun dummyValue(dummyValue: Any) {
cdkBuilder.dummyValue(dummyValue)
}
/**
* @param ignoreErrorOnMissingContext When True, the context provider will not throw an error if
* missing context is reported.
*/
override fun ignoreErrorOnMissingContext(ignoreErrorOnMissingContext: Boolean) {
cdkBuilder.ignoreErrorOnMissingContext(ignoreErrorOnMissingContext)
}
/**
* @param includeEnvironment Whether to include the stack's account and region automatically.
*/
override fun includeEnvironment(includeEnvironment: Boolean) {
cdkBuilder.includeEnvironment(includeEnvironment)
}
/**
* @param props Provider-specific properties.
*/
override fun props(props: Map) {
cdkBuilder.props(props.mapValues{CdkObjectWrappers.unwrap(it.value)})
}
/**
* @param provider The context provider to query.
*/
override fun provider(provider: String) {
cdkBuilder.provider(provider)
}
public fun build(): software.amazon.awscdk.GetContextValueOptions = cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.GetContextValueOptions,
) : CdkObject(cdkObject),
GetContextValueOptions {
/**
* The value to return if the context value was not found and a missing context is reported.
*/
override fun dummyValue(): Any = unwrap(this).getDummyValue()
/**
* When True, the context provider will not throw an error if missing context is reported.
*
* Default: false
*/
override fun ignoreErrorOnMissingContext(): Boolean? =
unwrap(this).getIgnoreErrorOnMissingContext()
/**
* Whether to include the stack's account and region automatically.
*
* Default: true
*/
override fun includeEnvironment(): Boolean? = unwrap(this).getIncludeEnvironment()
/**
* Provider-specific properties.
*/
override fun props(): Map = unwrap(this).getProps() ?: emptyMap()
/**
* The context provider to query.
*/
override fun provider(): String = unwrap(this).getProvider()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): GetContextValueOptions {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.GetContextValueOptions):
GetContextValueOptions = CdkObjectWrappers.wrap(cdkObject) as? GetContextValueOptions ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: GetContextValueOptions):
software.amazon.awscdk.GetContextValueOptions = (wrapped as CdkObject).cdkObject as
software.amazon.awscdk.GetContextValueOptions
}
}