Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Environment.
Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#description
def description() -> ::String
- (::String) — The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
#description=
def description=(value) -> ::String
- value (::String) — The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
- (::String) — The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
#display_name
def display_name() -> ::String
- (::String) — Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
#display_name=
def display_name=(value) -> ::String
- value (::String) — Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
- (::String) — Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
#name
def name() -> ::String
-
(::String) — The name of the environment.
Format:
projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>
.
#name=
def name=(value) -> ::String
-
value (::String) — The name of the environment.
Format:
projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>
.
-
(::String) — The name of the environment.
Format:
projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>
.
#test_cases_config
def test_cases_config() -> ::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig
- (::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig) — The test cases config for continuous tests of this environment.
#test_cases_config=
def test_cases_config=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig
- value (::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig) — The test cases config for continuous tests of this environment.
- (::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig) — The test cases config for continuous tests of this environment.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Update time of this environment.
#version_configs
def version_configs() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Environment::VersionConfig>
-
(::Array<::Google::Cloud::Dialogflow::CX::V3::Environment::VersionConfig>) — Required. A list of configurations for flow versions. You should include version
configs for all flows that are reachable from [
Start Flow
][Agent.start_flow] in the agent. Otherwise, an error will be returned.
#version_configs=
def version_configs=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Environment::VersionConfig>
-
value (::Array<::Google::Cloud::Dialogflow::CX::V3::Environment::VersionConfig>) — Required. A list of configurations for flow versions. You should include version
configs for all flows that are reachable from [
Start Flow
][Agent.start_flow] in the agent. Otherwise, an error will be returned.
-
(::Array<::Google::Cloud::Dialogflow::CX::V3::Environment::VersionConfig>) — Required. A list of configurations for flow versions. You should include version
configs for all flows that are reachable from [
Start Flow
][Agent.start_flow] in the agent. Otherwise, an error will be returned.
#webhook_config
def webhook_config() -> ::Google::Cloud::Dialogflow::CX::V3::Environment::WebhookConfig
- (::Google::Cloud::Dialogflow::CX::V3::Environment::WebhookConfig) — The webhook configuration for this environment.
#webhook_config=
def webhook_config=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Environment::WebhookConfig
- value (::Google::Cloud::Dialogflow::CX::V3::Environment::WebhookConfig) — The webhook configuration for this environment.
- (::Google::Cloud::Dialogflow::CX::V3::Environment::WebhookConfig) — The webhook configuration for this environment.