Class: Google::Cloud::Dialogflow::CX::V3::Environment

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/environment.rb

Overview

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.

Defined Under Namespace

Classes: TestCasesConfig, VersionConfig, WebhookConfig

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

Returns:

  • (::String) —

    The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/environment.rb', line 61

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the version.
  # @!attribute [rw] version
  #   @return [::String]
  #     Required. Both flow and playbook versions are supported.
  #     Format for flow version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
  #     Format for playbook version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.
  class VersionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for continuous tests.
  # @!attribute [rw] test_cases
  #   @return [::Array<::String>]
  #     A list of test case names to run. They should be under the same agent.
  #     Format of each test case name:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`
  # @!attribute [rw] enable_continuous_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     periodically. Default false. If set to true, run once a day.
  # @!attribute [rw] enable_predeployment_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     before deploying a flow version to the environment. Default false.
  class TestCasesConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for webhooks.
  # @!attribute [rw] webhook_overrides
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Webhook>]
  #     The list of webhooks to override for the agent environment. The webhook
  #     must exist in the agent. You can override fields in
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#generic_web_service `generic_web_service`}
  #     and
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#service_directory `service_directory`}.
  class WebhookConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.

Returns:

  • (::String) —

    Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/environment.rb', line 61

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the version.
  # @!attribute [rw] version
  #   @return [::String]
  #     Required. Both flow and playbook versions are supported.
  #     Format for flow version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
  #     Format for playbook version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.
  class VersionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for continuous tests.
  # @!attribute [rw] test_cases
  #   @return [::Array<::String>]
  #     A list of test case names to run. They should be under the same agent.
  #     Format of each test case name:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`
  # @!attribute [rw] enable_continuous_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     periodically. Default false. If set to true, run once a day.
  # @!attribute [rw] enable_predeployment_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     before deploying a flow version to the environment. Default false.
  class TestCasesConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for webhooks.
  # @!attribute [rw] webhook_overrides
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Webhook>]
  #     The list of webhooks to override for the agent environment. The webhook
  #     must exist in the agent. You can override fields in
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#generic_web_service `generic_web_service`}
  #     and
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#service_directory `service_directory`}.
  class WebhookConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The name of the environment. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>.

Returns:

  • (::String) —

    The name of the environment. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/environment.rb', line 61

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the version.
  # @!attribute [rw] version
  #   @return [::String]
  #     Required. Both flow and playbook versions are supported.
  #     Format for flow version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
  #     Format for playbook version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.
  class VersionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for continuous tests.
  # @!attribute [rw] test_cases
  #   @return [::Array<::String>]
  #     A list of test case names to run. They should be under the same agent.
  #     Format of each test case name:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`
  # @!attribute [rw] enable_continuous_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     periodically. Default false. If set to true, run once a day.
  # @!attribute [rw] enable_predeployment_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     before deploying a flow version to the environment. Default false.
  class TestCasesConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for webhooks.
  # @!attribute [rw] webhook_overrides
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Webhook>]
  #     The list of webhooks to override for the agent environment. The webhook
  #     must exist in the agent. You can override fields in
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#generic_web_service `generic_web_service`}
  #     and
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#service_directory `service_directory`}.
  class WebhookConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#test_cases_config ⇒ ::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig

Returns The test cases config for continuous tests of this environment.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/environment.rb', line 61

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the version.
  # @!attribute [rw] version
  #   @return [::String]
  #     Required. Both flow and playbook versions are supported.
  #     Format for flow version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
  #     Format for playbook version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.
  class VersionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for continuous tests.
  # @!attribute [rw] test_cases
  #   @return [::Array<::String>]
  #     A list of test case names to run. They should be under the same agent.
  #     Format of each test case name:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`
  # @!attribute [rw] enable_continuous_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     periodically. Default false. If set to true, run once a day.
  # @!attribute [rw] enable_predeployment_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     before deploying a flow version to the environment. Default false.
  class TestCasesConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for webhooks.
  # @!attribute [rw] webhook_overrides
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Webhook>]
  #     The list of webhooks to override for the agent environment. The webhook
  #     must exist in the agent. You can override fields in
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#generic_web_service `generic_web_service`}
  #     and
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#service_directory `service_directory`}.
  class WebhookConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Update time of this environment.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/environment.rb', line 61

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the version.
  # @!attribute [rw] version
  #   @return [::String]
  #     Required. Both flow and playbook versions are supported.
  #     Format for flow version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
  #     Format for playbook version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.
  class VersionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for continuous tests.
  # @!attribute [rw] test_cases
  #   @return [::Array<::String>]
  #     A list of test case names to run. They should be under the same agent.
  #     Format of each test case name:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`
  # @!attribute [rw] enable_continuous_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     periodically. Default false. If set to true, run once a day.
  # @!attribute [rw] enable_predeployment_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     before deploying a flow version to the environment. Default false.
  class TestCasesConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for webhooks.
  # @!attribute [rw] webhook_overrides
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Webhook>]
  #     The list of webhooks to override for the agent environment. The webhook
  #     must exist in the agent. You can override fields in
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#generic_web_service `generic_web_service`}
  #     and
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#service_directory `service_directory`}.
  class WebhookConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#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 [Start Flow][Agent.start_flow] in the agent. Otherwise, an error will be returned.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/environment.rb', line 61

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the version.
  # @!attribute [rw] version
  #   @return [::String]
  #     Required. Both flow and playbook versions are supported.
  #     Format for flow version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
  #     Format for playbook version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.
  class VersionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for continuous tests.
  # @!attribute [rw] test_cases
  #   @return [::Array<::String>]
  #     A list of test case names to run. They should be under the same agent.
  #     Format of each test case name:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`
  # @!attribute [rw] enable_continuous_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     periodically. Default false. If set to true, run once a day.
  # @!attribute [rw] enable_predeployment_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     before deploying a flow version to the environment. Default false.
  class TestCasesConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for webhooks.
  # @!attribute [rw] webhook_overrides
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Webhook>]
  #     The list of webhooks to override for the agent environment. The webhook
  #     must exist in the agent. You can override fields in
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#generic_web_service `generic_web_service`}
  #     and
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#service_directory `service_directory`}.
  class WebhookConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#webhook_config ⇒ ::Google::Cloud::Dialogflow::CX::V3::Environment::WebhookConfig

Returns The webhook configuration for this environment.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/environment.rb', line 61

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the version.
  # @!attribute [rw] version
  #   @return [::String]
  #     Required. Both flow and playbook versions are supported.
  #     Format for flow version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
  #     Format for playbook version:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.
  class VersionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for continuous tests.
  # @!attribute [rw] test_cases
  #   @return [::Array<::String>]
  #     A list of test case names to run. They should be under the same agent.
  #     Format of each test case name:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`
  # @!attribute [rw] enable_continuous_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     periodically. Default false. If set to true, run once a day.
  # @!attribute [rw] enable_predeployment_run
  #   @return [::Boolean]
  #     Whether to run test cases in
  #     {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases}
  #     before deploying a flow version to the environment. Default false.
  class TestCasesConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for webhooks.
  # @!attribute [rw] webhook_overrides
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Webhook>]
  #     The list of webhooks to override for the agent environment. The webhook
  #     must exist in the agent. You can override fields in
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#generic_web_service `generic_web_service`}
  #     and
  #     {::Google::Cloud::Dialogflow::CX::V3::Webhook#service_directory `service_directory`}.
  class WebhookConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end