Google Cloud Native v0.30.0, Apr 14 23

google-native.dialogflow/v2.getEnvironment

Explore with Pulumi AI

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>

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]

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/v2:getEnvironment
  arguments:
    # arguments dictionary

The following arguments are supported:

EnvironmentId string
Location string
Project string

EnvironmentId string
Location string
Project string

environmentId String
location String
project String

environmentId string
location string
project string

environment_id str
location str
project str

environmentId String
location 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.V2.Outputs.GoogleCloudDialogflowV2FulfillmentResponse: 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/ The environment ID for the default environment is -.
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.V2.Outputs.GoogleCloudDialogflowV2TextToSpeechSettingsResponse: 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 GoogleCloudDialogflowV2FulfillmentResponse: 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/ The environment ID for the default environment is -.
State string: The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
TextToSpeechSettings GoogleCloudDialogflowV2TextToSpeechSettingsResponse: 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 GoogleCloudDialogflowV2FulfillmentResponse: 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/ The environment ID for the default environment is -.
state String: The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
textToSpeechSettings GoogleCloudDialogflowV2TextToSpeechSettingsResponse: 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 GoogleCloudDialogflowV2FulfillmentResponse: 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/ The environment ID for the default environment is -.
state string: The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.
textToSpeechSettings GoogleCloudDialogflowV2TextToSpeechSettingsResponse: 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 GoogleCloudDialogflowV2FulfillmentResponse: 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/ The environment ID for the default environment is -.
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 GoogleCloudDialogflowV2TextToSpeechSettingsResponse: 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/ The environment ID for the default environment is -.
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

GoogleCloudDialogflowV2FulfillmentFeatureResponse

Type string: The type of the feature that enabled for fulfillment.

Type string: The type of the feature that enabled for fulfillment.

type String: The type of the feature that enabled for fulfillment.

type string: The type of the feature that enabled for fulfillment.

type str: The type of the feature that enabled for fulfillment.

type String: The type of the feature that enabled for fulfillment.

GoogleCloudDialogflowV2FulfillmentGenericWebServiceResponse

IsCloudFunction 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 string: Optional. The password for HTTP Basic authentication.
RequestHeaders Dictionary<string, string>: Optional. The HTTP request headers to send together with fulfillment requests.
Uri string: The fulfillment URI for receiving POST requests. It must use https protocol.
Username string: Optional. The user name for HTTP Basic authentication.

IsCloudFunction 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 string: Optional. The password for HTTP Basic authentication.
RequestHeaders map[string]string: Optional. The HTTP request headers to send together with fulfillment requests.
Uri string: The fulfillment URI for receiving POST requests. It must use https protocol.
Username string: Optional. The user name for HTTP Basic authentication.

isCloudFunction 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 String: Optional. The password for HTTP Basic authentication.
requestHeaders Map<String,String>: Optional. The HTTP request headers to send together with fulfillment requests.
uri String: The fulfillment URI for receiving POST requests. It must use https protocol.
username String: Optional. The user name for HTTP Basic authentication.

isCloudFunction 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 string: Optional. The password for HTTP Basic authentication.
requestHeaders {[key: string]: string}: Optional. The HTTP request headers to send together with fulfillment requests.
uri string: The fulfillment URI for receiving POST requests. It must use https protocol.
username string: Optional. The user name for HTTP Basic authentication.

is_cloud_function 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 str: Optional. The password for HTTP Basic authentication.
request_headers Mapping[str, str]: Optional. The HTTP request headers to send together with fulfillment requests.
uri str: The fulfillment URI for receiving POST requests. It must use https protocol.
username str: Optional. The user name for HTTP Basic authentication.

isCloudFunction 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 String: Optional. The password for HTTP Basic authentication.
requestHeaders Map<String>: Optional. The HTTP request headers to send together with fulfillment requests.
uri String: The fulfillment URI for receiving POST requests. It must use https protocol.
username String: Optional. The user name for HTTP Basic authentication.

GoogleCloudDialogflowV2FulfillmentResponse

DisplayName string: Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
Enabled bool: Optional. Whether fulfillment is enabled.
Features List<Pulumi.GoogleNative.Dialogflow.V2.Inputs.GoogleCloudDialogflowV2FulfillmentFeatureResponse>: Optional. The field defines whether the fulfillment is enabled for certain features.
GenericWebService Pulumi.GoogleNative.Dialogflow.V2.Inputs.GoogleCloudDialogflowV2FulfillmentGenericWebServiceResponse: Configuration for a generic web service.
Name 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 string: Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
Enabled bool: Optional. Whether fulfillment is enabled.
Features []GoogleCloudDialogflowV2FulfillmentFeatureResponse: Optional. The field defines whether the fulfillment is enabled for certain features.
GenericWebService GoogleCloudDialogflowV2FulfillmentGenericWebServiceResponse: Configuration for a generic web service.
Name 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 String: Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
enabled Boolean: Optional. Whether fulfillment is enabled.
features List<GoogleCloudDialogflowV2FulfillmentFeatureResponse>: Optional. The field defines whether the fulfillment is enabled for certain features.
genericWebService GoogleCloudDialogflowV2FulfillmentGenericWebServiceResponse: Configuration for a generic web service.
name 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 string: Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
enabled boolean: Optional. Whether fulfillment is enabled.
features GoogleCloudDialogflowV2FulfillmentFeatureResponse[]: Optional. The field defines whether the fulfillment is enabled for certain features.
genericWebService GoogleCloudDialogflowV2FulfillmentGenericWebServiceResponse: Configuration for a generic web service.
name 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 str: Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
enabled bool: Optional. Whether fulfillment is enabled.
features Sequence[GoogleCloudDialogflowV2FulfillmentFeatureResponse]: Optional. The field defines whether the fulfillment is enabled for certain features.
generic_web_service GoogleCloudDialogflowV2FulfillmentGenericWebServiceResponse: Configuration for a generic web service.
name 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 String: Optional. The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
enabled Boolean: Optional. Whether fulfillment is enabled.
features List<Property Map>: Optional. The field defines whether the fulfillment is enabled for certain features.
genericWebService Property Map: Configuration for a generic web service.
name 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.

GoogleCloudDialogflowV2TextToSpeechSettingsResponse

EnableTextToSpeech bool: Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
OutputAudioEncoding string: Audio encoding of the synthesized audio content.
SampleRateHertz 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 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 bool: Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
OutputAudioEncoding string: Audio encoding of the synthesized audio content.
SampleRateHertz 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 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 Boolean: Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
outputAudioEncoding String: Audio encoding of the synthesized audio content.
sampleRateHertz 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 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 boolean: Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
outputAudioEncoding string: Audio encoding of the synthesized audio content.
sampleRateHertz 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 {[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 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 str: Audio encoding of the synthesized audio content.
sample_rate_hertz 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 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 Boolean: Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
outputAudioEncoding String: Audio encoding of the synthesized audio content.
sampleRateHertz 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 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