google-apis-dialogflow_v3beta1 0.20.0 → 0.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -50,6 +50,79 @@ module Google
50
50
  @batch_path = 'batch'
51
51
  end
52
52
 
53
+ # Gets information about a location.
54
+ # @param [String] name
55
+ # Resource name for the location.
56
+ # @param [String] fields
57
+ # Selector specifying which fields to include in a partial response.
58
+ # @param [String] quota_user
59
+ # Available to use for quota purposes for server-side applications. Can be any
60
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
61
+ # @param [Google::Apis::RequestOptions] options
62
+ # Request-specific options
63
+ #
64
+ # @yield [result, err] Result & error if block supplied
65
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudLocationLocation] parsed result object
66
+ # @yieldparam err [StandardError] error object if request failed
67
+ #
68
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudLocationLocation]
69
+ #
70
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
71
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
72
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
73
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
74
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
75
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudLocationLocation::Representation
76
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudLocationLocation
77
+ command.params['name'] = name unless name.nil?
78
+ command.query['fields'] = fields unless fields.nil?
79
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
80
+ execute_or_queue_command(command, &block)
81
+ end
82
+
83
+ # Lists information about the supported locations for this service.
84
+ # @param [String] name
85
+ # The resource that owns the locations collection, if applicable.
86
+ # @param [String] filter
87
+ # A filter to narrow down results to a preferred subset. The filtering language
88
+ # accepts strings like "displayName=tokyo", and is documented in more detail in [
89
+ # AIP-160](https://google.aip.dev/160).
90
+ # @param [Fixnum] page_size
91
+ # The maximum number of results to return. If not set, the service selects a
92
+ # default.
93
+ # @param [String] page_token
94
+ # A page token received from the `next_page_token` field in the response. Send
95
+ # that page token to receive the subsequent page.
96
+ # @param [String] fields
97
+ # Selector specifying which fields to include in a partial response.
98
+ # @param [String] quota_user
99
+ # Available to use for quota purposes for server-side applications. Can be any
100
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
101
+ # @param [Google::Apis::RequestOptions] options
102
+ # Request-specific options
103
+ #
104
+ # @yield [result, err] Result & error if block supplied
105
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudLocationListLocationsResponse] parsed result object
106
+ # @yieldparam err [StandardError] error object if request failed
107
+ #
108
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudLocationListLocationsResponse]
109
+ #
110
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
111
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
112
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
113
+ def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
114
+ command = make_simple_command(:get, 'v3beta1/{+name}/locations', options)
115
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudLocationListLocationsResponse::Representation
116
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudLocationListLocationsResponse
117
+ command.params['name'] = name unless name.nil?
118
+ command.query['filter'] = filter unless filter.nil?
119
+ command.query['pageSize'] = page_size unless page_size.nil?
120
+ command.query['pageToken'] = page_token unless page_token.nil?
121
+ command.query['fields'] = fields unless fields.nil?
122
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
123
+ execute_or_queue_command(command, &block)
124
+ end
125
+
53
126
  # Creates an agent in the specified location. Note: You should always train a
54
127
  # flow prior to sending it queries. See the [training documentation](https://
55
128
  # cloud.google.com/dialogflow/cx/docs/concept/training).
@@ -116,7 +189,12 @@ module Google
116
189
  execute_or_queue_command(command, &block)
117
190
  end
118
191
 
119
- # Exports the specified agent to a binary file.
192
+ # Exports the specified agent to a binary file. This method is a [long-running
193
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
194
+ # operation). The returned `Operation` type has the following method-specific
195
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
196
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
197
+ # ExportAgentResponse
120
198
  # @param [String] name
121
199
  # Required. The name of the agent to export. Format: `projects//locations//
122
200
  # agents/`.
@@ -295,9 +373,15 @@ module Google
295
373
 
296
374
  # Restores the specified agent from a binary file. Replaces the current agent
297
375
  # with a new one. Note that all existing resources in agent (e.g. intents,
298
- # entity types, flows) will be removed. Note: You should always train a flow
299
- # prior to sending it queries. See the [training documentation](https://cloud.
300
- # google.com/dialogflow/cx/docs/concept/training).
376
+ # entity types, flows) will be removed. This method is a [long-running operation]
377
+ # (https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
378
+ # returned `Operation` type has the following method-specific fields: - `
379
+ # metadata`: An empty [Struct message](https://developers.google.com/protocol-
380
+ # buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message]
381
+ # (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
382
+ # empty) Note: You should always train a flow prior to sending it queries. See
383
+ # the [training documentation](https://cloud.google.com/dialogflow/cx/docs/
384
+ # concept/training).
301
385
  # @param [String] name
