Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v2beta1
  6. getEnvironment

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dialogflow/v2beta1.getEnvironment

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Retrieves the specified agent 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>
Copy
def get_environment(environment_id: Optional[str] = None,
                    location: Optional[str] = None,
                    project: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(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]
Copy
func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:dialogflow/v2beta1:getEnvironment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EnvironmentId This property is required. string
Location This property is required. string
Project string
EnvironmentId This property is required. string
Location This property is required. string
Project string
environmentId This property is required. String
location This property is required. String
project String
environmentId This property is required. string
location This property is required. string
project string
environment_id This property is required. str
location This property is required. str
project str
environmentId This property is required. String
location This property is required. String
project String

getEnvironment Result

The following output properties are available:

AgentVersion string
Optional. The agent version loaded into this environment. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
Description string
Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
Fulfillment Pulumi.GoogleNative.Dialogflow.V2Beta1.Outputs.GoogleCloudDialogflowV2beta1FulfillmentResponse
Optional. The fulfillment settings to use for this environment.
Name string
The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/
State string
The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
TextToSpeechSettings Pulumi.GoogleNative.Dialogflow.V2Beta1.Outputs.GoogleCloudDialogflowV2beta1TextToSpeechSettingsResponse
Optional. Text to speech settings for this environment.
UpdateTime string
The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
AgentVersion string
Optional. The agent version loaded into this environment. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
Description string
Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
Fulfillment GoogleCloudDialogflowV2beta1FulfillmentResponse
Optional. The fulfillment settings to use for this environment.
Name string
The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/
State string
The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
TextToSpeechSettings GoogleCloudDialogflowV2beta1TextToSpeechSettingsResponse
Optional. Text to speech settings for this environment.
UpdateTime string
The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
agentVersion String
Optional. The agent version loaded into this environment. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
description String
Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
fulfillment GoogleCloudDialogflowV2beta1FulfillmentResponse
Optional. The fulfillment settings to use for this environment.
name String
The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/
state String
The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
textToSpeechSettings GoogleCloudDialogflowV2beta1TextToSpeechSettingsResponse
Optional. Text to speech settings for this environment.
updateTime String
The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
agentVersion string
Optional. The agent version loaded into this environment. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
description string
Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
fulfillment GoogleCloudDialogflowV2beta1FulfillmentResponse
Optional. The fulfillment settings to use for this environment.
name string
The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/
state string
The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
textToSpeechSettings GoogleCloudDialogflowV2beta1TextToSpeechSettingsResponse
Optional. Text to speech settings for this environment.
updateTime string
The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
agent_version str
Optional. The agent version loaded into this environment. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
description str
Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
fulfillment GoogleCloudDialogflowV2beta1FulfillmentResponse
Optional. The fulfillment settings to use for this environment.
name str
The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/
state str
The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
text_to_speech_settings GoogleCloudDialogflowV2beta1TextToSpeechSettingsResponse
Optional. Text to speech settings for this environment.
update_time str
The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
agentVersion String
Optional. The agent version loaded into this environment. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/
description String
Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.
fulfillment Property Map
Optional. The fulfillment settings to use for this environment.
name String
The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/environments/
state String
The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
textToSpeechSettings Property Map
Optional. Text to speech settings for this environment.
updateTime String
The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.

Supporting Types

GoogleCloudDialogflowV2beta1FulfillmentFeatureResponse

Type This property is required. string
The type of the feature that enabled for fulfillment.
Type This property is required. string
The type of the feature that enabled for fulfillment.
type This property is required. String
The type of the feature that enabled for fulfillment.
type This property is required. string
The type of the feature that enabled for fulfillment.
type This property is required. str
The type of the feature that enabled for fulfillment.
type This property is required. String
The type of the feature that enabled for fulfillment.

GoogleCloudDialogflowV2beta1FulfillmentGenericWebServiceResponse

IsCloudFunction This property is required. bool
Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
Password This property is required. string
The password for HTTP Basic authentication.
RequestHeaders This property is required. Dictionary<string, string>
The HTTP request headers to send together with fulfillment requests.
Uri This property is required. string
The fulfillment URI for receiving POST requests. It must use https protocol.
Username This property is required. string
The user name for HTTP Basic authentication.
IsCloudFunction This property is required. bool
Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
Password This property is required. string
The password for HTTP Basic authentication.
RequestHeaders This property is required. map[string]string
The HTTP request headers to send together with fulfillment requests.
Uri This property is required. string
The fulfillment URI for receiving POST requests. It must use https protocol.
Username This property is required. string
The user name for HTTP Basic authentication.
isCloudFunction This property is required. Boolean
Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
password This property is required. String
The password for HTTP Basic authentication.
requestHeaders This property is required. Map<String,String>
The HTTP request headers to send together with fulfillment requests.
uri This property is required. String
The fulfillment URI for receiving POST requests. It must use https protocol.
username This property is required. String
The user name for HTTP Basic authentication.
isCloudFunction This property is required. boolean
Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
password This property is required. string
The password for HTTP Basic authentication.
requestHeaders This property is required. {[key: string]: string}
The HTTP request headers to send together with fulfillment requests.
uri This property is required. string
The fulfillment URI for receiving POST requests. It must use https protocol.
username This property is required. string
The user name for HTTP Basic authentication.
is_cloud_function This property is required. bool
Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
password This property is required. str
The password for HTTP Basic authentication.
request_headers This property is required. Mapping[str, str]
The HTTP request headers to send together with fulfillment requests.
uri This property is required. str
The fulfillment URI for receiving POST requests. It must use https protocol.
username This property is required. str
The user name for HTTP Basic authentication.
isCloudFunction This property is required. Boolean
Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
password This property is required. String
The password for HTTP Basic authentication.
requestHeaders This property is required. Map<String>
The HTTP request headers to send together with fulfillment requests.
uri This property is required. String
The fulfillment URI for receiving POST requests. It must use https protocol.
username This property is required. String
The user name for HTTP Basic authentication.

GoogleCloudDialogflowV2beta1FulfillmentResponse

DisplayName This property is required. string
The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
Enabled This property is required. bool
Whether fulfillment is enabled.
Features This property is required. List<Pulumi.GoogleNative.Dialogflow.V2Beta1.Inputs.GoogleCloudDialogflowV2beta1FulfillmentFeatureResponse>
The field defines whether the fulfillment is enabled for certain features.
GenericWebService This property is required. Pulumi.GoogleNative.Dialogflow.V2Beta1.Inputs.GoogleCloudDialogflowV2beta1FulfillmentGenericWebServiceResponse
Configuration for a generic web service.
Name This property is required. string
The unique identifier of the fulfillment. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.
DisplayName This property is required. string
The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
Enabled This property is required. bool
Whether fulfillment is enabled.
Features This property is required. []GoogleCloudDialogflowV2beta1FulfillmentFeatureResponse
The field defines whether the fulfillment is enabled for certain features.
GenericWebService This property is required. GoogleCloudDialogflowV2beta1FulfillmentGenericWebServiceResponse
Configuration for a generic web service.
Name This property is required. string
The unique identifier of the fulfillment. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.
displayName This property is required. String
The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
enabled This property is required. Boolean
Whether fulfillment is enabled.
features This property is required. List<GoogleCloudDialogflowV2beta1FulfillmentFeatureResponse>
The field defines whether the fulfillment is enabled for certain features.
genericWebService This property is required. GoogleCloudDialogflowV2beta1FulfillmentGenericWebServiceResponse
Configuration for a generic web service.
name This property is required. String
The unique identifier of the fulfillment. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.
displayName This property is required. string
The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
enabled This property is required. boolean
Whether fulfillment is enabled.
features This property is required. GoogleCloudDialogflowV2beta1FulfillmentFeatureResponse[]
The field defines whether the fulfillment is enabled for certain features.
genericWebService This property is required. GoogleCloudDialogflowV2beta1FulfillmentGenericWebServiceResponse
Configuration for a generic web service.
name This property is required. string
The unique identifier of the fulfillment. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.
display_name This property is required. str
The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
enabled This property is required. bool
Whether fulfillment is enabled.
features This property is required. Sequence[GoogleCloudDialogflowV2beta1FulfillmentFeatureResponse]
The field defines whether the fulfillment is enabled for certain features.
generic_web_service This property is required. GoogleCloudDialogflowV2beta1FulfillmentGenericWebServiceResponse
Configuration for a generic web service.
name This property is required. str
The unique identifier of the fulfillment. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.
displayName This property is required. String
The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
enabled This property is required. Boolean
Whether fulfillment is enabled.
features This property is required. List<Property Map>
The field defines whether the fulfillment is enabled for certain features.
genericWebService This property is required. Property Map
Configuration for a generic web service.
name This property is required. String
The unique identifier of the fulfillment. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.

GoogleCloudDialogflowV2beta1TextToSpeechSettingsResponse

EnableTextToSpeech This property is required. bool
Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
OutputAudioEncoding This property is required. string
Audio encoding of the synthesized audio content.
SampleRateHertz This property is required. int
Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
SynthesizeSpeechConfigs This property is required. Dictionary<string, string>
Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
EnableTextToSpeech This property is required. bool
Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
OutputAudioEncoding This property is required. string
Audio encoding of the synthesized audio content.
SampleRateHertz This property is required. int
Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
SynthesizeSpeechConfigs This property is required. map[string]string
Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
enableTextToSpeech This property is required. Boolean
Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
outputAudioEncoding This property is required. String
Audio encoding of the synthesized audio content.
sampleRateHertz This property is required. Integer
Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
synthesizeSpeechConfigs This property is required. Map<String,String>
Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
enableTextToSpeech This property is required. boolean
Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
outputAudioEncoding This property is required. string
Audio encoding of the synthesized audio content.
sampleRateHertz This property is required. number
Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
synthesizeSpeechConfigs This property is required. {[key: string]: string}
Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
enable_text_to_speech This property is required. bool
Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
output_audio_encoding This property is required. str
Audio encoding of the synthesized audio content.
sample_rate_hertz This property is required. int
Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
synthesize_speech_configs This property is required. Mapping[str, str]
Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
enableTextToSpeech This property is required. Boolean
Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
outputAudioEncoding This property is required. String
Audio encoding of the synthesized audio content.
sampleRateHertz This property is required. Number
Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
synthesizeSpeechConfigs This property is required. Map<String>
Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native