google-cloud-dialogflow-cx-v3 0.10.1 → 0.11.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +8 -6
- data/lib/google/cloud/dialogflow/cx/v3/agents.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/changelogs.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb +4 -2
- data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +11 -7
- data/lib/google/cloud/dialogflow/cx/v3/deployments.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +5 -3
- data/lib/google/cloud/dialogflow/cx/v3/entity_types.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/environment_services_pb.rb +26 -13
- data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +40 -23
- data/lib/google/cloud/dialogflow/cx/v3/environments.rb +3 -2
- data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb +15 -9
- data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +28 -18
- data/lib/google/cloud/dialogflow/cx/v3/experiments.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb +4 -2
- data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +8 -6
- data/lib/google/cloud/dialogflow/cx/v3/flows.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/intents.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/pages.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +14 -9
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_services_pb.rb +7 -4
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_services_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +2 -1
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types.rb +3 -2
- data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +10 -5
- data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +10 -5
- data/lib/google/cloud/dialogflow/cx/v3/sessions.rb +4 -3
- data/lib/google/cloud/dialogflow/cx/v3/test_case_services_pb.rb +16 -8
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +27 -18
- data/lib/google/cloud/dialogflow/cx/v3/test_cases.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_services_pb.rb +11 -5
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +21 -11
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups.rb +3 -2
- data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +6 -3
- data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +22 -18
- data/lib/google/cloud/dialogflow/cx/v3/versions.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +4 -3
- data/lib/google/cloud/dialogflow/cx/v3/webhooks.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3.rb +2 -2
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +55 -31
- data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +16 -12
- data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +6 -3
- data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +13 -8
- data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +24 -12
- data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +65 -41
- data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +31 -19
- data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +38 -22
- data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +10 -5
- data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +27 -15
- data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +62 -37
- data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +32 -21
- data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +35 -28
- data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +109 -68
- data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +22 -15
- data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +82 -55
- data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +32 -20
- data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +36 -26
- data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +106 -66
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +7 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9be94d2f7992aed5963b1d8576baccfad2ab7ae85927f02c496f2221918b913c
|
4
|
+
data.tar.gz: 54ee32b0cef6844db92ada238cea3a824312ce8e631b3b950867100029fc35dc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8b9a09c637da89a505ef0ec3d1a74bd27222336b94b3a79223d494e244af9a99894ba44c1246d36354084ab389e9c42aff161a9ad3a72e57c48d65c9223b4b1b
|
7
|
+
data.tar.gz: e91551a041bdad4dbeb490b51d03f91f89a20f350fa6e3a125b011bca09730fffb455d8425f606ecc794ed7301b53f1b54b16458cb17dfa3fbf240f7a437b2c3
|
data/README.md
CHANGED
@@ -46,7 +46,7 @@ for general usage information.
|
|
46
46
|
## Enabling Logging
|
47
47
|
|
48
48
|
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
49
|
-
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/
|
49
|
+
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
|
50
50
|
or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
|
51
51
|
that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
52
52
|
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
@@ -60,7 +60,8 @@ module Google
|
|
60
60
|
#
|
61
61
|
# - `metadata`: An empty [Struct
|
62
62
|
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
|
63
|
-
# - `response`:
|
63
|
+
# - `response`:
|
64
|
+
# [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
|
64
65
|
rpc :ExportAgent, ::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest, ::Google::Longrunning::Operation
|
65
66
|
# Restores the specified agent from a binary file.
|
66
67
|
#
|
@@ -640,7 +640,8 @@ module Google
|
|
640
640
|
#
|
641
641
|
# - `metadata`: An empty [Struct
|
642
642
|
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
|
643
|
-
# - `response`:
|
643
|
+
# - `response`:
|
644
|
+
# {::Google::Cloud::Dialogflow::CX::V3::ExportAgentResponse ExportAgentResponse}
|
644
645
|
#
|
645
646
|
# @overload export_agent(request, options = nil)
|
646
647
|
# Pass arguments to `export_agent` via a request object, either of type
|
@@ -661,10 +662,10 @@ module Google
|
|
661
662
|
# Required. The name of the agent to export.
|
662
663
|
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
|
663
664
|
# @param agent_uri [::String]
|
664
|
-
# Optional. The [Google Cloud
|
665
|
-
#
|
666
|
-
# `gs://<bucket-name>/<object-name>`.
|
667
|
-
#
|
665
|
+
# Optional. The [Google Cloud
|
666
|
+
# Storage](https://cloud.google.com/storage/docs/) URI to export the agent
|
667
|
+
# to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If
|
668
|
+
# left unspecified, the serialized agent is returned inline.
|
668
669
|
#
|
669
670
|
# Dialogflow performs a write operation for the Cloud Storage object
|
670
671
|
# on the caller's behalf, so your request authentication must
|
@@ -672,7 +673,8 @@ module Google
|
|
672
673
|
# [Dialogflow access
|
673
674
|
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
|
674
675
|
# @param data_format [::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest::DataFormat]
|
675
|
-
# Optional. The data format of the exported agent. If not specified, `BLOB`
|
676
|
+
# Optional. The data format of the exported agent. If not specified, `BLOB`
|
677
|
+
# is assumed.
|
676
678
|
# @param environment [::String]
|
677
679
|
# Optional. Environment name. If not set, draft environment is assumed.
|
678
680
|
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
@@ -35,7 +35,7 @@ module Google
|
|
35
35
|
##
|
36
36
|
# Service for managing {::Google::Cloud::Dialogflow::CX::V3::Agent Agents}.
|
37
37
|
#
|
38
|
-
#
|
38
|
+
# @example Load this service and instantiate a gRPC client
|
39
39
|
#
|
40
40
|
# require "google/cloud/dialogflow/cx/v3/agents"
|
41
41
|
# client = ::Google::Cloud::Dialogflow::CX::V3::Agents::Client.new
|
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
##
|
35
35
|
# Service for managing {::Google::Cloud::Dialogflow::CX::V3::Changelog Changelogs}.
|
36
36
|
#
|
37
|
-
#
|
37
|
+
# @example Load this service and instantiate a gRPC client
|
38
38
|
#
|
39
39
|
# require "google/cloud/dialogflow/cx/v3/changelogs"
|
40
40
|
# client = ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Client.new
|
@@ -34,9 +34,11 @@ module Google
|
|
34
34
|
self.unmarshal_class_method = :decode
|
35
35
|
self.service_name = 'google.cloud.dialogflow.cx.v3.Deployments'
|
36
36
|
|
37
|
-
# Returns the list of all deployments in the specified
|
37
|
+
# Returns the list of all deployments in the specified
|
38
|
+
# [Environment][google.cloud.dialogflow.cx.v3.Environment].
|
38
39
|
rpc :ListDeployments, ::Google::Cloud::Dialogflow::CX::V3::ListDeploymentsRequest, ::Google::Cloud::Dialogflow::CX::V3::ListDeploymentsResponse
|
39
|
-
# Retrieves the specified
|
40
|
+
# Retrieves the specified
|
41
|
+
# [Deployment][google.cloud.dialogflow.cx.v3.Deployment].
|
40
42
|
rpc :GetDeployment, ::Google::Cloud::Dialogflow::CX::V3::GetDeploymentRequest, ::Google::Cloud::Dialogflow::CX::V3::Deployment
|
41
43
|
end
|
42
44
|
|
@@ -165,7 +165,8 @@ module Google
|
|
165
165
|
# Service calls
|
166
166
|
|
167
167
|
##
|
168
|
-
# Returns the list of all deployments in the specified
|
168
|
+
# Returns the list of all deployments in the specified
|
169
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
|
169
170
|
#
|
170
171
|
# @overload list_deployments(request, options = nil)
|
171
172
|
# Pass arguments to `list_deployments` via a request object, either of type
|
@@ -183,9 +184,10 @@ module Google
|
|
183
184
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
184
185
|
#
|
185
186
|
# @param parent [::String]
|
186
|
-
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to
|
187
|
-
# Format: `projects/<Project
|
188
|
-
# ID>/environments/<Environment
|
187
|
+
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to
|
188
|
+
# list all environments for. Format: `projects/<Project
|
189
|
+
# ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment
|
190
|
+
# ID>`.
|
189
191
|
# @param page_size [::Integer]
|
190
192
|
# The maximum number of items to return in a single page. By default 20 and
|
191
193
|
# at most 100.
|
@@ -264,7 +266,8 @@ module Google
|
|
264
266
|
end
|
265
267
|
|
266
268
|
##
|
267
|
-
# Retrieves the specified
|
269
|
+
# Retrieves the specified
|
270
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployment}.
|
268
271
|
#
|
269
272
|
# @overload get_deployment(request, options = nil)
|
270
273
|
# Pass arguments to `get_deployment` via a request object, either of type
|
@@ -282,8 +285,9 @@ module Google
|
|
282
285
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
283
286
|
#
|
284
287
|
# @param name [::String]
|
285
|
-
# Required. The name of the
|
286
|
-
# Format:
|
288
|
+
# Required. The name of the
|
289
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployment}. Format:
|
290
|
+
# `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
287
291
|
# ID>/environments/<Environment ID>/deployments/<Deployment ID>`.
|
288
292
|
#
|
289
293
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
##
|
35
35
|
# Service for managing {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployments}.
|
36
36
|
#
|
37
|
-
#
|
37
|
+
# @example Load this service and instantiate a gRPC client
|
38
38
|
#
|
39
39
|
# require "google/cloud/dialogflow/cx/v3/deployments"
|
40
40
|
# client = ::Google::Cloud::Dialogflow::CX::V3::Deployments::Client.new
|
@@ -616,9 +616,11 @@ module Google
|
|
616
616
|
# indicating the referencing resources.
|
617
617
|
# * If `force` is set to true, Dialogflow will remove the entity type, as
|
618
618
|
# well as any references to the entity type (i.e. Page
|
619
|
-
# {::Google::Cloud::Dialogflow::CX::V3::Form::Parameter parameter} of the entity
|
620
|
-
#
|
621
|
-
#
|
619
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Form::Parameter parameter} of the entity
|
620
|
+
# type will be changed to
|
621
|
+
# '@sys.any' and intent
|
622
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter parameter} of the
|
623
|
+
# entity type will be removed).
|
622
624
|
#
|
623
625
|
# @yield [response, operation] Access the result along with the RPC operation
|
624
626
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
##
|
35
35
|
# Service for managing {::Google::Cloud::Dialogflow::CX::V3::EntityType EntityTypes}.
|
36
36
|
#
|
37
|
-
#
|
37
|
+
# @example Load this service and instantiate a gRPC client
|
38
38
|
#
|
39
39
|
# require "google/cloud/dialogflow/cx/v3/entity_types"
|
40
40
|
# client = ::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client.new
|
@@ -25,7 +25,8 @@ module Google
|
|
25
25
|
module CX
|
26
26
|
module V3
|
27
27
|
module Environments
|
28
|
-
# Service for managing
|
28
|
+
# Service for managing
|
29
|
+
# [Environments][google.cloud.dialogflow.cx.v3.Environment].
|
29
30
|
class Service
|
30
31
|
|
31
32
|
include ::GRPC::GenericService
|
@@ -34,11 +35,14 @@ module Google
|
|
34
35
|
self.unmarshal_class_method = :decode
|
35
36
|
self.service_name = 'google.cloud.dialogflow.cx.v3.Environments'
|
36
37
|
|
37
|
-
# Returns the list of all environments in the specified
|
38
|
+
# Returns the list of all environments in the specified
|
39
|
+
# [Agent][google.cloud.dialogflow.cx.v3.Agent].
|
38
40
|
rpc :ListEnvironments, ::Google::Cloud::Dialogflow::CX::V3::ListEnvironmentsRequest, ::Google::Cloud::Dialogflow::CX::V3::ListEnvironmentsResponse
|
39
|
-
# Retrieves the specified
|
41
|
+
# Retrieves the specified
|
42
|
+
# [Environment][google.cloud.dialogflow.cx.v3.Environment].
|
40
43
|
rpc :GetEnvironment, ::Google::Cloud::Dialogflow::CX::V3::GetEnvironmentRequest, ::Google::Cloud::Dialogflow::CX::V3::Environment
|
41
|
-
# Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the
|
44
|
+
# Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the
|
45
|
+
# specified [Agent][google.cloud.dialogflow.cx.v3.Agent].
|
42
46
|
#
|
43
47
|
# This method is a [long-running
|
44
48
|
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
|
@@ -48,7 +52,8 @@ module Google
|
|
48
52
|
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
|
49
53
|
# - `response`: [Environment][google.cloud.dialogflow.cx.v3.Environment]
|
50
54
|
rpc :CreateEnvironment, ::Google::Cloud::Dialogflow::CX::V3::CreateEnvironmentRequest, ::Google::Longrunning::Operation
|
51
|
-
# Updates the specified
|
55
|
+
# Updates the specified
|
56
|
+
# [Environment][google.cloud.dialogflow.cx.v3.Environment].
|
52
57
|
#
|
53
58
|
# This method is a [long-running
|
54
59
|
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
|
@@ -58,29 +63,37 @@ module Google
|
|
58
63
|
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
|
59
64
|
# - `response`: [Environment][google.cloud.dialogflow.cx.v3.Environment]
|
60
65
|
rpc :UpdateEnvironment, ::Google::Cloud::Dialogflow::CX::V3::UpdateEnvironmentRequest, ::Google::Longrunning::Operation
|
61
|
-
# Deletes the specified
|
66
|
+
# Deletes the specified
|
67
|
+
# [Environment][google.cloud.dialogflow.cx.v3.Environment].
|
62
68
|
rpc :DeleteEnvironment, ::Google::Cloud::Dialogflow::CX::V3::DeleteEnvironmentRequest, ::Google::Protobuf::Empty
|
63
|
-
# Looks up the history of the specified
|
69
|
+
# Looks up the history of the specified
|
70
|
+
# [Environment][google.cloud.dialogflow.cx.v3.Environment].
|
64
71
|
rpc :LookupEnvironmentHistory, ::Google::Cloud::Dialogflow::CX::V3::LookupEnvironmentHistoryRequest, ::Google::Cloud::Dialogflow::CX::V3::LookupEnvironmentHistoryResponse
|
65
|
-
# Kicks off a continuous test under the specified
|
72
|
+
# Kicks off a continuous test under the specified
|
73
|
+
# [Environment][google.cloud.dialogflow.cx.v3.Environment].
|
66
74
|
#
|
67
75
|
# This method is a [long-running
|
68
76
|
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
|
69
77
|
# The returned `Operation` type has the following method-specific fields:
|
70
78
|
#
|
71
|
-
# - `metadata`:
|
72
|
-
#
|
79
|
+
# - `metadata`:
|
80
|
+
# [RunContinuousTestMetadata][google.cloud.dialogflow.cx.v3.RunContinuousTestMetadata]
|
81
|
+
# - `response`:
|
82
|
+
# [RunContinuousTestResponse][google.cloud.dialogflow.cx.v3.RunContinuousTestResponse]
|
73
83
|
rpc :RunContinuousTest, ::Google::Cloud::Dialogflow::CX::V3::RunContinuousTestRequest, ::Google::Longrunning::Operation
|
74
84
|
# Fetches a list of continuous test results for a given environment.
|
75
85
|
rpc :ListContinuousTestResults, ::Google::Cloud::Dialogflow::CX::V3::ListContinuousTestResultsRequest, ::Google::Cloud::Dialogflow::CX::V3::ListContinuousTestResultsResponse
|
76
|
-
# Deploys a flow to the specified
|
86
|
+
# Deploys a flow to the specified
|
87
|
+
# [Environment][google.cloud.dialogflow.cx.v3.Environment].
|
77
88
|
#
|
78
89
|
# This method is a [long-running
|
79
90
|
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
|
80
91
|
# The returned `Operation` type has the following method-specific fields:
|
81
92
|
#
|
82
|
-
# - `metadata`:
|
83
|
-
#
|
93
|
+
# - `metadata`:
|
94
|
+
# [DeployFlowMetadata][google.cloud.dialogflow.cx.v3.DeployFlowMetadata]
|
95
|
+
# - `response`:
|
96
|
+
# [DeployFlowResponse][google.cloud.dialogflow.cx.v3.DeployFlowResponse]
|
84
97
|
rpc :DeployFlow, ::Google::Cloud::Dialogflow::CX::V3::DeployFlowRequest, ::Google::Longrunning::Operation
|
85
98
|
end
|
86
99
|
|
@@ -29,7 +29,8 @@ module Google
|
|
29
29
|
##
|
30
30
|
# Client for the Environments service.
|
31
31
|
#
|
32
|
-
# Service for managing
|
32
|
+
# Service for managing
|
33
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environments}.
|
33
34
|
#
|
34
35
|
class Client
|
35
36
|
include Paths
|
@@ -178,7 +179,8 @@ module Google
|
|
178
179
|
# Service calls
|
179
180
|
|
180
181
|
##
|
181
|
-
# Returns the list of all environments in the specified
|
182
|
+
# Returns the list of all environments in the specified
|
183
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Agent Agent}.
|
182
184
|
#
|
183
185
|
# @overload list_environments(request, options = nil)
|
184
186
|
# Pass arguments to `list_environments` via a request object, either of type
|
@@ -196,8 +198,9 @@ module Google
|
|
196
198
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
197
199
|
#
|
198
200
|
# @param parent [::String]
|
199
|
-
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to list all
|
200
|
-
# Format: `projects/<Project ID>/locations/<Location
|
201
|
+
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to list all
|
202
|
+
# environments for. Format: `projects/<Project ID>/locations/<Location
|
203
|
+
# ID>/agents/<Agent ID>`.
|
201
204
|
# @param page_size [::Integer]
|
202
205
|
# The maximum number of items to return in a single page. By default 20 and
|
203
206
|
# at most 100.
|
@@ -276,7 +279,8 @@ module Google
|
|
276
279
|
end
|
277
280
|
|
278
281
|
##
|
279
|
-
# Retrieves the specified
|
282
|
+
# Retrieves the specified
|
283
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
|
280
284
|
#
|
281
285
|
# @overload get_environment(request, options = nil)
|
282
286
|
# Pass arguments to `get_environment` via a request object, either of type
|
@@ -294,8 +298,9 @@ module Google
|
|
294
298
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
295
299
|
#
|
296
300
|
# @param name [::String]
|
297
|
-
# Required. The name of the
|
298
|
-
# Format:
|
301
|
+
# Required. The name of the
|
302
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. Format:
|
303
|
+
# `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
299
304
|
# ID>/environments/<Environment ID>`.
|
300
305
|
#
|
301
306
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -363,7 +368,8 @@ module Google
|
|
363
368
|
end
|
364
369
|
|
365
370
|
##
|
366
|
-
# Creates an {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} in the
|
371
|
+
# Creates an {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} in the
|
372
|
+
# specified {::Google::Cloud::Dialogflow::CX::V3::Agent Agent}.
|
367
373
|
#
|
368
374
|
# This method is a [long-running
|
369
375
|
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
|
@@ -389,8 +395,9 @@ module Google
|
|
389
395
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
390
396
|
#
|
391
397
|
# @param parent [::String]
|
392
|
-
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an
|
393
|
-
#
|
398
|
+
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an
|
399
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for. Format:
|
400
|
+
# `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
|
394
401
|
# @param environment [::Google::Cloud::Dialogflow::CX::V3::Environment, ::Hash]
|
395
402
|
# Required. The environment to create.
|
396
403
|
#
|
@@ -467,7 +474,8 @@ module Google
|
|
467
474
|
end
|
468
475
|
|
469
476
|
##
|
470
|
-
# Updates the specified
|
477
|
+
# Updates the specified
|
478
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
|
471
479
|
#
|
472
480
|
# This method is a [long-running
|
473
481
|
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
|
@@ -570,7 +578,8 @@ module Google
|
|
570
578
|
end
|
571
579
|
|
572
580
|
##
|
573
|
-
# Deletes the specified
|
581
|
+
# Deletes the specified
|
582
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
|
574
583
|
#
|
575
584
|
# @overload delete_environment(request, options = nil)
|
576
585
|
# Pass arguments to `delete_environment` via a request object, either of type
|
@@ -588,8 +597,9 @@ module Google
|
|
588
597
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
589
598
|
#
|
590
599
|
# @param name [::String]
|
591
|
-
# Required. The name of the
|
592
|
-
#
|
600
|
+
# Required. The name of the
|
601
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete. Format:
|
602
|
+
# `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
593
603
|
# ID>/environments/<Environment ID>`.
|
594
604
|
#
|
595
605
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -657,7 +667,8 @@ module Google
|
|
657
667
|
end
|
658
668
|
|
659
669
|
##
|
660
|
-
# Looks up the history of the specified
|
670
|
+
# Looks up the history of the specified
|
671
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
|
661
672
|
#
|
662
673
|
# @overload lookup_environment_history(request, options = nil)
|
663
674
|
# Pass arguments to `lookup_environment_history` via a request object, either of type
|
@@ -756,14 +767,17 @@ module Google
|
|
756
767
|
end
|
757
768
|
|
758
769
|
##
|
759
|
-
# Kicks off a continuous test under the specified
|
770
|
+
# Kicks off a continuous test under the specified
|
771
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
|
760
772
|
#
|
761
773
|
# This method is a [long-running
|
762
774
|
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
|
763
775
|
# The returned `Operation` type has the following method-specific fields:
|
764
776
|
#
|
765
|
-
# - `metadata`:
|
766
|
-
#
|
777
|
+
# - `metadata`:
|
778
|
+
# {::Google::Cloud::Dialogflow::CX::V3::RunContinuousTestMetadata RunContinuousTestMetadata}
|
779
|
+
# - `response`:
|
780
|
+
# {::Google::Cloud::Dialogflow::CX::V3::RunContinuousTestResponse RunContinuousTestResponse}
|
767
781
|
#
|
768
782
|
# @overload run_continuous_test(request, options = nil)
|
769
783
|
# Pass arguments to `run_continuous_test` via a request object, either of type
|
@@ -781,8 +795,8 @@ module Google
|
|
781
795
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
782
796
|
#
|
783
797
|
# @param environment [::String]
|
784
|
-
# Required. Format: `projects/<Project ID>/locations/<Location
|
785
|
-
# ID>/environments/<Environment ID>`.
|
798
|
+
# Required. Format: `projects/<Project ID>/locations/<Location
|
799
|
+
# ID>/agents/<Agent ID>/environments/<Environment ID>`.
|
786
800
|
#
|
787
801
|
# @yield [response, operation] Access the result along with the RPC operation
|
788
802
|
# @yieldparam response [::Gapic::Operation]
|
@@ -956,14 +970,17 @@ module Google
|
|
956
970
|
end
|
957
971
|
|
958
972
|
##
|
959
|
-
# Deploys a flow to the specified
|
973
|
+
# Deploys a flow to the specified
|
974
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
|
960
975
|
#
|
961
976
|
# This method is a [long-running
|
962
977
|
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
|
963
978
|
# The returned `Operation` type has the following method-specific fields:
|
964
979
|
#
|
965
|
-
# - `metadata`:
|
966
|
-
#
|
980
|
+
# - `metadata`:
|
981
|
+
# {::Google::Cloud::Dialogflow::CX::V3::DeployFlowMetadata DeployFlowMetadata}
|
982
|
+
# - `response`:
|
983
|
+
# {::Google::Cloud::Dialogflow::CX::V3::DeployFlowResponse DeployFlowResponse}
|
967
984
|
#
|
968
985
|
# @overload deploy_flow(request, options = nil)
|
969
986
|
# Pass arguments to `deploy_flow` via a request object, either of type
|
@@ -33,9 +33,10 @@ module Google
|
|
33
33
|
module CX
|
34
34
|
module V3
|
35
35
|
##
|
36
|
-
# Service for managing
|
36
|
+
# Service for managing
|
37
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environments}.
|
37
38
|
#
|
38
|
-
#
|
39
|
+
# @example Load this service and instantiate a gRPC client
|
39
40
|
#
|
40
41
|
# require "google/cloud/dialogflow/cx/v3/environments"
|
41
42
|
# client = ::Google::Cloud::Dialogflow::CX::V3::Environments::Client.new
|
@@ -34,21 +34,27 @@ module Google
|
|
34
34
|
self.unmarshal_class_method = :decode
|
35
35
|
self.service_name = 'google.cloud.dialogflow.cx.v3.Experiments'
|
36
36
|
|
37
|
-
# Returns the list of all experiments in the specified
|
37
|
+
# Returns the list of all experiments in the specified
|
38
|
+
# [Environment][google.cloud.dialogflow.cx.v3.Environment].
|
38
39
|
rpc :ListExperiments, ::Google::Cloud::Dialogflow::CX::V3::ListExperimentsRequest, ::Google::Cloud::Dialogflow::CX::V3::ListExperimentsResponse
|
39
|
-
# Retrieves the specified
|
40
|
+
# Retrieves the specified
|
41
|
+
# [Experiment][google.cloud.dialogflow.cx.v3.Experiment].
|
40
42
|
rpc :GetExperiment, ::Google::Cloud::Dialogflow::CX::V3::GetExperimentRequest, ::Google::Cloud::Dialogflow::CX::V3::Experiment
|
41
|
-
# Creates an [Experiment][google.cloud.dialogflow.cx.v3.Experiment] in the
|
43
|
+
# Creates an [Experiment][google.cloud.dialogflow.cx.v3.Experiment] in the
|
44
|
+
# specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
|
42
45
|
rpc :CreateExperiment, ::Google::Cloud::Dialogflow::CX::V3::CreateExperimentRequest, ::Google::Cloud::Dialogflow::CX::V3::Experiment
|
43
|
-
# Updates the specified
|
46
|
+
# Updates the specified
|
47
|
+
# [Experiment][google.cloud.dialogflow.cx.v3.Experiment].
|
44
48
|
rpc :UpdateExperiment, ::Google::Cloud::Dialogflow::CX::V3::UpdateExperimentRequest, ::Google::Cloud::Dialogflow::CX::V3::Experiment
|
45
|
-
# Deletes the specified
|
49
|
+
# Deletes the specified
|
50
|
+
# [Experiment][google.cloud.dialogflow.cx.v3.Experiment].
|
46
51
|
rpc :DeleteExperiment, ::Google::Cloud::Dialogflow::CX::V3::DeleteExperimentRequest, ::Google::Protobuf::Empty
|
47
|
-
# Starts the specified
|
48
|
-
#
|
52
|
+
# Starts the specified
|
53
|
+
# [Experiment][google.cloud.dialogflow.cx.v3.Experiment]. This rpc only
|
54
|
+
# changes the state of experiment from PENDING to RUNNING.
|
49
55
|
rpc :StartExperiment, ::Google::Cloud::Dialogflow::CX::V3::StartExperimentRequest, ::Google::Cloud::Dialogflow::CX::V3::Experiment
|
50
|
-
# Stops the specified [Experiment][google.cloud.dialogflow.cx.v3.Experiment].
|
51
|
-
# experiment from RUNNING to DONE.
|
56
|
+
# Stops the specified [Experiment][google.cloud.dialogflow.cx.v3.Experiment].
|
57
|
+
# This rpc only changes the state of experiment from RUNNING to DONE.
|
52
58
|
rpc :StopExperiment, ::Google::Cloud::Dialogflow::CX::V3::StopExperimentRequest, ::Google::Cloud::Dialogflow::CX::V3::Experiment
|
53
59
|
end
|
54
60
|
|
@@ -165,7 +165,8 @@ module Google
|
|
165
165
|
# Service calls
|
166
166
|
|
167
167
|
##
|
168
|
-
# Returns the list of all experiments in the specified
|
168
|
+
# Returns the list of all experiments in the specified
|
169
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
|
169
170
|
#
|
170
171
|
# @overload list_experiments(request, options = nil)
|
171
172
|
# Pass arguments to `list_experiments` via a request object, either of type
|
@@ -183,9 +184,10 @@ module Google
|
|
183
184
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
184
185
|
#
|
185
186
|
# @param parent [::String]
|
186
|
-
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to
|
187
|
-
# Format: `projects/<Project
|
188
|
-
# ID>/environments/<Environment
|
187
|
+
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to
|
188
|
+
# list all environments for. Format: `projects/<Project
|
189
|
+
# ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment
|
190
|
+
# ID>`.
|
189
191
|
# @param page_size [::Integer]
|
190
192
|
# The maximum number of items to return in a single page. By default 20 and
|
191
193
|
# at most 100.
|
@@ -264,7 +266,8 @@ module Google
|
|
264
266
|
end
|
265
267
|
|
266
268
|
##
|
267
|
-
# Retrieves the specified
|
269
|
+
# Retrieves the specified
|
270
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}.
|
268
271
|
#
|
269
272
|
# @overload get_experiment(request, options = nil)
|
270
273
|
# Pass arguments to `get_experiment` via a request object, either of type
|
@@ -282,8 +285,9 @@ module Google
|
|
282
285
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
283
286
|
#
|
284
287
|
# @param name [::String]
|
285
|
-
# Required. The name of the
|
286
|
-
# Format:
|
288
|
+
# Required. The name of the
|
289
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}. Format:
|
290
|
+
# `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
287
291
|
# ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
|
288
292
|
#
|
289
293
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -351,7 +355,8 @@ module Google
|
|
351
355
|
end
|
352
356
|
|
353
357
|
##
|
354
|
-
# Creates an {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment} in the
|
358
|
+
# Creates an {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment} in the
|
359
|
+
# specified {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
|
355
360
|
#
|
356
361
|
# @overload create_experiment(request, options = nil)
|
357
362
|
# Pass arguments to `create_experiment` via a request object, either of type
|
@@ -369,8 +374,9 @@ module Google
|
|
369
374
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
370
375
|
#
|
371
376
|
# @param parent [::String]
|
372
|
-
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an
|
373
|
-
#
|
377
|
+
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an
|
378
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for. Format:
|
379
|
+
# `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
374
380
|
# ID>/environments/<Environment ID>`.
|
375
381
|
# @param experiment [::Google::Cloud::Dialogflow::CX::V3::Experiment, ::Hash]
|
376
382
|
# Required. The experiment to create.
|
@@ -440,7 +446,8 @@ module Google
|
|
440
446
|
end
|
441
447
|
|
442
448
|
##
|
443
|
-
# Updates the specified
|
449
|
+
# Updates the specified
|
450
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}.
|
444
451
|
#
|
445
452
|
# @overload update_experiment(request, options = nil)
|
446
453
|
# Pass arguments to `update_experiment` via a request object, either of type
|
@@ -527,7 +534,8 @@ module Google
|
|
527
534
|
end
|
528
535
|
|
529
536
|
##
|
530
|
-
# Deletes the specified
|
537
|
+
# Deletes the specified
|
538
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}.
|
531
539
|
#
|
532
540
|
# @overload delete_experiment(request, options = nil)
|
533
541
|
# Pass arguments to `delete_experiment` via a request object, either of type
|
@@ -545,8 +553,9 @@ module Google
|
|
545
553
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
546
554
|
#
|
547
555
|
# @param name [::String]
|
548
|
-
# Required. The name of the
|
549
|
-
#
|
556
|
+
# Required. The name of the
|
557
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete. Format:
|
558
|
+
# `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
550
559
|
# ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
|
551
560
|
#
|
552
561
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -614,8 +623,9 @@ module Google
|
|
614
623
|
end
|
615
624
|
|
616
625
|
##
|
617
|
-
# Starts the specified
|
618
|
-
#
|
626
|
+
# Starts the specified
|
627
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}. This rpc only
|
628
|
+
# changes the state of experiment from PENDING to RUNNING.
|
619
629
|
#
|
620
630
|
# @overload start_experiment(request, options = nil)
|
621
631
|
# Pass arguments to `start_experiment` via a request object, either of type
|
@@ -702,8 +712,8 @@ module Google
|
|
702
712
|
end
|
703
713
|
|
704
714
|
##
|
705
|
-
# Stops the specified {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}.
|
706
|
-
# experiment from RUNNING to DONE.
|
715
|
+
# Stops the specified {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}.
|
716
|
+
# This rpc only changes the state of experiment from RUNNING to DONE.
|
707
717
|
#
|
708
718
|
# @overload stop_experiment(request, options = nil)
|
709
719
|
# Pass arguments to `stop_experiment` via a request object, either of type
|
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
##
|
35
35
|
# Service for managing {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiments}.
|
36
36
|
#
|
37
|
-
#
|
37
|
+
# @example Load this service and instantiate a gRPC client
|
38
38
|
#
|
39
39
|
# require "google/cloud/dialogflow/cx/v3/experiments"
|
40
40
|
# client = ::Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new
|