com.pulumi.gcp.apigee.kotlin.FlowhookArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 8.10.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.apigee.kotlin

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.apigee.FlowhookArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * Represents a sharedflow attachment to a flowhook point.
 * To get more information about Flowhook, see:
 * * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.flowhooks#FlowHook)
 * * How-to Guides
 *     * [organizations.environments.flowhooks](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.flowhooks#FlowHook)
 * ## Import
 * Flowhook can be imported using any of these accepted formats:
 * * `organizations/{{org_id}}/environments/{{environment}}/flowhooks/{{flow_hook_point}}`
 * * `{{org_id}}/{{environment}}/{{flow_hook_point}}`
 * When using the `pulumi import` command, Flowhook can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:apigee/flowhook:Flowhook default organizations/{{org_id}}/environments/{{environment}}/flowhooks/{{flow_hook_point}}
 * ```
 * ```sh
 * $ pulumi import gcp:apigee/flowhook:Flowhook default {{org_id}}/{{environment}}/{{flow_hook_point}}
 * ```
 * @property continueOnError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
 * @property description Description of the flow hook.
 * @property environment The resource ID of the environment.
 * @property flowHookPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
 * @property orgId The Apigee Organization associated with the environment
 * @property sharedflow Id of the Sharedflow attaching to a flowhook point.
 */
public data class FlowhookArgs(
    public val continueOnError: Output? = null,
    public val description: Output? = null,
    public val environment: Output? = null,
    public val flowHookPoint: Output? = null,
    public val orgId: Output? = null,
    public val sharedflow: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.apigee.FlowhookArgs =
        com.pulumi.gcp.apigee.FlowhookArgs.builder()
            .continueOnError(continueOnError?.applyValue({ args0 -> args0 }))
            .description(description?.applyValue({ args0 -> args0 }))
            .environment(environment?.applyValue({ args0 -> args0 }))
            .flowHookPoint(flowHookPoint?.applyValue({ args0 -> args0 }))
            .orgId(orgId?.applyValue({ args0 -> args0 }))
            .sharedflow(sharedflow?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [FlowhookArgs].
 */
@PulumiTagMarker
public class FlowhookArgsBuilder internal constructor() {
    private var continueOnError: Output? = null

    private var description: Output? = null

    private var environment: Output? = null

    private var flowHookPoint: Output? = null

    private var orgId: Output? = null

    private var sharedflow: Output? = null

    /**
     * @param value Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
     */
    @JvmName("alyfnxtljtkcqjnj")
    public suspend fun continueOnError(`value`: Output) {
        this.continueOnError = value
    }

    /**
     * @param value Description of the flow hook.
     */
    @JvmName("omhaurwassokjjmf")
    public suspend fun description(`value`: Output) {
        this.description = value
    }

    /**
     * @param value The resource ID of the environment.
     */
    @JvmName("oofooikxuamropki")
    public suspend fun environment(`value`: Output) {
        this.environment = value
    }

    /**
     * @param value Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
     */
    @JvmName("qgagmeodwadhpkpb")
    public suspend fun flowHookPoint(`value`: Output) {
        this.flowHookPoint = value
    }

    /**
     * @param value The Apigee Organization associated with the environment
     */
    @JvmName("ebhxssbwsphxammr")
    public suspend fun orgId(`value`: Output) {
        this.orgId = value
    }

    /**
     * @param value Id of the Sharedflow attaching to a flowhook point.
     */
    @JvmName("yvcnpyoasysntnxv")
    public suspend fun sharedflow(`value`: Output) {
        this.sharedflow = value
    }

    /**
     * @param value Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
     */
    @JvmName("ycecwlwuanoukkpy")
    public suspend fun continueOnError(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.continueOnError = mapped
    }

    /**
     * @param value Description of the flow hook.
     */
    @JvmName("stmnswafmuogeuml")
    public suspend fun description(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.description = mapped
    }

    /**
     * @param value The resource ID of the environment.
     */
    @JvmName("lthqdtmteyriwkje")
    public suspend fun environment(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.environment = mapped
    }

    /**
     * @param value Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
     */
    @JvmName("uynviktinqxbqxei")
    public suspend fun flowHookPoint(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.flowHookPoint = mapped
    }

    /**
     * @param value The Apigee Organization associated with the environment
     */
    @JvmName("fmdjywldwfkpsfgj")
    public suspend fun orgId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.orgId = mapped
    }

    /**
     * @param value Id of the Sharedflow attaching to a flowhook point.
     */
    @JvmName("oslrcsgqtukelikf")
    public suspend fun sharedflow(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.sharedflow = mapped
    }

    internal fun build(): FlowhookArgs = FlowhookArgs(
        continueOnError = continueOnError,
        description = description,
        environment = environment,
        flowHookPoint = flowHookPoint,
        orgId = orgId,
        sharedflow = sharedflow,
    )
}