Google Cloud Native v0.30.0, Apr 14 23
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:
- Environment
Id string - Location string
- Project string
- Environment
Id string - Location string
- Project string
- environment
Id String - location String
- project String
- environment
Id string - location string
- project string
- environment_
id str - location str
- project str
- environment
Id String - location String
- project String
getEnvironment Result
The following output properties are available:
- Agent
Version 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.
Google Native. Dialogflow. V2. Outputs. Google Cloud Dialogflow V2Fulfillment Response 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.
- Text
To Pulumi.Speech Settings Google Native. Dialogflow. V2. Outputs. Google Cloud Dialogflow V2Text To Speech Settings Response Optional. Text to speech settings for this environment.
- Update
Time 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 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
Google
Cloud Dialogflow V2Fulfillment Response 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.
- Text
To GoogleSpeech Settings Cloud Dialogflow V2Text To Speech Settings Response Optional. Text to speech settings for this environment.
- Update
Time 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 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
Google
Cloud Dialogflow V2Fulfillment Response 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.
- text
To GoogleSpeech Settings Cloud Dialogflow V2Text To Speech Settings Response Optional. Text to speech settings for this environment.
- update
Time 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 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
Google
Cloud Dialogflow V2Fulfillment Response 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.
- text
To GoogleSpeech Settings Cloud Dialogflow V2Text To Speech Settings Response Optional. Text to speech settings for this environment.
- update
Time 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
Google
Cloud Dialogflow V2Fulfillment Response 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_ Googlespeech_ settings Cloud Dialogflow V2Text To Speech Settings Response 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.
- agent
Version 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.
- text
To Property MapSpeech Settings Optional. Text to speech settings for this environment.
- update
Time 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
- Is
Cloud boolFunction 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.
- Request
Headers 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.
- Is
Cloud boolFunction 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.
- Request
Headers 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.
- is
Cloud BooleanFunction 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.
- request
Headers 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.
- is
Cloud booleanFunction 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.
- request
Headers {[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_ boolfunction 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.
- is
Cloud BooleanFunction 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.
- request
Headers 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
- Display
Name 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.
Google Native. Dialogflow. V2. Inputs. Google Cloud Dialogflow V2Fulfillment Feature Response> Optional. The field defines whether the fulfillment is enabled for certain features.
- Generic
Web Pulumi.Service Google Native. Dialogflow. V2. Inputs. Google Cloud Dialogflow V2Fulfillment Generic Web Service Response 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 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
[]Google
Cloud Dialogflow V2Fulfillment Feature Response Optional. The field defines whether the fulfillment is enabled for certain features.
- Generic
Web GoogleService Cloud Dialogflow V2Fulfillment Generic Web Service Response 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 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<Google
Cloud Dialogflow V2Fulfillment Feature Response> Optional. The field defines whether the fulfillment is enabled for certain features.
- generic
Web GoogleService Cloud Dialogflow V2Fulfillment Generic Web Service Response 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 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
Google
Cloud Dialogflow V2Fulfillment Feature Response[] Optional. The field defines whether the fulfillment is enabled for certain features.
- generic
Web GoogleService Cloud Dialogflow V2Fulfillment Generic Web Service Response 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[Google
Cloud Dialogflow V2Fulfillment Feature Response] Optional. The field defines whether the fulfillment is enabled for certain features.
- generic_
web_ Googleservice Cloud Dialogflow V2Fulfillment Generic Web Service Response 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.
- display
Name 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.
- generic
Web Property MapService 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
- Enable
Text boolTo Speech Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
- Output
Audio stringEncoding Audio encoding of the synthesized audio content.
- Sample
Rate intHertz 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 Dictionary<string, string>Configs Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
- Enable
Text boolTo Speech Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
- Output
Audio stringEncoding Audio encoding of the synthesized audio content.
- Sample
Rate intHertz 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 map[string]stringConfigs Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
- enable
Text BooleanTo Speech Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
- output
Audio StringEncoding Audio encoding of the synthesized audio content.
- sample
Rate IntegerHertz 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 Map<String,String>Configs Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
- enable
Text booleanTo Speech Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
- output
Audio stringEncoding Audio encoding of the synthesized audio content.
- sample
Rate numberHertz 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 {[key: string]: string}Configs Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
- enable_
text_ boolto_ speech Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
- output_
audio_ strencoding Audio encoding of the synthesized audio content.
- sample_
rate_ inthertz 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_ Mapping[str, str]configs Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.
- enable
Text BooleanTo Speech Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
- output
Audio StringEncoding Audio encoding of the synthesized audio content.
- sample
Rate NumberHertz 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 Map<String>Configs 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