302
386
  # Required. The name of the agent to restore into. Format: `projects//locations//
303
387
  # agents/`.
@@ -366,6 +450,87 @@ module Google
366
450
  execute_or_queue_command(command, &block)
367
451
  end
368
452
 
453
+ # Retrieves the specified Changelog.
454
+ # @param [String] name
455
+ # Required. The name of the changelog to get. Format: `projects//locations//
456
+ # agents//changelogs/`.
457
+ # @param [String] fields
458
+ # Selector specifying which fields to include in a partial response.
459
+ # @param [String] quota_user
460
+ # Available to use for quota purposes for server-side applications. Can be any
461
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
462
+ # @param [Google::Apis::RequestOptions] options
463
+ # Request-specific options
464
+ #
465
+ # @yield [result, err] Result & error if block supplied
466
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Changelog] parsed result object
467
+ # @yieldparam err [StandardError] error object if request failed
468
+ #
469
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Changelog]
470
+ #
471
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
472
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
473
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
474
+ def get_project_location_agent_changelog(name, fields: nil, quota_user: nil, options: nil, &block)
475
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
476
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Changelog::Representation
477
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Changelog
478
+ command.params['name'] = name unless name.nil?
479
+ command.query['fields'] = fields unless fields.nil?
480
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
481
+ execute_or_queue_command(command, &block)
482
+ end
483
+
484
+ # Returns the list of Changelogs.
485
+ # @param [String] parent
486
+ # Required. The agent containing the changelogs. Format: `projects//locations//
487
+ # agents/`.
488
+ # @param [String] filter
489
+ # The filter string. Supports filter by user_email, resource, type and
490
+ # create_time. Some examples: 1. By user email: user_email = "someone@google.com"
491
+ # 2. By resource name: resource = "projects/123/locations/global/agents/456/
492
+ # flows/789" 3. By resource display name: display_name = "my agent" 4. By action:
493
+ # action = "Create" 5. By type: type = "flows" 6. By create time. Currently
494
+ # predicates on `create_time` and `create_time_epoch_seconds` are supported:
495
+ # create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15.
496
+ # 01Z 7. Combination of above filters: resource = "projects/123/locations/global/
497
+ # agents/456/flows/789" AND user_email = "someone@google.com" AND create_time <=
498
+ # 2017-01-15T01:30:15.01Z
499
+ # @param [Fixnum] page_size
500
+ # The maximum number of items to return in a single page. By default 100 and at
501
+ # most 1000.
502
+ # @param [String] page_token
503
+ # The next_page_token value returned from a previous list request.
504
+ # @param [String] fields
505
+ # Selector specifying which fields to include in a partial response.
506
+ # @param [String] quota_user
507
+ # Available to use for quota purposes for server-side applications. Can be any
508
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
509
+ # @param [Google::Apis::RequestOptions] options
510
+ # Request-specific options
511
+ #
512
+ # @yield [result, err] Result & error if block supplied
513
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListChangelogsResponse] parsed result object
514
+ # @yieldparam err [StandardError] error object if request failed
515
+ #
516
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListChangelogsResponse]
517
+ #
518
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
519
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
520
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
521
+ def list_project_location_agent_changelogs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
522
+ command = make_simple_command(:get, 'v3beta1/{+parent}/changelogs', options)
523
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListChangelogsResponse::Representation
524
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListChangelogsResponse
525
+ command.params['parent'] = parent unless parent.nil?
526
+ command.query['filter'] = filter unless filter.nil?
527
+ command.query['pageSize'] = page_size unless page_size.nil?
528
+ command.query['pageToken'] = page_token unless page_token.nil?
529
+ command.query['fields'] = fields unless fields.nil?
530
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
531
+ execute_or_queue_command(command, &block)
532
+ end
533
+
369
534
  # Creates an entity type in the specified agent.
370
535
  # @param [String] parent
371
536
  # Required. The agent to create a entity type for. Format: `projects//locations//
@@ -579,7 +744,12 @@ module Google
579
744
  execute_or_queue_command(command, &block)
