com.pulumi.gcp.diagflow.kotlin.CxEnvironment.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
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.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.diagflow.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.diagflow.kotlin.outputs.CxEnvironmentVersionConfig
import com.pulumi.gcp.diagflow.kotlin.outputs.CxEnvironmentVersionConfig.Companion.toKotlin
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
/**
* Builder for [CxEnvironment].
*/
@PulumiTagMarker
public class CxEnvironmentResourceBuilder internal constructor() {
public var name: String? = null
public var args: CxEnvironmentArgs = CxEnvironmentArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend CxEnvironmentArgsBuilder.() -> Unit) {
val builder = CxEnvironmentArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): CxEnvironment {
val builtJavaResource = com.pulumi.gcp.diagflow.CxEnvironment(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return CxEnvironment(builtJavaResource)
}
}
/**
* Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments.
* When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent.
* When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
* To get more information about Environment, see:
* * [API documentation](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.environments)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/dialogflow/cx/docs)
* ## Example Usage
* ### Dialogflowcx Environment Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const agent = new gcp.diagflow.CxAgent("agent", {
* displayName: "dialogflowcx-agent",
* location: "global",
* defaultLanguageCode: "en",
* supportedLanguageCodes: [
* "fr",
* "de",
* "es",
* ],
* timeZone: "America/New_York",
* description: "Example description.",
* avatarUri: "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
* enableStackdriverLogging: true,
* enableSpellCorrection: true,
* speechToTextSettings: {
* enableSpeechAdaptation: true,
* },
* });
* const version1 = new gcp.diagflow.CxVersion("version_1", {
* parent: agent.startFlow,
* displayName: "1.0.0",
* description: "version 1.0.0",
* });
* const development = new gcp.diagflow.CxEnvironment("development", {
* parent: agent.id,
* displayName: "Development",
* description: "Development Environment",
* versionConfigs: [{
* version: version1.id,
* }],
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* agent = gcp.diagflow.CxAgent("agent",
* display_name="dialogflowcx-agent",
* location="global",
* default_language_code="en",
* supported_language_codes=[
* "fr",
* "de",
* "es",
* ],
* time_zone="America/New_York",
* description="Example description.",
* avatar_uri="https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
* enable_stackdriver_logging=True,
* enable_spell_correction=True,
* speech_to_text_settings=gcp.diagflow.CxAgentSpeechToTextSettingsArgs(
* enable_speech_adaptation=True,
* ))
* version1 = gcp.diagflow.CxVersion("version_1",
* parent=agent.start_flow,
* display_name="1.0.0",
* description="version 1.0.0")
* development = gcp.diagflow.CxEnvironment("development",
* parent=agent.id,
* display_name="Development",
* description="Development Environment",
* version_configs=[gcp.diagflow.CxEnvironmentVersionConfigArgs(
* version=version1.id,
* )])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var agent = new Gcp.Diagflow.CxAgent("agent", new()
* {
* DisplayName = "dialogflowcx-agent",
* Location = "global",
* DefaultLanguageCode = "en",
* SupportedLanguageCodes = new[]
* {
* "fr",
* "de",
* "es",
* },
* TimeZone = "America/New_York",
* Description = "Example description.",
* AvatarUri = "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
* EnableStackdriverLogging = true,
* EnableSpellCorrection = true,
* SpeechToTextSettings = new Gcp.Diagflow.Inputs.CxAgentSpeechToTextSettingsArgs
* {
* EnableSpeechAdaptation = true,
* },
* });
* var version1 = new Gcp.Diagflow.CxVersion("version_1", new()
* {
* Parent = agent.StartFlow,
* DisplayName = "1.0.0",
* Description = "version 1.0.0",
* });
* var development = new Gcp.Diagflow.CxEnvironment("development", new()
* {
* Parent = agent.Id,
* DisplayName = "Development",
* Description = "Development Environment",
* VersionConfigs = new[]
* {
* new Gcp.Diagflow.Inputs.CxEnvironmentVersionConfigArgs
* {
* Version = version1.Id,
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/diagflow"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* agent, err := diagflow.NewCxAgent(ctx, "agent", &diagflow.CxAgentArgs{
* DisplayName: pulumi.String("dialogflowcx-agent"),
* Location: pulumi.String("global"),
* DefaultLanguageCode: pulumi.String("en"),
* SupportedLanguageCodes: pulumi.StringArray{
* pulumi.String("fr"),
* pulumi.String("de"),
* pulumi.String("es"),
* },
* TimeZone: pulumi.String("America/New_York"),
* Description: pulumi.String("Example description."),
* AvatarUri: pulumi.String("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png"),
* EnableStackdriverLogging: pulumi.Bool(true),
* EnableSpellCorrection: pulumi.Bool(true),
* SpeechToTextSettings: &diagflow.CxAgentSpeechToTextSettingsArgs{
* EnableSpeechAdaptation: pulumi.Bool(true),
* },
* })
* if err != nil {
* return err
* }
* version1, err := diagflow.NewCxVersion(ctx, "version_1", &diagflow.CxVersionArgs{
* Parent: agent.StartFlow,
* DisplayName: pulumi.String("1.0.0"),
* Description: pulumi.String("version 1.0.0"),
* })
* if err != nil {
* return err
* }
* _, err = diagflow.NewCxEnvironment(ctx, "development", &diagflow.CxEnvironmentArgs{
* Parent: agent.ID(),
* DisplayName: pulumi.String("Development"),
* Description: pulumi.String("Development Environment"),
* VersionConfigs: diagflow.CxEnvironmentVersionConfigArray{
* &diagflow.CxEnvironmentVersionConfigArgs{
* Version: version1.ID(),
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.diagflow.CxAgent;
* import com.pulumi.gcp.diagflow.CxAgentArgs;
* import com.pulumi.gcp.diagflow.inputs.CxAgentSpeechToTextSettingsArgs;
* import com.pulumi.gcp.diagflow.CxVersion;
* import com.pulumi.gcp.diagflow.CxVersionArgs;
* import com.pulumi.gcp.diagflow.CxEnvironment;
* import com.pulumi.gcp.diagflow.CxEnvironmentArgs;
* import com.pulumi.gcp.diagflow.inputs.CxEnvironmentVersionConfigArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var agent = new CxAgent("agent", CxAgentArgs.builder()
* .displayName("dialogflowcx-agent")
* .location("global")
* .defaultLanguageCode("en")
* .supportedLanguageCodes(
* "fr",
* "de",
* "es")
* .timeZone("America/New_York")
* .description("Example description.")
* .avatarUri("https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png")
* .enableStackdriverLogging(true)
* .enableSpellCorrection(true)
* .speechToTextSettings(CxAgentSpeechToTextSettingsArgs.builder()
* .enableSpeechAdaptation(true)
* .build())
* .build());
* var version1 = new CxVersion("version1", CxVersionArgs.builder()
* .parent(agent.startFlow())
* .displayName("1.0.0")
* .description("version 1.0.0")
* .build());
* var development = new CxEnvironment("development", CxEnvironmentArgs.builder()
* .parent(agent.id())
* .displayName("Development")
* .description("Development Environment")
* .versionConfigs(CxEnvironmentVersionConfigArgs.builder()
* .version(version1.id())
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* agent:
* type: gcp:diagflow:CxAgent
* properties:
* displayName: dialogflowcx-agent
* location: global
* defaultLanguageCode: en
* supportedLanguageCodes:
* - fr
* - de
* - es
* timeZone: America/New_York
* description: Example description.
* avatarUri: https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png
* enableStackdriverLogging: true
* enableSpellCorrection: true
* speechToTextSettings:
* enableSpeechAdaptation: true
* version1:
* type: gcp:diagflow:CxVersion
* name: version_1
* properties:
* parent: ${agent.startFlow}
* displayName: 1.0.0
* description: version 1.0.0
* development:
* type: gcp:diagflow:CxEnvironment
* properties:
* parent: ${agent.id}
* displayName: Development
* description: Development Environment
* versionConfigs:
* - version: ${version1.id}
* ```
*
* ## Import
* Environment can be imported using any of these accepted formats:
* * `{{parent}}/environments/{{name}}`
* * `{{parent}}/{{name}}`
* When using the `pulumi import` command, Environment can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:diagflow/cxEnvironment:CxEnvironment default {{parent}}/environments/{{name}}
* ```
* ```sh
* $ pulumi import gcp:diagflow/cxEnvironment:CxEnvironment default {{parent}}/{{name}}
* ```
*/
public class CxEnvironment internal constructor(
override val javaResource: com.pulumi.gcp.diagflow.CxEnvironment,
) : KotlinCustomResource(javaResource, CxEnvironmentMapper) {
/**
* The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is
* rejected.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The human-readable name of the environment (unique in an agent). Limit of 64 characters.
*/
public val displayName: Output
get() = javaResource.displayName().applyValue({ args0 -> args0 })
/**
* The name of the environment.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The Agent to create an Environment for. Format: projects//locations//agents/.
*/
public val parent: Output?
get() = javaResource.parent().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Update time of this environment. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
*/
public val updateTime: Output
get() = javaResource.updateTime().applyValue({ args0 -> args0 })
/**
* A list of configurations for flow versions. You should include version configs for all flows that are reachable from [Start Flow][Agent.start_flow] in the agent. Otherwise, an error will be returned.
* Structure is documented below.
*/
public val versionConfigs: Output>
get() = javaResource.versionConfigs().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> toKotlin(args0) })
})
})
}
public object CxEnvironmentMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.diagflow.CxEnvironment::class == javaResource::class
override fun map(javaResource: Resource): CxEnvironment = CxEnvironment(
javaResource as
com.pulumi.gcp.diagflow.CxEnvironment,
)
}
/**
* @see [CxEnvironment].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [CxEnvironment].
*/
public suspend fun cxEnvironment(
name: String,
block: suspend CxEnvironmentResourceBuilder.() -> Unit,
): CxEnvironment {
val builder = CxEnvironmentResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [CxEnvironment].
* @param name The _unique_ name of the resulting resource.
*/
public fun cxEnvironment(name: String): CxEnvironment {
val builder = CxEnvironmentResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy