Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class 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.
Generated from protobuf message google.cloud.dialogflow.cx.v3.Environment
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of the environment. Format: |
↳ display_name |
string
Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. |
↳ description |
string
The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. |
↳ version_configs |
array<Google\Cloud\Dialogflow\Cx\V3\Environment\VersionConfig>
A list of configurations for flow versions. You should include version configs for all flows that are reachable from |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Update time of this environment. |
↳ test_cases_config |
Google\Cloud\Dialogflow\Cx\V3\Environment\TestCasesConfig
The test cases config for continuous tests of this environment. |
↳ webhook_config |
Google\Cloud\Dialogflow\Cx\V3\Environment\WebhookConfig
The webhook configuration for this environment. |
getName
The name of the environment.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/environments/<Environment ID>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
The name of the environment.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/environments/<Environment ID>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The human-readable name of the environment (unique in an agent).
Limit of 64 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. The human-readable name of the environment (unique in an agent).
Limit of 64 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVersionConfigs
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setVersionConfigs
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\Cx\V3\Environment\VersionConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Update time of this environment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time of this environment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTestCasesConfig
The test cases config for continuous tests of this environment.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\Cx\V3\Environment\TestCasesConfig|null |
|
hasTestCasesConfig
clearTestCasesConfig
setTestCasesConfig
The test cases config for continuous tests of this environment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\Cx\V3\Environment\TestCasesConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWebhookConfig
The webhook configuration for this environment.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\Cx\V3\Environment\WebhookConfig|null |
|
hasWebhookConfig
clearWebhookConfig
setWebhookConfig
The webhook configuration for this environment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\Cx\V3\Environment\WebhookConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|