580
745
  end
581
746
 
582
- # Creates an Environment in the specified Agent.
747
+ # Creates an Environment in the specified Agent. This method is a [long-running
748
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
749
+ # operation). The returned `Operation` type has the following method-specific
750
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
751
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
752
+ # Environment
583
753
  # @param [String] parent
584
754
  # Required. The Agent to create an Environment for. Format: `projects//locations/
585
755
  # /agents/`.
@@ -644,6 +814,43 @@ module Google
644
814
  execute_or_queue_command(command, &block)
645
815
  end
646
816
 
817
+ # Deploys a flow to the specified Environment. This method is a [long-running
818
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
819
+ # operation). The returned `Operation` type has the following method-specific
820
+ # fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse
821
+ # @param [String] environment
822
+ # Required. The environment to deploy the flow to. Format: `projects//locations//
823
+ # agents// environments/`.
824
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DeployFlowRequest] google_cloud_dialogflow_cx_v3beta1_deploy_flow_request_object
825
+ # @param [String] fields
826
+ # Selector specifying which fields to include in a partial response.
827
+ # @param [String] quota_user
828
+ # Available to use for quota purposes for server-side applications. Can be any
829
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
830
+ # @param [Google::Apis::RequestOptions] options
831
+ # Request-specific options
832
+ #
833
+ # @yield [result, err] Result & error if block supplied
834
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation] parsed result object
835
+ # @yieldparam err [StandardError] error object if request failed
836
+ #
837
+ # @return [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation]
838
+ #
839
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
840
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
841
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
842
+ def deploy_project_location_agent_environment_flow(environment, google_cloud_dialogflow_cx_v3beta1_deploy_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
843
+ command = make_simple_command(:post, 'v3beta1/{+environment}:deployFlow', options)
844
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DeployFlowRequest::Representation
845
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_deploy_flow_request_object
846
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
847
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
848
+ command.params['environment'] = environment unless environment.nil?
849
+ command.query['fields'] = fields unless fields.nil?
850
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
851
+ execute_or_queue_command(command, &block)
852
+ end
853
+
647
854
  # Retrieves the specified Environment.
648
855
  # @param [String] name
649
856
  # Required. The name of the Environment. Format: `projects//locations//agents//
@@ -751,7 +958,11 @@ module Google
751
958
  execute_or_queue_command(command, &block)
752
959
  end
753
960
 
754
- # Updates the specified Environment.
961
+ # Updates the specified Environment. This method is a [long-running operation](
962
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
963
+ # returned `Operation` type has the following method-specific fields: - `
964
+ # metadata`: An empty [Struct message](https://developers.google.com/protocol-
965
+ # buffers/docs/reference/google.protobuf#struct) - `response`: Environment
755
966
  # @param [String] name
756
967
  # The name of the environment. Format: `projects//locations//agents//
757
968
  # environments/`.
@@ -788,7 +999,11 @@ module Google
788
999
  execute_or_queue_command(command, &block)
789
1000
  end
790
1001
 
791
- # Kicks off a continuous test under the specified Environment.
1002
+ # Kicks off a continuous test under the specified Environment. This method is a [
1003
+ # long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
1004
+ # running-operation). The returned `Operation` type has the following method-
1005
+ # specific fields: - `metadata`: RunContinuousTestMetadata - `response`:
1006
+ # RunContinuousTestResponse
792
1007
  # @param [String] environment
793
1008
  # Required. Format: `projects//locations//agents//environments/`.
794
1009
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RunContinuousTestRequest] google_cloud_dialogflow_cx_v3beta1_run_continuous_test_request_object
@@ -859,6 +1074,75 @@ module Google
859
1074
  execute_or_queue_command(command, &block)
860
1075
  end
861
1076
 
