io.cloudshiftdev.awscdk.services.stepfunctions.LogOptions.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-cdk-wrapper Show documentation
Kotlin DSL for AWS CDK
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.services.stepfunctions

import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.logs.ILogGroup
import kotlin.Boolean
import kotlin.Unit

/**
 * Defines what execution history events are logged and where they are logged.
 *
 * Example:
 *
 * ```
 * import io.cloudshiftdev.awscdk.services.logs.*;
 * LogGroup logGroup = new LogGroup(this, "MyLogGroup");
 * Chain definition = Chain.start(new Pass(this, "Pass"));
 * StateMachine.Builder.create(this, "MyStateMachine")
 * .definitionBody(DefinitionBody.fromChainable(definition))
 * .logs(LogOptions.builder()
 * .destination(logGroup)
 * .level(LogLevel.ALL)
 * .build())
 * .build();
 * ```
 */
public interface LogOptions {
  /**
   * The log group where the execution history events will be logged.
   */
  public fun destination(): ILogGroup

  /**
   * Determines whether execution data is included in your log.
   *
   * Default: false
   */
  public fun includeExecutionData(): Boolean? = unwrap(this).getIncludeExecutionData()

  /**
   * Defines which category of execution history events are logged.
   *
   * Default: ERROR
   */
  public fun level(): LogLevel? = unwrap(this).getLevel()?.let(LogLevel::wrap)

  /**
   * A builder for [LogOptions]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param destination The log group where the execution history events will be logged. 
     */
    public fun destination(destination: ILogGroup)

    /**
     * @param includeExecutionData Determines whether execution data is included in your log.
     */
    public fun includeExecutionData(includeExecutionData: Boolean)

    /**
     * @param level Defines which category of execution history events are logged.
     */
    public fun level(level: LogLevel)
  }

  private class BuilderImpl : Builder {
    private val cdkBuilder: software.amazon.awscdk.services.stepfunctions.LogOptions.Builder =
        software.amazon.awscdk.services.stepfunctions.LogOptions.builder()

    /**
     * @param destination The log group where the execution history events will be logged. 
     */
    override fun destination(destination: ILogGroup) {
      cdkBuilder.destination(destination.let(ILogGroup.Companion::unwrap))
    }

    /**
     * @param includeExecutionData Determines whether execution data is included in your log.
     */
    override fun includeExecutionData(includeExecutionData: Boolean) {
      cdkBuilder.includeExecutionData(includeExecutionData)
    }

    /**
     * @param level Defines which category of execution history events are logged.
     */
    override fun level(level: LogLevel) {
      cdkBuilder.level(level.let(LogLevel.Companion::unwrap))
    }

    public fun build(): software.amazon.awscdk.services.stepfunctions.LogOptions =
        cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.services.stepfunctions.LogOptions,
  ) : CdkObject(cdkObject),
      LogOptions {
    /**
     * The log group where the execution history events will be logged.
     */
    override fun destination(): ILogGroup = unwrap(this).getDestination().let(ILogGroup::wrap)

    /**
     * Determines whether execution data is included in your log.
     *
     * Default: false
     */
    override fun includeExecutionData(): Boolean? = unwrap(this).getIncludeExecutionData()

    /**
     * Defines which category of execution history events are logged.
     *
     * Default: ERROR
     */
    override fun level(): LogLevel? = unwrap(this).getLevel()?.let(LogLevel::wrap)
  }

  public companion object {
    public operator fun invoke(block: Builder.() -> Unit = {}): LogOptions {
      val builderImpl = BuilderImpl()
      return Wrapper(builderImpl.apply(block).build())
    }

    internal fun wrap(cdkObject: software.amazon.awscdk.services.stepfunctions.LogOptions):
        LogOptions = CdkObjectWrappers.wrap(cdkObject) as? LogOptions ?: Wrapper(cdkObject)

    internal fun unwrap(wrapped: LogOptions):
        software.amazon.awscdk.services.stepfunctions.LogOptions = (wrapped as CdkObject).cdkObject
        as software.amazon.awscdk.services.stepfunctions.LogOptions
  }
}