Google Native

Pulumi Official
Package maintained by Pulumi
v0.23.0 published on Thursday, Aug 11, 2022 by Pulumi

getEnvironment

Retrieves the specified Environment.

Using getEnvironment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>
def get_environment(agent_id: Optional[str] = None,
                    environment_id: Optional[str] = None,
                    location: Optional[str] = None,
                    project: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(agent_id: Optional[pulumi.Input[str]] = None,
                    environment_id: Optional[pulumi.Input[str]] = None,
                    location: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]
func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

> Note: This function is named LookupEnvironment in the Go SDK.

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:dialogflow/v3:getEnvironment
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AgentId string
EnvironmentId string
Location string
Project string
AgentId string
EnvironmentId string
Location string
Project string
agentId String
environmentId String
location String
project String
agentId string
environmentId string
location string
project string
agentId String
environmentId String
location String
project String

getEnvironment Result

The following output properties are available:

Description string

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

DisplayName string

The human-readable name of the environment (unique in an agent). Limit of 64 characters.

Name string

The name of the environment. Format: projects//locations//agents//environments/.

TestCasesConfig Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3EnvironmentTestCasesConfigResponse

The test cases config for continuous tests of this environment.

UpdateTime string

Update time of this environment.

VersionConfigs List<Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3EnvironmentVersionConfigResponse>

A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

WebhookConfig Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3EnvironmentWebhookConfigResponse

The webhook configuration for this environment.

Description string

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

DisplayName string

The human-readable name of the environment (unique in an agent). Limit of 64 characters.

Name string

The name of the environment. Format: projects//locations//agents//environments/.

TestCasesConfig GoogleCloudDialogflowCxV3EnvironmentTestCasesConfigResponse

The test cases config for continuous tests of this environment.

UpdateTime string

Update time of this environment.

VersionConfigs []GoogleCloudDialogflowCxV3EnvironmentVersionConfigResponse

A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

WebhookConfig GoogleCloudDialogflowCxV3EnvironmentWebhookConfigResponse

The webhook configuration for this environment.

description String

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

displayName String

The human-readable name of the environment (unique in an agent). Limit of 64 characters.

name String

The name of the environment. Format: projects//locations//agents//environments/.

testCasesConfig GoogleCloudDialogflowCxV3EnvironmentTestCasesConfigResponse

The test cases config for continuous tests of this environment.

updateTime String

Update time of this environment.

versionConfigs List<GoogleCloudDialogflowCxV3EnvironmentVersionConfigResponse>

A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

webhookConfig GoogleCloudDialogflowCxV3EnvironmentWebhookConfigResponse

The webhook configuration for this environment.

description string

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

displayName string

The human-readable name of the environment (unique in an agent). Limit of 64 characters.

name string

The name of the environment. Format: projects//locations//agents//environments/.

testCasesConfig GoogleCloudDialogflowCxV3EnvironmentTestCasesConfigResponse

The test cases config for continuous tests of this environment.

updateTime string

Update time of this environment.

versionConfigs GoogleCloudDialogflowCxV3EnvironmentVersionConfigResponse[]

A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

webhookConfig GoogleCloudDialogflowCxV3EnvironmentWebhookConfigResponse

The webhook configuration for this environment.

description str

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

display_name str

The human-readable name of the environment (unique in an agent). Limit of 64 characters.

name str

The name of the environment. Format: projects//locations//agents//environments/.

test_cases_config GoogleCloudDialogflowCxV3EnvironmentTestCasesConfigResponse

The test cases config for continuous tests of this environment.

update_time str

Update time of this environment.

version_configs Sequence[GoogleCloudDialogflowCxV3EnvironmentVersionConfigResponse]

A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

webhook_config GoogleCloudDialogflowCxV3EnvironmentWebhookConfigResponse

The webhook configuration for this environment.

description String

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

displayName String

The human-readable name of the environment (unique in an agent). Limit of 64 characters.

name String

The name of the environment. Format: projects//locations//agents//environments/.

testCasesConfig Property Map

The test cases config for continuous tests of this environment.

updateTime String

Update time of this environment.

versionConfigs List<Property Map>

A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

webhookConfig Property Map

The webhook configuration for this environment.

Supporting Types

GoogleCloudDialogflowCxV3EnvironmentTestCasesConfigResponse

EnableContinuousRun bool

Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.

EnablePredeploymentRun bool

Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.

TestCases List<string>

A list of test case names to run. They should be under the same agent. Format of each test case name: projects//locations/ /agents//testCases/

EnableContinuousRun bool

Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.

EnablePredeploymentRun bool

Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.

TestCases []string

A list of test case names to run. They should be under the same agent. Format of each test case name: projects//locations/ /agents//testCases/

enableContinuousRun Boolean

Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.

enablePredeploymentRun Boolean

Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.

testCases List<String>

A list of test case names to run. They should be under the same agent. Format of each test case name: projects//locations/ /agents//testCases/

enableContinuousRun boolean

Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.

enablePredeploymentRun boolean

Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.

testCases string[]

A list of test case names to run. They should be under the same agent. Format of each test case name: projects//locations/ /agents//testCases/

enable_continuous_run bool

Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.

enable_predeployment_run bool

Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.

test_cases Sequence[str]

A list of test case names to run. They should be under the same agent. Format of each test case name: projects//locations/ /agents//testCases/

enableContinuousRun Boolean

Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.

enablePredeploymentRun Boolean

Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.

testCases List<String>

A list of test case names to run. They should be under the same agent. Format of each test case name: projects//locations/ /agents//testCases/

GoogleCloudDialogflowCxV3EnvironmentVersionConfigResponse

Version string

Format: projects//locations//agents//flows//versions/.

Version string

Format: projects//locations//agents//flows//versions/.

version String

Format: projects//locations//agents//flows//versions/.

version string

Format: projects//locations//agents//flows//versions/.

version str

Format: projects//locations//agents//flows//versions/.

version String

Format: projects//locations//agents//flows//versions/.

GoogleCloudDialogflowCxV3EnvironmentWebhookConfigResponse

WebhookOverrides List<Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookResponse>

The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in generic_web_service and service_directory.

WebhookOverrides []GoogleCloudDialogflowCxV3WebhookResponse

The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in generic_web_service and service_directory.

webhookOverrides List<GoogleCloudDialogflowCxV3WebhookResponse>

The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in generic_web_service and service_directory.

webhookOverrides GoogleCloudDialogflowCxV3WebhookResponse[]

The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in generic_web_service and service_directory.

webhook_overrides Sequence[GoogleCloudDialogflowCxV3WebhookResponse]

The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in generic_web_service and service_directory.

webhookOverrides List<Property Map>

The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in generic_web_service and service_directory.

GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

AllowedCaCerts List<string>

Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Password string

The password for HTTP Basic authentication.

RequestHeaders Dictionary<string, string>

The HTTP request headers to send together with webhook requests.

Uri string

The webhook URI for receiving POST requests. It must use https protocol.

Username string

The user name for HTTP Basic authentication.

AllowedCaCerts []string

Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Password string

The password for HTTP Basic authentication.

RequestHeaders map[string]string

The HTTP request headers to send together with webhook requests.

Uri string

The webhook URI for receiving POST requests. It must use https protocol.

Username string

The user name for HTTP Basic authentication.

allowedCaCerts List<String>

Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

password String

The password for HTTP Basic authentication.

requestHeaders Map<String,String>

The HTTP request headers to send together with webhook requests.

uri String

The webhook URI for receiving POST requests. It must use https protocol.

username String

The user name for HTTP Basic authentication.

allowedCaCerts string[]

Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

password string

The password for HTTP Basic authentication.

requestHeaders {[key: string]: string}

The HTTP request headers to send together with webhook requests.

uri string

The webhook URI for receiving POST requests. It must use https protocol.

username string

The user name for HTTP Basic authentication.

allowed_ca_certs Sequence[str]

Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

password str

The password for HTTP Basic authentication.

request_headers Mapping[str, str]

The HTTP request headers to send together with webhook requests.

uri str

The webhook URI for receiving POST requests. It must use https protocol.

username str

The user name for HTTP Basic authentication.

allowedCaCerts List<String>

Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

password String

The password for HTTP Basic authentication.

requestHeaders Map<String>

The HTTP request headers to send together with webhook requests.

uri String

The webhook URI for receiving POST requests. It must use https protocol.

username String

The user name for HTTP Basic authentication.

GoogleCloudDialogflowCxV3WebhookResponse

Disabled bool

Indicates whether the webhook is disabled.

DisplayName string

The human-readable name of the webhook, unique within the agent.

GenericWebService Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Configuration for a generic web service.

Name string

The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.

ServiceDirectory Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigResponse

Configuration for a Service Directory service.

Timeout string

Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

Disabled bool

Indicates whether the webhook is disabled.

DisplayName string

The human-readable name of the webhook, unique within the agent.

GenericWebService GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Configuration for a generic web service.

Name string

The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.

ServiceDirectory GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigResponse

Configuration for a Service Directory service.

Timeout string

Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

disabled Boolean

Indicates whether the webhook is disabled.

displayName String

The human-readable name of the webhook, unique within the agent.

genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Configuration for a generic web service.

name String

The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.

serviceDirectory GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigResponse

Configuration for a Service Directory service.

timeout String

Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

disabled boolean

Indicates whether the webhook is disabled.

displayName string

The human-readable name of the webhook, unique within the agent.

genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Configuration for a generic web service.

name string

The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.

serviceDirectory GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigResponse

Configuration for a Service Directory service.

timeout string

Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

disabled bool

Indicates whether the webhook is disabled.

display_name str

The human-readable name of the webhook, unique within the agent.

generic_web_service GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Configuration for a generic web service.

name str

The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.

service_directory GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigResponse

Configuration for a Service Directory service.

timeout str

Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

disabled Boolean

Indicates whether the webhook is disabled.

displayName String

The human-readable name of the webhook, unique within the agent.

genericWebService Property Map

Configuration for a generic web service.

name String

The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.

serviceDirectory Property Map

Configuration for a Service Directory service.

timeout String

Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfigResponse

GenericWebService Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Generic Service configuration of this webhook.

Service string

The name of Service Directory service. Format: projects//locations//namespaces//services/. Location ID of the service directory must be the same as the location of the agent.

GenericWebService GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Generic Service configuration of this webhook.

Service string

The name of Service Directory service. Format: projects//locations//namespaces//services/. Location ID of the service directory must be the same as the location of the agent.

genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Generic Service configuration of this webhook.

service String

The name of Service Directory service. Format: projects//locations//namespaces//services/. Location ID of the service directory must be the same as the location of the agent.

genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Generic Service configuration of this webhook.

service string

The name of Service Directory service. Format: projects//locations//namespaces//services/. Location ID of the service directory must be the same as the location of the agent.

generic_web_service GoogleCloudDialogflowCxV3WebhookGenericWebServiceResponse

Generic Service configuration of this webhook.

service str

The name of Service Directory service. Format: projects//locations//namespaces//services/. Location ID of the service directory must be the same as the location of the agent.

genericWebService Property Map

Generic Service configuration of this webhook.

service String

The name of Service Directory service. Format: projects//locations//namespaces//services/. Location ID of the service directory must be the same as the location of the agent.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0