1077
+ # Retrieves the specified Deployment.
1078
+ # @param [String] name
1079
+ # Required. The name of the Deployment. Format: `projects//locations//agents//
1080
+ # environments//deployments/`.
1081
+ # @param [String] fields
1082
+ # Selector specifying which fields to include in a partial response.
1083
+ # @param [String] quota_user
1084
+ # Available to use for quota purposes for server-side applications. Can be any
1085
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1086
+ # @param [Google::Apis::RequestOptions] options
1087
+ # Request-specific options
1088
+ #
1089
+ # @yield [result, err] Result & error if block supplied
1090
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Deployment] parsed result object
1091
+ # @yieldparam err [StandardError] error object if request failed
1092
+ #
1093
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Deployment]
1094
+ #
1095
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1096
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1097
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1098
+ def get_project_location_agent_environment_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
1099
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
1100
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Deployment::Representation
1101
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Deployment
1102
+ command.params['name'] = name unless name.nil?
1103
+ command.query['fields'] = fields unless fields.nil?
1104
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1105
+ execute_or_queue_command(command, &block)
1106
+ end
1107
+
1108
+ # Returns the list of all deployments in the specified Environment.
1109
+ # @param [String] parent
1110
+ # Required. The Environment to list all environments for. Format: `projects//
1111
+ # locations//agents//environments/`.
1112
+ # @param [Fixnum] page_size
1113
+ # The maximum number of items to return in a single page. By default 20 and at
1114
+ # most 100.
1115
+ # @param [String] page_token
1116
+ # The next_page_token value returned from a previous list request.
1117
+ # @param [String] fields
1118
+ # Selector specifying which fields to include in a partial response.
1119
+ # @param [String] quota_user
1120
+ # Available to use for quota purposes for server-side applications. Can be any
1121
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1122
+ # @param [Google::Apis::RequestOptions] options
1123
+ # Request-specific options
1124
+ #
1125
+ # @yield [result, err] Result & error if block supplied
1126
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListDeploymentsResponse] parsed result object
1127
+ # @yieldparam err [StandardError] error object if request failed
1128
+ #
1129
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListDeploymentsResponse]
1130
+ #
1131
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1132
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1133
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1134
+ def list_project_location_agent_environment_deployments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1135
+ command = make_simple_command(:get, 'v3beta1/{+parent}/deployments', options)
1136
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListDeploymentsResponse::Representation
1137
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListDeploymentsResponse
1138
+ command.params['parent'] = parent unless parent.nil?
1139
+ command.query['pageSize'] = page_size unless page_size.nil?
1140
+ command.query['pageToken'] = page_token unless page_token.nil?
1141
+ command.query['fields'] = fields unless fields.nil?
1142
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1143
+ execute_or_queue_command(command, &block)
1144
+ end
1145
+
862
1146
  # Creates an Experiment in the specified Environment.
863
1147
  # @param [String] parent
864
1148
  # Required. The Agent to create an Environment for. Format: `projects//locations/
@@ -1493,8 +1777,13 @@ module Google
1493
1777
  execute_or_queue_command(command, &block)
1494
1778
  end
1495
1779
 
1496
- # Exports the specified flow to a binary file. Note that resources (e.g. intents,
1497
- # entities, webhooks) that the flow references will also be exported.
1780
+ # Exports the specified flow to a binary file. This method is a [long-running
1781
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
1782
+ # operation). The returned `Operation` type has the following method-specific
1783
+ # fields: - `metadata`: An empty [Struct message](https://developers.google.com/
1784
+ # protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
1785
+ # ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that
1786
+ # the flow references will also be exported.
1498
1787
  # @param [String] name
1499
1788
  # Required. The name of the flow to export. Format: `projects//locations//agents/
1500
1789
  # /flows/`.
@@ -1604,9 +1893,14 @@ module Google
1604
1893
  execute_or_queue_command(command, &block)
1605
1894
  end
1606
1895
 
1607
- # Imports the specified flow to the specified agent from a binary file. Note:
1608
- # You should always train a flow prior to sending it queries. See the [training
1609
- # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
1896
+ # Imports the specified flow to the specified agent from a binary file. This
1897
+ # method is a [long-running operation](https://cloud.google.com/dialogflow/cx/
1898
+ # docs/how/long-running-operation). The returned `Operation` type has the
1899
+ # following method-specific fields: - `metadata`: An empty [Struct message](
1900
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
1901
+ # struct) - `response`: ImportFlowResponse Note: You should always train a flow
1902
+ # prior to sending it queries. See the [training documentation](https://cloud.
1903
+ # google.com/dialogflow/cx/docs/concept/training).
1610
1904
  # @param [String] parent
1611
1905
  # Required. The agent to import the flow into. Format: `projects//locations//
1612
1906
  # agents/`.
@@ -1704,8 +1998,8 @@ module Google
1704
1998
  # com/dialogflow/cx/docs/reference/language) are supported. Note: languages must
1705
1999
  # be enabled in the agent before they can be used.
1706
2000
  # @param [String] update_mask
1707
- # Required. The mask to control which fields get updated. If `update_mask` is
1708
- # not specified, an error will be returned.
2001
+ # The mask to control which fields get updated. If the mask is not present, all
2002
+ # fields will be updated.
1709
2003
  # @param [String] fields
1710
2004
  # Selector specifying which fields to include in a partial response.
1711
2005
  # @param [String] quota_user
@@ -1738,9 +2032,14 @@ module Google
1738
2032
  end
1739
2033
 
1740
2034
  # Trains the specified flow. Note that only the flow in 'draft' environment is
1741
- # trained. Note: You should always train a flow prior to sending it queries. See
1742
- # the [training documentation](https://cloud.google.com/dialogflow/cx/docs/
1743
- # concept/training).
2035
+ # trained. This method is a [long-running operation](https://cloud.google.com/
2036
+ # dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type
2037
+ # has the following method-specific fields: - `metadata`: An empty [Struct
2038
+ # message](https://developers.google.com/protocol-buffers/docs/reference/google.
2039
+ # protobuf#struct) - `response`: An [Empty message](https://developers.google.
2040
+ # com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should
2041
+ # always train a flow prior to sending it queries. See the [training
2042
+ # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
1744
2043
  # @param [String] name
1745
2044
  # Required. The flow to train. Format: `projects//locations//agents//flows/`.
1746
2045
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TrainFlowRequest] google_cloud_dialogflow_cx_v3beta1_train_flow_request_object
@@ -2268,7 +2567,45 @@ module Google
2268
2567
  execute_or_queue_command(command, &block)
2269
2568
  end
2270
2569
 
2271
- # Creates a Version in the specified Flow.
2570
+ # Compares the specified base version with target version.
2571
+ # @param [String] base_version
2572
+ # Required. Name of the base flow version to compare with the target version.
2573
+ # Use version ID `0` to indicate the draft version of the specified flow. Format:
2574
+ # `projects//locations//agents//flows//versions/`.
2575
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsRequest] google_cloud_dialogflow_cx_v3beta1_compare_versions_request_object
2576
+ # @param [String] fields
2577
+ # Selector specifying which fields to include in a partial response.
2578
+ # @param [String] quota_user
2579
+ # Available to use for quota purposes for server-side applications. Can be any
2580
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2581
+ # @param [Google::Apis::RequestOptions] options
2582
+ # Request-specific options
2583
+ #
2584
+ # @yield [result, err] Result & error if block supplied
2585
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsResponse] parsed result object
2586
+ # @yieldparam err [StandardError] error object if request failed
2587
+ #
2588
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsResponse]
2589
+ #
2590
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2591
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2592
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2593
+ def compare_project_location_agent_flow_version_versions(base_version, google_cloud_dialogflow_cx_v3beta1_compare_versions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2594
+ command = make_simple_command(:post, 'v3beta1/{+baseVersion}:compareVersions', options)
2595
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsRequest::Representation
2596
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_compare_versions_request_object
2597
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsResponse::Representation
2598
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsResponse
2599
+ command.params['baseVersion'] = base_version unless base_version.nil?
2600
+ command.query['fields'] = fields unless fields.nil?
2601
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2602
+ execute_or_queue_command(command, &block)
2603
+ end
2604
+
2605
+ # Creates a Version in the specified Flow. This method is a [long-running
2606
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
2607
+ # operation). The returned `Operation` type has the following method-specific
2608
+ # fields: - `metadata`: CreateVersionOperationMetadata - `response`: Version
2272
2609
  # @param [String] parent
2273
2610
  # Required. The Flow to create an Version for. Format: `projects//locations//
2274
2611
  # agents//flows/`.
@@ -2402,7 +2739,13 @@ module Google
2402
2739
  execute_or_queue_command(command, &block)
2403
2740
  end
2404
2741
 
2405
- # Loads resources in the specified version to the draft flow.
2742
+ # Loads resources in the specified version to the draft flow. This method is a [
2743
+ # long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
2744
+ # running-operation). The returned `Operation` type has the following method-
2745
+ # specific fields: - `metadata`: An empty [Struct message](https://developers.
2746
+ # google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
2747
+ # : An [Empty message](https://developers.google.com/protocol-buffers/docs/
2748
+ # reference/google.protobuf#empty)
2406
2749
  # @param [String] name
2407
2750
  # Required. The Version to be loaded to draft flow. Format: `projects//locations/
2408
2751
  # /agents//flows//versions/`.
@@ -3027,7 +3370,10 @@ module Google
3027
3370
  execute_or_queue_command(command, &block)
3028
3371
  end
3029
3372
 
3030
- # Kicks off a batch run of test cases.
3373
+ # Kicks off a batch run of test cases. This method is a [long-running operation](
3374
+ # https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
3375
+ # returned `Operation` type has the following method-specific fields: - `
3376
+ # metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse
3031
3377
  # @param [String] parent
3032
3378
  # Required. Agent name. Format: `projects//locations//agents/ `.
3033
3379
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1BatchRunTestCasesRequest] google_cloud_dialogflow_cx_v3beta1_batch_run_test_cases_request_object
@@ -3129,7 +3475,11 @@ module Google
3129
3475
  end
3130
3476
 
3131
3477
  # Exports the test cases under the agent to a Cloud Storage bucket or a local
3132
- # file. Filter can be applied to export a subset of test cases.
3478
+ # file. Filter can be applied to export a subset of test cases. This method is a
3479
+ # [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
3480
+ # running-operation). The returned `Operation` type has the following method-
3481
+ # specific fields: - `metadata`: ExportTestCasesMetadata - `response`:
3482
+ # ExportTestCasesResponse
3133
3483
  # @param [String] parent
3134
3484
  # Required. The agent where to export test cases from. Format: `projects//
3135
3485
  # locations//agents/`.
@@ -3196,7 +3546,11 @@ module Google
3196
3546
 
3197
3547
  # Imports the test cases from a Cloud Storage bucket or a local file. It always
3198
3548
  # creates new test cases and won't overwite any existing ones. The provided ID
3199
- # in the imported test case is neglected.
3549
+ # in the imported test case is neglected. This method is a [long-running
3550
+ # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
3551
+ # operation). The returned `Operation` type has the following method-specific
3552
+ # fields: - `metadata`: ImportTestCasesMetadata - `response`:
3553
+ # ImportTestCasesResponse
3200
3554
  # @param [String] parent
3201
3555
  # Required. The agent to import test cases to. Format: `projects//locations//
3202
3556
  # agents/`.
@@ -3311,7 +3665,10 @@ module Google
3311
3665
  execute_or_queue_command(command, &block)
3312
3666
  end
3313
3667
 
3314
- # Kicks off a test case run.
3668
+ # Kicks off a test case run. This method is a [long-running operation](https://
3669
+ # cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
3670
+ # Operation` type has the following method-specific fields: - `metadata`:
3671
+ # RunTestCaseMetadata - `response`: RunTestCaseResponse
3315
3672
  # @param [String] name
3316
3673
  # Required. Format of test case name to run: `projects//locations/ /agents//
3317
3674
  # testCases/`.
@@ -3861,7 +4218,9 @@ module Google
3861
4218
 
3862
4219
  # Updates the specified SecuritySettings.
3863
4220
  # @param [String] name
3864
- # Required. Resource name of the settings. Format: `projects//locations//
4221
+ # Resource name of the settings. Required for the SecuritySettingsService.
4222
+ # UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings
4223
+ # populates the name automatically. Format: `projects//locations//
3865
4224
  # securitySettings/`.
3866
4225
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings] google_cloud_dialogflow_cx_v3beta1_security_settings_object
3867
4226
  # @param [String] update_mask
@@ -30,7 +30,7 @@ module Google
30
30
  # This is NOT the gem version.
31
31
  VERSION = 'V3beta1'
32
32
 
33
- # See, edit, configure, and delete your Google Cloud Platform data
33
+ # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
34
34
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
35
35
 
36
36
  # View, manage and query your Dialogflow agents
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-dialogflow_v3beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.20.0
4
+ version: 0.24.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-08-09 00:00:00.000000000 Z
11
+ date: 2021-10-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
57
57
  - Apache-2.0
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
- changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-dialogflow_v3beta1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v3beta1/v0.20.0
62
- source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-dialogflow_v3beta1
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v3beta1/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v3beta1/v0.24.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v3beta1
63
63
  post_install_message:
64
64
  rdoc_options: []
65
65
  require_paths: