google-cloud-ces-v1 0.a → 0.1.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.
Files changed (137) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +154 -8
  5. data/lib/google/cloud/ces/v1/agent_pb.rb +30 -0
  6. data/lib/google/cloud/ces/v1/agent_service/client.rb +5315 -0
  7. data/lib/google/cloud/ces/v1/agent_service/credentials.rb +48 -0
  8. data/lib/google/cloud/ces/v1/agent_service/operations.rb +841 -0
  9. data/lib/google/cloud/ces/v1/agent_service/paths.rb +424 -0
  10. data/lib/google/cloud/ces/v1/agent_service/rest/client.rb +4944 -0
  11. data/lib/google/cloud/ces/v1/agent_service/rest/operations.rb +925 -0
  12. data/lib/google/cloud/ces/v1/agent_service/rest/service_stub.rb +3028 -0
  13. data/lib/google/cloud/ces/v1/agent_service/rest.rb +55 -0
  14. data/lib/google/cloud/ces/v1/agent_service.rb +57 -0
  15. data/lib/google/cloud/ces/v1/agent_service_pb.rb +105 -0
  16. data/lib/google/cloud/ces/v1/agent_service_services_pb.rb +142 -0
  17. data/lib/google/cloud/ces/v1/agent_tool_pb.rb +24 -0
  18. data/lib/google/cloud/ces/v1/agent_transfers_pb.rb +29 -0
  19. data/lib/google/cloud/ces/v1/app_pb.rb +58 -0
  20. data/lib/google/cloud/ces/v1/app_version_pb.rb +32 -0
  21. data/lib/google/cloud/ces/v1/auth_pb.rb +34 -0
  22. data/lib/google/cloud/ces/v1/bigquery_export_pb.rb +23 -0
  23. data/lib/google/cloud/ces/v1/bindings_override.rb +75 -0
  24. data/lib/google/cloud/ces/v1/changelog_pb.rb +26 -0
  25. data/lib/google/cloud/ces/v1/client_function_pb.rb +24 -0
  26. data/lib/google/cloud/ces/v1/common_pb.rb +46 -0
  27. data/lib/google/cloud/ces/v1/connector_tool_pb.rb +27 -0
  28. data/lib/google/cloud/ces/v1/connector_toolset_pb.rb +25 -0
  29. data/lib/google/cloud/ces/v1/conversation_pb.rb +31 -0
  30. data/lib/google/cloud/ces/v1/data_store_pb.rb +27 -0
  31. data/lib/google/cloud/ces/v1/data_store_tool_pb.rb +40 -0
  32. data/lib/google/cloud/ces/v1/deployment_pb.rb +26 -0
  33. data/lib/google/cloud/ces/v1/example_pb.rb +34 -0
  34. data/lib/google/cloud/ces/v1/fakes_pb.rb +24 -0
  35. data/lib/google/cloud/ces/v1/file_search_tool_pb.rb +24 -0
  36. data/lib/google/cloud/ces/v1/google_search_tool_pb.rb +24 -0
  37. data/lib/google/cloud/ces/v1/guardrail_pb.rb +37 -0
  38. data/lib/google/cloud/ces/v1/mcp_tool_pb.rb +26 -0
  39. data/lib/google/cloud/ces/v1/mcp_toolset_pb.rb +25 -0
  40. data/lib/google/cloud/ces/v1/omnichannel_pb.rb +31 -0
  41. data/lib/google/cloud/ces/v1/omnichannel_service_pb.rb +27 -0
  42. data/lib/google/cloud/ces/v1/open_api_tool_pb.rb +25 -0
  43. data/lib/google/cloud/ces/v1/open_api_toolset_pb.rb +25 -0
  44. data/lib/google/cloud/ces/v1/python_function_pb.rb +23 -0
  45. data/lib/google/cloud/ces/v1/rest.rb +41 -0
  46. data/lib/google/cloud/ces/v1/schema_pb.rb +25 -0
  47. data/lib/google/cloud/ces/v1/search_suggestions_pb.rb +22 -0
  48. data/lib/google/cloud/ces/v1/security_settings_pb.rb +27 -0
  49. data/lib/google/cloud/ces/v1/session_service/client.rb +759 -0
  50. data/lib/google/cloud/ces/v1/session_service/credentials.rb +48 -0
  51. data/lib/google/cloud/ces/v1/session_service/paths.rb +117 -0
  52. data/lib/google/cloud/ces/v1/session_service/rest/client.rb +560 -0
  53. data/lib/google/cloud/ces/v1/session_service/rest/service_stub.rb +199 -0
  54. data/lib/google/cloud/ces/v1/session_service/rest.rb +53 -0
  55. data/lib/google/cloud/ces/v1/session_service.rb +55 -0
  56. data/lib/google/cloud/ces/v1/session_service_pb.rb +50 -0
  57. data/lib/google/cloud/ces/v1/session_service_services_pb.rb +119 -0
  58. data/lib/google/cloud/ces/v1/system_tool_pb.rb +23 -0
  59. data/lib/google/cloud/ces/v1/tool_pb.rb +38 -0
  60. data/lib/google/cloud/ces/v1/tool_service/client.rb +723 -0
  61. data/lib/google/cloud/ces/v1/tool_service/credentials.rb +48 -0
  62. data/lib/google/cloud/ces/v1/tool_service/paths.rb +94 -0
  63. data/lib/google/cloud/ces/v1/tool_service/rest/client.rb +667 -0
  64. data/lib/google/cloud/ces/v1/tool_service/rest/service_stub.rb +267 -0
  65. data/lib/google/cloud/ces/v1/tool_service/rest.rb +53 -0
  66. data/lib/google/cloud/ces/v1/tool_service.rb +55 -0
  67. data/lib/google/cloud/ces/v1/tool_service_pb.rb +35 -0
  68. data/lib/google/cloud/ces/v1/tool_service_services_pb.rb +50 -0
  69. data/lib/google/cloud/ces/v1/toolset_pb.rb +30 -0
  70. data/lib/google/cloud/ces/v1/toolset_tool_pb.rb +24 -0
  71. data/lib/google/cloud/ces/v1/version.rb +7 -2
  72. data/lib/google/cloud/ces/v1/widget_service/client.rb +501 -0
  73. data/lib/google/cloud/ces/v1/widget_service/credentials.rb +48 -0
  74. data/lib/google/cloud/ces/v1/widget_service/paths.rb +75 -0
  75. data/lib/google/cloud/ces/v1/widget_service/rest/client.rb +459 -0
  76. data/lib/google/cloud/ces/v1/widget_service/rest/service_stub.rb +143 -0
  77. data/lib/google/cloud/ces/v1/widget_service/rest.rb +53 -0
  78. data/lib/google/cloud/ces/v1/widget_service.rb +55 -0
  79. data/lib/google/cloud/ces/v1/widget_service_pb.rb +28 -0
  80. data/lib/google/cloud/ces/v1/widget_service_services_pb.rb +46 -0
  81. data/lib/google/cloud/ces/v1/widget_tool_pb.rb +29 -0
  82. data/lib/google/cloud/ces/v1.rb +48 -0
  83. data/lib/google-cloud-ces-v1.rb +21 -0
  84. data/proto_docs/README.md +4 -0
  85. data/proto_docs/google/api/client.rb +593 -0
  86. data/proto_docs/google/api/field_behavior.rb +85 -0
  87. data/proto_docs/google/api/launch_stage.rb +71 -0
  88. data/proto_docs/google/api/resource.rb +227 -0
  89. data/proto_docs/google/cloud/ces/v1/agent.rb +224 -0
  90. data/proto_docs/google/cloud/ces/v1/agent_service.rb +1250 -0
  91. data/proto_docs/google/cloud/ces/v1/agent_tool.rb +42 -0
  92. data/proto_docs/google/cloud/ces/v1/agent_transfers.rb +111 -0
  93. data/proto_docs/google/cloud/ces/v1/app.rb +685 -0
  94. data/proto_docs/google/cloud/ces/v1/app_version.rb +83 -0
  95. data/proto_docs/google/cloud/ces/v1/auth.rb +214 -0
  96. data/proto_docs/google/cloud/ces/v1/bigquery_export.rb +45 -0
  97. data/proto_docs/google/cloud/ces/v1/changelog.rb +73 -0
  98. data/proto_docs/google/cloud/ces/v1/client_function.rb +48 -0
  99. data/proto_docs/google/cloud/ces/v1/common.rb +375 -0
  100. data/proto_docs/google/cloud/ces/v1/connector_tool.rb +122 -0
  101. data/proto_docs/google/cloud/ces/v1/connector_toolset.rb +52 -0
  102. data/proto_docs/google/cloud/ces/v1/conversation.rb +152 -0
  103. data/proto_docs/google/cloud/ces/v1/data_store.rb +102 -0
  104. data/proto_docs/google/cloud/ces/v1/data_store_tool.rb +328 -0
  105. data/proto_docs/google/cloud/ces/v1/deployment.rb +62 -0
  106. data/proto_docs/google/cloud/ces/v1/example.rb +244 -0
  107. data/proto_docs/google/cloud/ces/v1/fakes.rb +55 -0
  108. data/proto_docs/google/cloud/ces/v1/file_search_tool.rb +60 -0
  109. data/proto_docs/google/cloud/ces/v1/google_search_tool.rb +76 -0
  110. data/proto_docs/google/cloud/ces/v1/guardrail.rb +324 -0
  111. data/proto_docs/google/cloud/ces/v1/mcp_tool.rb +85 -0
  112. data/proto_docs/google/cloud/ces/v1/mcp_toolset.rb +71 -0
  113. data/proto_docs/google/cloud/ces/v1/omnichannel.rb +163 -0
  114. data/proto_docs/google/cloud/ces/v1/omnichannel_service.rb +45 -0
  115. data/proto_docs/google/cloud/ces/v1/open_api_tool.rb +66 -0
  116. data/proto_docs/google/cloud/ces/v1/open_api_toolset.rb +57 -0
  117. data/proto_docs/google/cloud/ces/v1/python_function.rb +44 -0
  118. data/proto_docs/google/cloud/ces/v1/schema.rb +162 -0
  119. data/proto_docs/google/cloud/ces/v1/search_suggestions.rb +55 -0
  120. data/proto_docs/google/cloud/ces/v1/security_settings.rb +80 -0
  121. data/proto_docs/google/cloud/ces/v1/session_service.rb +464 -0
  122. data/proto_docs/google/cloud/ces/v1/system_tool.rb +38 -0
  123. data/proto_docs/google/cloud/ces/v1/tool.rb +126 -0
  124. data/proto_docs/google/cloud/ces/v1/tool_service.rb +168 -0
  125. data/proto_docs/google/cloud/ces/v1/toolset.rb +80 -0
  126. data/proto_docs/google/cloud/ces/v1/toolset_tool.rb +40 -0
  127. data/proto_docs/google/cloud/ces/v1/widget_service.rb +62 -0
  128. data/proto_docs/google/cloud/ces/v1/widget_tool.rb +146 -0
  129. data/proto_docs/google/longrunning/operations.rb +191 -0
  130. data/proto_docs/google/protobuf/any.rb +145 -0
  131. data/proto_docs/google/protobuf/duration.rb +98 -0
  132. data/proto_docs/google/protobuf/empty.rb +34 -0
  133. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  134. data/proto_docs/google/protobuf/struct.rb +108 -0
  135. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  136. data/proto_docs/google/rpc/status.rb +48 -0
  137. metadata +183 -9
@@ -0,0 +1,1250 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Ces
23
+ module V1
24
+ # Request message for
25
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_apps AgentService.ListApps}.
26
+ # @!attribute [rw] parent
27
+ # @return [::String]
28
+ # Required. The resource name of the location to list apps from.
29
+ # @!attribute [rw] page_size
30
+ # @return [::Integer]
31
+ # Optional. Requested page size. Server may return fewer items than
32
+ # requested. If unspecified, server will pick an appropriate default.
33
+ # @!attribute [rw] page_token
34
+ # @return [::String]
35
+ # Optional. The
36
+ # {::Google::Cloud::Ces::V1::ListAppsResponse#next_page_token next_page_token}
37
+ # value returned from a previous list
38
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_apps AgentService.ListApps} call.
39
+ # @!attribute [rw] filter
40
+ # @return [::String]
41
+ # Optional. Filter to be applied when listing the apps.
42
+ # See https://google.aip.dev/160 for more details.
43
+ # @!attribute [rw] order_by
44
+ # @return [::String]
45
+ # Optional. Field to sort by. Only "name" and "create_time" is supported.
46
+ # See https://google.aip.dev/132#ordering for more details.
47
+ class ListAppsRequest
48
+ include ::Google::Protobuf::MessageExts
49
+ extend ::Google::Protobuf::MessageExts::ClassMethods
50
+ end
51
+
52
+ # Response message for
53
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_apps AgentService.ListApps}.
54
+ # @!attribute [rw] apps
55
+ # @return [::Array<::Google::Cloud::Ces::V1::App>]
56
+ # The list of apps.
57
+ # @!attribute [rw] next_page_token
58
+ # @return [::String]
59
+ # A token that can be sent as
60
+ # {::Google::Cloud::Ces::V1::ListAppsRequest#page_token ListAppsRequest.page_token}
61
+ # to retrieve the next page. Absence of this field indicates there are no
62
+ # subsequent pages.
63
+ # @!attribute [rw] unreachable
64
+ # @return [::Array<::String>]
65
+ # Unordered list. Locations that could not be reached.
66
+ class ListAppsResponse
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+ end
70
+
71
+ # Request message for
72
+ # {::Google::Cloud::Ces::V1::AgentService::Client#get_app AgentService.GetApp}.
73
+ # @!attribute [rw] name
74
+ # @return [::String]
75
+ # Required. The resource name of the app to retrieve.
76
+ class GetAppRequest
77
+ include ::Google::Protobuf::MessageExts
78
+ extend ::Google::Protobuf::MessageExts::ClassMethods
79
+ end
80
+
81
+ # Request message for
82
+ # {::Google::Cloud::Ces::V1::AgentService::Client#create_app AgentService.CreateApp}.
83
+ # @!attribute [rw] parent
84
+ # @return [::String]
85
+ # Required. The resource name of the location to create an app in.
86
+ # @!attribute [rw] app_id
87
+ # @return [::String]
88
+ # Optional. The ID to use for the app, which will become the final component
89
+ # of the app's resource name. If not provided, a unique ID will be
90
+ # automatically assigned for the app.
91
+ # @!attribute [rw] app
92
+ # @return [::Google::Cloud::Ces::V1::App]
93
+ # Required. The app to create.
94
+ class CreateAppRequest
95
+ include ::Google::Protobuf::MessageExts
96
+ extend ::Google::Protobuf::MessageExts::ClassMethods
97
+ end
98
+
99
+ # Request message for
100
+ # {::Google::Cloud::Ces::V1::AgentService::Client#update_app AgentService.UpdateApp}.
101
+ # @!attribute [rw] app
102
+ # @return [::Google::Cloud::Ces::V1::App]
103
+ # Required. The app to update.
104
+ # @!attribute [rw] update_mask
105
+ # @return [::Google::Protobuf::FieldMask]
106
+ # Optional. Field mask is used to control which fields get updated. If the
107
+ # mask is not present, all fields will be updated.
108
+ class UpdateAppRequest
109
+ include ::Google::Protobuf::MessageExts
110
+ extend ::Google::Protobuf::MessageExts::ClassMethods
111
+ end
112
+
113
+ # Request message for
114
+ # {::Google::Cloud::Ces::V1::AgentService::Client#delete_app AgentService.DeleteApp}.
115
+ # @!attribute [rw] name
116
+ # @return [::String]
117
+ # Required. The resource name of the app to delete.
118
+ # @!attribute [rw] etag
119
+ # @return [::String]
120
+ # Optional. The current etag of the app. If an etag is not provided, the
121
+ # deletion will overwrite any concurrent changes. If an etag is provided and
122
+ # does not match the current etag of the app, deletion will be blocked and an
123
+ # ABORTED error will be returned.
124
+ class DeleteAppRequest
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+ end
128
+
129
+ # Request message for
130
+ # {::Google::Cloud::Ces::V1::AgentService::Client#export_app AgentService.ExportApp}.
131
+ # @!attribute [rw] name
132
+ # @return [::String]
133
+ # Required. The resource name of the app to export.
134
+ # @!attribute [rw] export_format
135
+ # @return [::Google::Cloud::Ces::V1::ExportAppRequest::ExportFormat]
136
+ # Required. The format to export the app in.
137
+ # @!attribute [rw] gcs_uri
138
+ # @return [::String]
139
+ # Optional. The [Google Cloud
140
+ # Storage](https://cloud.google.com/storage/docs/) URI to which to export the
141
+ # app. The format of this URI must be `gs://<bucket-name>/<object-name>`. The
142
+ # exported app archive will be written directly to the specified GCS object.
143
+ # @!attribute [rw] app_version
144
+ # @return [::String]
145
+ # Optional. The resource name of the app version to export.
146
+ # Format:
147
+ # `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.
148
+ class ExportAppRequest
149
+ include ::Google::Protobuf::MessageExts
150
+ extend ::Google::Protobuf::MessageExts::ClassMethods
151
+
152
+ # Export format for the app.
153
+ module ExportFormat
154
+ # The export format is unspecified.
155
+ EXPORT_FORMAT_UNSPECIFIED = 0
156
+
157
+ # The export format is JSON.
158
+ JSON = 1
159
+
160
+ # The export format is YAML.
161
+ YAML = 2
162
+ end
163
+ end
164
+
165
+ # Response message for
166
+ # {::Google::Cloud::Ces::V1::AgentService::Client#export_app AgentService.ExportApp}.
167
+ # @!attribute [rw] app_content
168
+ # @return [::String]
169
+ # App folder compressed as a zip file.
170
+ #
171
+ # Note: The following fields are mutually exclusive: `app_content`, `app_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
172
+ # @!attribute [rw] app_uri
173
+ # @return [::String]
174
+ # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
175
+ # to which the app was exported.
176
+ #
177
+ # Note: The following fields are mutually exclusive: `app_uri`, `app_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
178
+ class ExportAppResponse
179
+ include ::Google::Protobuf::MessageExts
180
+ extend ::Google::Protobuf::MessageExts::ClassMethods
181
+ end
182
+
183
+ # Request message for
184
+ # {::Google::Cloud::Ces::V1::AgentService::Client#import_app AgentService.ImportApp}.
185
+ # @!attribute [rw] gcs_uri
186
+ # @return [::String]
187
+ # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
188
+ # from which to import app. The format of this URI must be
189
+ # `gs://<bucket-name>/<object-name>`.
190
+ #
191
+ # Note: The following fields are mutually exclusive: `gcs_uri`, `app_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
192
+ # @!attribute [rw] app_content
193
+ # @return [::String]
194
+ # Raw bytes representing the compressed zip file with the app folder
195
+ # structure.
196
+ #
197
+ # Note: The following fields are mutually exclusive: `app_content`, `gcs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
198
+ # @!attribute [rw] parent
199
+ # @return [::String]
200
+ # Required. The parent resource name with the location of the app to import.
201
+ # @!attribute [rw] display_name
202
+ # @return [::String]
203
+ # Optional. The display name of the app to import.
204
+ # * If the app is created on import, and the display name is specified,
205
+ # the imported app will use this display name. If a conflict is detected
206
+ # with an existing app, a timestamp will be appended to the display name
207
+ # to make it unique.
208
+ # * If the app is a reimport, this field should not be set. Providing a
209
+ # display name during reimport will result in an INVALID_ARGUMENT error.
210
+ # @!attribute [rw] app_id
211
+ # @return [::String]
212
+ # Optional. The ID to use for the imported app.
213
+ # * If not specified, a unique ID will be automatically assigned for
214
+ # the app.
215
+ # * Otherwise, the imported app will use this ID as the final component of
216
+ # its resource name. If an app with the same ID already exists at the
217
+ # specified location in the project, the content of the existing app will be
218
+ # replaced.
219
+ # @!attribute [rw] import_options
220
+ # @return [::Google::Cloud::Ces::V1::ImportAppRequest::ImportOptions]
221
+ # Optional. Options governing the import process for the app.
222
+ # @!attribute [rw] ignore_app_lock
223
+ # @return [::Boolean]
224
+ # Optional. Flag for overriding the app lock during import.
225
+ # If set to true, the import process will ignore the app lock.
226
+ class ImportAppRequest
227
+ include ::Google::Protobuf::MessageExts
228
+ extend ::Google::Protobuf::MessageExts::ClassMethods
229
+
230
+ # Configuration options for the app import process.
231
+ # These options control how the import behaves, particularly when
232
+ # conflicts arise with existing app data.
233
+ # @!attribute [rw] conflict_resolution_strategy
234
+ # @return [::Google::Cloud::Ces::V1::ImportAppRequest::ImportOptions::ConflictResolutionStrategy]
235
+ # Optional. The strategy to use when resolving conflicts during import.
236
+ class ImportOptions
237
+ include ::Google::Protobuf::MessageExts
238
+ extend ::Google::Protobuf::MessageExts::ClassMethods
239
+
240
+ # Defines the strategy for handling conflicts when an app with the same ID
241
+ # already exists, or when imported resources (like Agents, Tools, etc.)
242
+ # have the same display names as existing resources within that app.
243
+ module ConflictResolutionStrategy
244
+ # The conflict resolution strategy is unspecified.
245
+ CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED = 0
246
+
247
+ # Replace existing data with imported data.
248
+ # If an app with the same `app_id` already exists, its content will be
249
+ # updated based on the imported app.
250
+ # - Resources (App, Agents, Tools, Examples, Guardrails, Toolsets) in the
251
+ # imported app that have the same display name as existing resources
252
+ # will overwrite the existing ones.
253
+ # - Imported resources with new display names will be created.
254
+ # - Existing resources that do not have a matching display name in the
255
+ # imported app will remain untouched.
256
+ REPLACE = 1
257
+
258
+ # Overwrite existing data with imported data.
259
+ # If an app with the same `app_id` already exists, its content will be
260
+ # overwritten with the imported app.
261
+ # - Existing resources (Agents, Tools, Examples, Guardrails, Toolsets) in
262
+ # the app will be deleted.
263
+ # - Imported resources will be created as new resources.
264
+ OVERWRITE = 2
265
+ end
266
+ end
267
+ end
268
+
269
+ # Response message for
270
+ # {::Google::Cloud::Ces::V1::AgentService::Client#import_app AgentService.ImportApp}.
271
+ # @!attribute [rw] name
272
+ # @return [::String]
273
+ # The resource name of the app that was imported.
274
+ # @!attribute [rw] warnings
275
+ # @return [::Array<::String>]
276
+ # Warning messages generated during the import process.
277
+ # If errors occur for specific resources, they will not be included in the
278
+ # imported app and the error will be mentioned here.
279
+ class ImportAppResponse
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+
284
+ # Request message for
285
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_agents AgentService.ListAgents}.
286
+ # @!attribute [rw] parent
287
+ # @return [::String]
288
+ # Required. The resource name of the app to list agents from.
289
+ # @!attribute [rw] page_size
290
+ # @return [::Integer]
291
+ # Optional. Requested page size. Server may return fewer items than
292
+ # requested. If unspecified, server will pick an appropriate default.
293
+ # @!attribute [rw] page_token
294
+ # @return [::String]
295
+ # Optional. The
296
+ # {::Google::Cloud::Ces::V1::ListAgentsResponse#next_page_token next_page_token}
297
+ # value returned from a previous list
298
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_agents AgentService.ListAgents}
299
+ # call.
300
+ # @!attribute [rw] filter
301
+ # @return [::String]
302
+ # Optional. Filter to be applied when listing the agents.
303
+ # See https://google.aip.dev/160 for more details.
304
+ # @!attribute [rw] order_by
305
+ # @return [::String]
306
+ # Optional. Field to sort by. Only "name" and "create_time" is supported.
307
+ # See https://google.aip.dev/132#ordering for more details.
308
+ class ListAgentsRequest
309
+ include ::Google::Protobuf::MessageExts
310
+ extend ::Google::Protobuf::MessageExts::ClassMethods
311
+ end
312
+
313
+ # Response message for
314
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_agents AgentService.ListAgents}.
315
+ # @!attribute [rw] agents
316
+ # @return [::Array<::Google::Cloud::Ces::V1::Agent>]
317
+ # The list of agents.
318
+ # @!attribute [rw] next_page_token
319
+ # @return [::String]
320
+ # A token that can be sent as
321
+ # {::Google::Cloud::Ces::V1::ListAgentsRequest#page_token ListAgentsRequest.page_token}
322
+ # to retrieve the next page. Absence of this field indicates there are no
323
+ # subsequent pages.
324
+ class ListAgentsResponse
325
+ include ::Google::Protobuf::MessageExts
326
+ extend ::Google::Protobuf::MessageExts::ClassMethods
327
+ end
328
+
329
+ # Request message for
330
+ # {::Google::Cloud::Ces::V1::AgentService::Client#get_agent AgentService.GetAgent}.
331
+ # @!attribute [rw] name
332
+ # @return [::String]
333
+ # Required. The resource name of the agent to retrieve.
334
+ class GetAgentRequest
335
+ include ::Google::Protobuf::MessageExts
336
+ extend ::Google::Protobuf::MessageExts::ClassMethods
337
+ end
338
+
339
+ # Request message for
340
+ # {::Google::Cloud::Ces::V1::AgentService::Client#create_agent AgentService.CreateAgent}.
341
+ # @!attribute [rw] parent
342
+ # @return [::String]
343
+ # Required. The resource name of the app to create an agent in.
344
+ # @!attribute [rw] agent_id
345
+ # @return [::String]
346
+ # Optional. The ID to use for the agent, which will become the final
347
+ # component of the agent's resource name. If not provided, a unique ID will
348
+ # be automatically assigned for the agent.
349
+ # @!attribute [rw] agent
350
+ # @return [::Google::Cloud::Ces::V1::Agent]
351
+ # Required. The agent to create.
352
+ class CreateAgentRequest
353
+ include ::Google::Protobuf::MessageExts
354
+ extend ::Google::Protobuf::MessageExts::ClassMethods
355
+ end
356
+
357
+ # Request message for
358
+ # {::Google::Cloud::Ces::V1::AgentService::Client#update_agent AgentService.UpdateAgent}.
359
+ # @!attribute [rw] agent
360
+ # @return [::Google::Cloud::Ces::V1::Agent]
361
+ # Required. The agent to update.
362
+ # @!attribute [rw] update_mask
363
+ # @return [::Google::Protobuf::FieldMask]
364
+ # Optional. Field mask is used to control which fields get updated. If the
365
+ # mask is not present, all fields will be updated.
366
+ class UpdateAgentRequest
367
+ include ::Google::Protobuf::MessageExts
368
+ extend ::Google::Protobuf::MessageExts::ClassMethods
369
+ end
370
+
371
+ # Request message for
372
+ # {::Google::Cloud::Ces::V1::AgentService::Client#delete_agent AgentService.DeleteAgent}.
373
+ # @!attribute [rw] name
374
+ # @return [::String]
375
+ # Required. The resource name of the agent to delete.
376
+ # @!attribute [rw] force
377
+ # @return [::Boolean]
378
+ # Optional. Indicates whether to forcefully delete the agent, even if it is
379
+ # still referenced by other app/agents/examples.
380
+ #
381
+ # * If `force = false`, the deletion fails if other agents/examples
382
+ # reference it.
383
+ # * If `force = true`, delete the agent and remove it from all referencing
384
+ # apps/agents/examples.
385
+ # @!attribute [rw] etag
386
+ # @return [::String]
387
+ # Optional. The current etag of the agent. If an etag is not provided, the
388
+ # deletion will overwrite any concurrent changes. If an etag is provided and
389
+ # does not match the current etag of the agent, deletion will be blocked and
390
+ # an ABORTED error will be returned.
391
+ class DeleteAgentRequest
392
+ include ::Google::Protobuf::MessageExts
393
+ extend ::Google::Protobuf::MessageExts::ClassMethods
394
+ end
395
+
396
+ # Represents the metadata of the long-running operation.
397
+ # @!attribute [r] create_time
398
+ # @return [::Google::Protobuf::Timestamp]
399
+ # Output only. The time the operation was created.
400
+ # @!attribute [r] end_time
401
+ # @return [::Google::Protobuf::Timestamp]
402
+ # Output only. The time the operation finished running.
403
+ # @!attribute [r] status_message
404
+ # @return [::String]
405
+ # Output only. Human-readable status of the operation, if any.
406
+ # @!attribute [r] requested_cancellation
407
+ # @return [::Boolean]
408
+ # Output only. Identifies whether the user has requested cancellation of the
409
+ # operation. Operations that have been cancelled successfully have
410
+ # {::Google::Longrunning::Operation#error google.longrunning.Operation.error}
411
+ # value with a {::Google::Rpc::Status#code google.rpc.Status.code} of `1`,
412
+ # corresponding to `Code.CANCELLED`.
413
+ class OperationMetadata
414
+ include ::Google::Protobuf::MessageExts
415
+ extend ::Google::Protobuf::MessageExts::ClassMethods
416
+ end
417
+
418
+ # Request message for
419
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_examples AgentService.ListExamples}.
420
+ # @!attribute [rw] parent
421
+ # @return [::String]
422
+ # Required. The resource name of the app to list examples from.
423
+ # @!attribute [rw] page_size
424
+ # @return [::Integer]
425
+ # Optional. Requested page size. Server may return fewer items than
426
+ # requested. If unspecified, server will pick an appropriate default.
427
+ # @!attribute [rw] page_token
428
+ # @return [::String]
429
+ # Optional. The
430
+ # {::Google::Cloud::Ces::V1::ListExamplesResponse#next_page_token next_page_token}
431
+ # value returned from a previous list
432
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_examples AgentService.ListExamples}
433
+ # call.
434
+ # @!attribute [rw] filter
435
+ # @return [::String]
436
+ # Optional. Filter to be applied when listing the examples.
437
+ # See https://google.aip.dev/160 for more details.
438
+ # @!attribute [rw] order_by
439
+ # @return [::String]
440
+ # Optional. Field to sort by. Only "name" and "create_time" is supported.
441
+ # See https://google.aip.dev/132#ordering for more details.
442
+ class ListExamplesRequest
443
+ include ::Google::Protobuf::MessageExts
444
+ extend ::Google::Protobuf::MessageExts::ClassMethods
445
+ end
446
+
447
+ # Response message for
448
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_examples AgentService.ListExamples}.
449
+ # @!attribute [rw] examples
450
+ # @return [::Array<::Google::Cloud::Ces::V1::Example>]
451
+ # The list of examples.
452
+ # @!attribute [rw] next_page_token
453
+ # @return [::String]
454
+ # A token that can be sent as
455
+ # {::Google::Cloud::Ces::V1::ListExamplesRequest#page_token ListExamplesRequest.page_token}
456
+ # to retrieve the next page. Absence of this field indicates there are no
457
+ # subsequent pages.
458
+ class ListExamplesResponse
459
+ include ::Google::Protobuf::MessageExts
460
+ extend ::Google::Protobuf::MessageExts::ClassMethods
461
+ end
462
+
463
+ # Request message for
464
+ # {::Google::Cloud::Ces::V1::AgentService::Client#get_example AgentService.GetExample}.
465
+ # @!attribute [rw] name
466
+ # @return [::String]
467
+ # Required. The resource name of the example to retrieve.
468
+ class GetExampleRequest
469
+ include ::Google::Protobuf::MessageExts
470
+ extend ::Google::Protobuf::MessageExts::ClassMethods
471
+ end
472
+
473
+ # Request message for
474
+ # {::Google::Cloud::Ces::V1::AgentService::Client#create_example AgentService.CreateExample}.
475
+ # @!attribute [rw] parent
476
+ # @return [::String]
477
+ # Required. The resource name of the app to create an example in.
478
+ # @!attribute [rw] example_id
479
+ # @return [::String]
480
+ # Optional. The ID to use for the example, which will become the final
481
+ # component of the example's resource name. If not provided, a unique ID will
482
+ # be automatically assigned for the example.
483
+ # @!attribute [rw] example
484
+ # @return [::Google::Cloud::Ces::V1::Example]
485
+ # Required. The example to create.
486
+ class CreateExampleRequest
487
+ include ::Google::Protobuf::MessageExts
488
+ extend ::Google::Protobuf::MessageExts::ClassMethods
489
+ end
490
+
491
+ # Request message for
492
+ # {::Google::Cloud::Ces::V1::AgentService::Client#update_example AgentService.UpdateExample}.
493
+ # @!attribute [rw] example
494
+ # @return [::Google::Cloud::Ces::V1::Example]
495
+ # Required. The example to update.
496
+ # @!attribute [rw] update_mask
497
+ # @return [::Google::Protobuf::FieldMask]
498
+ # Optional. Field mask is used to control which fields get updated. If the
499
+ # mask is not present, all fields will be updated.
500
+ class UpdateExampleRequest
501
+ include ::Google::Protobuf::MessageExts
502
+ extend ::Google::Protobuf::MessageExts::ClassMethods
503
+ end
504
+
505
+ # Request message for
506
+ # {::Google::Cloud::Ces::V1::AgentService::Client#delete_example AgentService.DeleteExample}.
507
+ # @!attribute [rw] name
508
+ # @return [::String]
509
+ # Required. The resource name of the example to delete.
510
+ # @!attribute [rw] etag
511
+ # @return [::String]
512
+ # Optional. The current etag of the example. If an etag is not provided, the
513
+ # deletion will overwrite any concurrent changes. If an etag is provided and
514
+ # does not match the current etag of the example, deletion will be blocked
515
+ # and an ABORTED error will be returned.
516
+ class DeleteExampleRequest
517
+ include ::Google::Protobuf::MessageExts
518
+ extend ::Google::Protobuf::MessageExts::ClassMethods
519
+ end
520
+
521
+ # Request message for
522
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_tools AgentService.ListTools}.
523
+ # @!attribute [rw] parent
524
+ # @return [::String]
525
+ # Required. The resource name of the app to list tools from.
526
+ # @!attribute [rw] page_size
527
+ # @return [::Integer]
528
+ # Optional. Requested page size. Server may return fewer items than
529
+ # requested. If unspecified, server will pick an appropriate default.
530
+ # @!attribute [rw] page_token
531
+ # @return [::String]
532
+ # Optional. The
533
+ # {::Google::Cloud::Ces::V1::ListToolsResponse#next_page_token next_page_token}
534
+ # value returned from a previous list
535
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_tools AgentService.ListTools} call.
536
+ # @!attribute [rw] filter
537
+ # @return [::String]
538
+ # Optional. Filter to be applied when listing the tools. Use
539
+ # "include_system_tools=true" to include system tools in the response. See
540
+ # https://google.aip.dev/160 for more details.
541
+ # @!attribute [rw] order_by
542
+ # @return [::String]
543
+ # Optional. Field to sort by. Only "name" and "create_time" is supported.
544
+ # See https://google.aip.dev/132#ordering for more details.
545
+ class ListToolsRequest
546
+ include ::Google::Protobuf::MessageExts
547
+ extend ::Google::Protobuf::MessageExts::ClassMethods
548
+ end
549
+
550
+ # Response message for
551
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_tools AgentService.ListTools}.
552
+ # @!attribute [rw] tools
553
+ # @return [::Array<::Google::Cloud::Ces::V1::Tool>]
554
+ # The list of tools.
555
+ # @!attribute [rw] next_page_token
556
+ # @return [::String]
557
+ # A token that can be sent as
558
+ # {::Google::Cloud::Ces::V1::ListToolsRequest#page_token ListToolsRequest.page_token}
559
+ # to retrieve the next page. Absence of this field indicates there are no
560
+ # subsequent pages.
561
+ class ListToolsResponse
562
+ include ::Google::Protobuf::MessageExts
563
+ extend ::Google::Protobuf::MessageExts::ClassMethods
564
+ end
565
+
566
+ # Request message for
567
+ # {::Google::Cloud::Ces::V1::AgentService::Client#get_tool AgentService.GetTool}.
568
+ # @!attribute [rw] name
569
+ # @return [::String]
570
+ # Required. The resource name of the tool to retrieve.
571
+ class GetToolRequest
572
+ include ::Google::Protobuf::MessageExts
573
+ extend ::Google::Protobuf::MessageExts::ClassMethods
574
+ end
575
+
576
+ # Request message for
577
+ # {::Google::Cloud::Ces::V1::AgentService::Client#create_tool AgentService.CreateTool}.
578
+ # @!attribute [rw] parent
579
+ # @return [::String]
580
+ # Required. The resource name of the app to create a tool in.
581
+ # @!attribute [rw] tool_id
582
+ # @return [::String]
583
+ # Optional. The ID to use for the tool, which will become the final component
584
+ # of the tool's resource name. If not provided, a unique ID will be
585
+ # automatically assigned for the tool.
586
+ # @!attribute [rw] tool
587
+ # @return [::Google::Cloud::Ces::V1::Tool]
588
+ # Required. The tool to create.
589
+ class CreateToolRequest
590
+ include ::Google::Protobuf::MessageExts
591
+ extend ::Google::Protobuf::MessageExts::ClassMethods
592
+ end
593
+
594
+ # Request message for
595
+ # {::Google::Cloud::Ces::V1::AgentService::Client#update_tool AgentService.UpdateTool}.
596
+ # @!attribute [rw] tool
597
+ # @return [::Google::Cloud::Ces::V1::Tool]
598
+ # Required. The tool to update.
599
+ # @!attribute [rw] update_mask
600
+ # @return [::Google::Protobuf::FieldMask]
601
+ # Optional. Field mask is used to control which fields get updated. If the
602
+ # mask is not present, all fields will be updated.
603
+ class UpdateToolRequest
604
+ include ::Google::Protobuf::MessageExts
605
+ extend ::Google::Protobuf::MessageExts::ClassMethods
606
+ end
607
+
608
+ # Request message for
609
+ # {::Google::Cloud::Ces::V1::AgentService::Client#delete_tool AgentService.DeleteTool}.
610
+ # @!attribute [rw] name
611
+ # @return [::String]
612
+ # Required. The resource name of the tool to delete.
613
+ # @!attribute [rw] force
614
+ # @return [::Boolean]
615
+ # Optional. Indicates whether to forcefully delete the tool, even if it is
616
+ # still referenced by agents/examples.
617
+ #
618
+ # * If `force = false`, the deletion will fail if any agents still
619
+ # reference the tool.
620
+ # * If `force = true`, all existing references from agents will be removed
621
+ # and the tool will be deleted.
622
+ # @!attribute [rw] etag
623
+ # @return [::String]
624
+ # Optional. The current etag of the tool. If an etag is not provided, the
625
+ # deletion will overwrite any concurrent changes. If an etag is provided and
626
+ # does not match the current etag of the tool, deletion will be blocked and
627
+ # an ABORTED error will be returned.
628
+ class DeleteToolRequest
629
+ include ::Google::Protobuf::MessageExts
630
+ extend ::Google::Protobuf::MessageExts::ClassMethods
631
+ end
632
+
633
+ # Request message for
634
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_conversations AgentService.ListConversations}.
635
+ # @!attribute [rw] parent
636
+ # @return [::String]
637
+ # Required. The resource name of the app to list conversations from.
638
+ # @!attribute [rw] page_size
639
+ # @return [::Integer]
640
+ # Optional. Requested page size. Server may return fewer items than
641
+ # requested. If unspecified, server will pick an appropriate default.
642
+ # @!attribute [rw] page_token
643
+ # @return [::String]
644
+ # Optional. The
645
+ # {::Google::Cloud::Ces::V1::ListConversationsResponse#next_page_token next_page_token}
646
+ # value returned from a previous list
647
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_conversations AgentService.ListConversations}
648
+ # call.
649
+ # @!attribute [rw] filter
650
+ # @return [::String]
651
+ # Optional. Filter to be applied when listing the conversations.
652
+ # See https://google.aip.dev/160 for more details.
653
+ # @!attribute [rw] source
654
+ # @return [::Google::Cloud::Ces::V1::Conversation::Source]
655
+ # Optional. Indicate the source of the conversation. If not set, Source.Live
656
+ # will be applied by default. Will be deprecated in favor of `sources` field.
657
+ # @!attribute [rw] sources
658
+ # @return [::Array<::Google::Cloud::Ces::V1::Conversation::Source>]
659
+ # Optional. Indicate the sources of the conversations. If not set, all
660
+ # available sources will be applied by default.
661
+ class ListConversationsRequest
662
+ include ::Google::Protobuf::MessageExts
663
+ extend ::Google::Protobuf::MessageExts::ClassMethods
664
+ end
665
+
666
+ # Response message for
667
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_conversations AgentService.ListConversations}.
668
+ # @!attribute [rw] conversations
669
+ # @return [::Array<::Google::Cloud::Ces::V1::Conversation>]
670
+ # The list of conversations.
671
+ # @!attribute [rw] next_page_token
672
+ # @return [::String]
673
+ # A token that can be sent as
674
+ # {::Google::Cloud::Ces::V1::ListConversationsRequest#page_token ListConversationsRequest.page_token}
675
+ # to retrieve the next page. Absence of this field indicates there are no
676
+ # subsequent pages.
677
+ class ListConversationsResponse
678
+ include ::Google::Protobuf::MessageExts
679
+ extend ::Google::Protobuf::MessageExts::ClassMethods
680
+ end
681
+
682
+ # Request message for
683
+ # {::Google::Cloud::Ces::V1::AgentService::Client#get_conversation AgentService.GetConversation}.
684
+ # @!attribute [rw] name
685
+ # @return [::String]
686
+ # Required. The resource name of the conversation to retrieve.
687
+ # @!attribute [rw] source
688
+ # @deprecated This field is deprecated and may be removed in the next major version update.
689
+ # @return [::Google::Cloud::Ces::V1::Conversation::Source]
690
+ # Optional. Indicate the source of the conversation. If not set, all source
691
+ # will be searched.
692
+ class GetConversationRequest
693
+ include ::Google::Protobuf::MessageExts
694
+ extend ::Google::Protobuf::MessageExts::ClassMethods
695
+ end
696
+
697
+ # Request message for
698
+ # {::Google::Cloud::Ces::V1::AgentService::Client#delete_conversation AgentService.DeleteConversation}.
699
+ # @!attribute [rw] name
700
+ # @return [::String]
701
+ # Required. The resource name of the conversation to delete.
702
+ # @!attribute [rw] source
703
+ # @deprecated This field is deprecated and may be removed in the next major version update.
704
+ # @return [::Google::Cloud::Ces::V1::Conversation::Source]
705
+ # Optional. Indicate the source of the conversation. If not set, Source.Live
706
+ # will be applied by default.
707
+ class DeleteConversationRequest
708
+ include ::Google::Protobuf::MessageExts
709
+ extend ::Google::Protobuf::MessageExts::ClassMethods
710
+ end
711
+
712
+ # Request message for
713
+ # {::Google::Cloud::Ces::V1::AgentService::Client#batch_delete_conversations AgentService.BatchDeleteConversations}.
714
+ # @!attribute [rw] parent
715
+ # @return [::String]
716
+ # Required. The resource name of the app to delete conversations from.
717
+ # Format:
718
+ # `projects/{project}/locations/{location}/apps/{app}`
719
+ # @!attribute [rw] conversations
720
+ # @return [::Array<::String>]
721
+ # Required. The resource names of the conversations to delete.
722
+ class BatchDeleteConversationsRequest
723
+ include ::Google::Protobuf::MessageExts
724
+ extend ::Google::Protobuf::MessageExts::ClassMethods
725
+ end
726
+
727
+ # Response message for
728
+ # {::Google::Cloud::Ces::V1::AgentService::Client#batch_delete_conversations AgentService.BatchDeleteConversations}.
729
+ # @!attribute [rw] deleted_conversations
730
+ # @return [::Array<::String>]
731
+ # The list of conversations that were successfully deleted.
732
+ # @!attribute [rw] failed_conversations
733
+ # @return [::Array<::String>]
734
+ # The list of conversations that failed to be deleted.
735
+ # @!attribute [rw] error_messages
736
+ # @return [::Array<::String>]
737
+ # Optional. A list of error messages associated with conversations that
738
+ # failed to be deleted.
739
+ class BatchDeleteConversationsResponse
740
+ include ::Google::Protobuf::MessageExts
741
+ extend ::Google::Protobuf::MessageExts::ClassMethods
742
+ end
743
+
744
+ # Request message for
745
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_guardrails AgentService.ListGuardrails}.
746
+ # @!attribute [rw] parent
747
+ # @return [::String]
748
+ # Required. The resource name of the app to list guardrails from.
749
+ # @!attribute [rw] page_size
750
+ # @return [::Integer]
751
+ # Optional. Requested page size. Server may return fewer items than
752
+ # requested. If unspecified, server will pick an appropriate default.
753
+ # @!attribute [rw] page_token
754
+ # @return [::String]
755
+ # Optional. The
756
+ # {::Google::Cloud::Ces::V1::ListGuardrailsResponse#next_page_token next_page_token}
757
+ # value returned from a previous list
758
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_guardrails AgentService.ListGuardrails}
759
+ # call.
760
+ # @!attribute [rw] filter
761
+ # @return [::String]
762
+ # Optional. Filter to be applied when listing the guardrails.
763
+ # See https://google.aip.dev/160 for more details.
764
+ # @!attribute [rw] order_by
765
+ # @return [::String]
766
+ # Optional. Field to sort by. Only "name" and "create_time" is supported.
767
+ # See https://google.aip.dev/132#ordering for more details.
768
+ class ListGuardrailsRequest
769
+ include ::Google::Protobuf::MessageExts
770
+ extend ::Google::Protobuf::MessageExts::ClassMethods
771
+ end
772
+
773
+ # Response message for
774
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_guardrails AgentService.ListGuardrails}.
775
+ # @!attribute [rw] guardrails
776
+ # @return [::Array<::Google::Cloud::Ces::V1::Guardrail>]
777
+ # The list of guardrails.
778
+ # @!attribute [rw] next_page_token
779
+ # @return [::String]
780
+ # A token that can be sent as
781
+ # {::Google::Cloud::Ces::V1::ListGuardrailsRequest#page_token ListGuardrailsRequest.page_token}
782
+ # to retrieve the next page. Absence of this field indicates there are no
783
+ # subsequent pages.
784
+ class ListGuardrailsResponse
785
+ include ::Google::Protobuf::MessageExts
786
+ extend ::Google::Protobuf::MessageExts::ClassMethods
787
+ end
788
+
789
+ # Request message for
790
+ # {::Google::Cloud::Ces::V1::AgentService::Client#get_guardrail AgentService.GetGuardrail}.
791
+ # @!attribute [rw] name
792
+ # @return [::String]
793
+ # Required. The resource name of the guardrail to retrieve.
794
+ class GetGuardrailRequest
795
+ include ::Google::Protobuf::MessageExts
796
+ extend ::Google::Protobuf::MessageExts::ClassMethods
797
+ end
798
+
799
+ # Request message for
800
+ # {::Google::Cloud::Ces::V1::AgentService::Client#create_guardrail AgentService.CreateGuardrail}.
801
+ # @!attribute [rw] parent
802
+ # @return [::String]
803
+ # Required. The resource name of the app to create a guardrail in.
804
+ # @!attribute [rw] guardrail_id
805
+ # @return [::String]
806
+ # Optional. The ID to use for the guardrail, which will become the final
807
+ # component of the guardrail's resource name. If not provided, a unique ID
808
+ # will be automatically assigned for the guardrail.
809
+ # @!attribute [rw] guardrail
810
+ # @return [::Google::Cloud::Ces::V1::Guardrail]
811
+ # Required. The guardrail to create.
812
+ class CreateGuardrailRequest
813
+ include ::Google::Protobuf::MessageExts
814
+ extend ::Google::Protobuf::MessageExts::ClassMethods
815
+ end
816
+
817
+ # Request message for
818
+ # {::Google::Cloud::Ces::V1::AgentService::Client#update_guardrail AgentService.UpdateGuardrail}.
819
+ # @!attribute [rw] guardrail
820
+ # @return [::Google::Cloud::Ces::V1::Guardrail]
821
+ # Required. The guardrail to update.
822
+ # @!attribute [rw] update_mask
823
+ # @return [::Google::Protobuf::FieldMask]
824
+ # Optional. Field mask is used to control which fields get updated. If the
825
+ # mask is not present, all fields will be updated.
826
+ class UpdateGuardrailRequest
827
+ include ::Google::Protobuf::MessageExts
828
+ extend ::Google::Protobuf::MessageExts::ClassMethods
829
+ end
830
+
831
+ # Request message for
832
+ # {::Google::Cloud::Ces::V1::AgentService::Client#delete_guardrail AgentService.DeleteGuardrail}.
833
+ # @!attribute [rw] name
834
+ # @return [::String]
835
+ # Required. The resource name of the guardrail to delete.
836
+ # @!attribute [rw] force
837
+ # @return [::Boolean]
838
+ # Optional. Indicates whether to forcefully delete the guardrail, even if it
839
+ # is still referenced by app/agents.
840
+ #
841
+ # * If `force = false`, the deletion fails if any apps/agents still
842
+ # reference the guardrail.
843
+ # * If `force = true`, all existing references from apps/agents will be
844
+ # removed and the guardrail will be deleted.
845
+ # @!attribute [rw] etag
846
+ # @return [::String]
847
+ # Optional. The current etag of the guardrail. If an etag is not provided,
848
+ # the deletion will overwrite any concurrent changes. If an etag is provided
849
+ # and does not match the current etag of the guardrail, deletion will be
850
+ # blocked and an ABORTED error will be returned.
851
+ class DeleteGuardrailRequest
852
+ include ::Google::Protobuf::MessageExts
853
+ extend ::Google::Protobuf::MessageExts::ClassMethods
854
+ end
855
+
856
+ # Request message for
857
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_deployments AgentService.ListDeployments}.
858
+ # @!attribute [rw] parent
859
+ # @return [::String]
860
+ # Required. The parent app.
861
+ # Format:
862
+ # `projects/{project}/locations/{location}/apps/{app}`
863
+ # @!attribute [rw] page_size
864
+ # @return [::Integer]
865
+ # Optional. The maximum number of deployments to return. The service may
866
+ # return fewer than this value. If unspecified, at most 50 deployments will
867
+ # be returned. The maximum value is 1000; values above 1000 will be coerced
868
+ # to 1000.
869
+ # @!attribute [rw] page_token
870
+ # @return [::String]
871
+ # Optional. A page token, received from a previous `ListDeployments` call.
872
+ # Provide this to retrieve the subsequent page.
873
+ #
874
+ # When paginating, all other parameters provided to `ListDeployments` must
875
+ # match the call that provided the page token.
876
+ # @!attribute [rw] order_by
877
+ # @return [::String]
878
+ # Optional. Field to sort by. Only "name" and "create_time" is supported.
879
+ # See https://google.aip.dev/132#ordering for more details.
880
+ class ListDeploymentsRequest
881
+ include ::Google::Protobuf::MessageExts
882
+ extend ::Google::Protobuf::MessageExts::ClassMethods
883
+ end
884
+
885
+ # Response message for
886
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_deployments AgentService.ListDeployments}.
887
+ # @!attribute [rw] deployments
888
+ # @return [::Array<::Google::Cloud::Ces::V1::Deployment>]
889
+ # The list of deployments.
890
+ # @!attribute [rw] next_page_token
891
+ # @return [::String]
892
+ # A token, which can be sent as `page_token` to retrieve the next page.
893
+ # If this field is omitted, there are no subsequent pages.
894
+ class ListDeploymentsResponse
895
+ include ::Google::Protobuf::MessageExts
896
+ extend ::Google::Protobuf::MessageExts::ClassMethods
897
+ end
898
+
899
+ # Request message for
900
+ # {::Google::Cloud::Ces::V1::AgentService::Client#get_deployment AgentService.GetDeployment}.
901
+ # @!attribute [rw] name
902
+ # @return [::String]
903
+ # Required. The name of the deployment.
904
+ # Format:
905
+ # `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
906
+ class GetDeploymentRequest
907
+ include ::Google::Protobuf::MessageExts
908
+ extend ::Google::Protobuf::MessageExts::ClassMethods
909
+ end
910
+
911
+ # Request message for
912
+ # {::Google::Cloud::Ces::V1::AgentService::Client#create_deployment AgentService.CreateDeployment}.
913
+ # @!attribute [rw] parent
914
+ # @return [::String]
915
+ # Required. The parent app.
916
+ # Format:
917
+ # `projects/{project}/locations/{location}/apps/{app}`
918
+ # @!attribute [rw] deployment_id
919
+ # @return [::String]
920
+ # Optional. The ID to use for the deployment, which will become the final
921
+ # component of the deployment's resource name. If not provided, a unique ID
922
+ # will be automatically assigned for the deployment.
923
+ # @!attribute [rw] deployment
924
+ # @return [::Google::Cloud::Ces::V1::Deployment]
925
+ # Required. The deployment to create.
926
+ class CreateDeploymentRequest
927
+ include ::Google::Protobuf::MessageExts
928
+ extend ::Google::Protobuf::MessageExts::ClassMethods
929
+ end
930
+
931
+ # Request message for
932
+ # {::Google::Cloud::Ces::V1::AgentService::Client#update_deployment AgentService.UpdateDeployment}.
933
+ # @!attribute [rw] deployment
934
+ # @return [::Google::Cloud::Ces::V1::Deployment]
935
+ # Required. The deployment to update.
936
+ # @!attribute [rw] update_mask
937
+ # @return [::Google::Protobuf::FieldMask]
938
+ # Optional. The list of fields to update.
939
+ class UpdateDeploymentRequest
940
+ include ::Google::Protobuf::MessageExts
941
+ extend ::Google::Protobuf::MessageExts::ClassMethods
942
+ end
943
+
944
+ # Request message for
945
+ # {::Google::Cloud::Ces::V1::AgentService::Client#delete_deployment AgentService.DeleteDeployment}.
946
+ # @!attribute [rw] name
947
+ # @return [::String]
948
+ # Required. The name of the deployment to delete.
949
+ # Format:
950
+ # `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
951
+ # @!attribute [rw] etag
952
+ # @return [::String]
953
+ # Optional. The etag of the deployment.
954
+ # If an etag is provided and does not match the current etag of the
955
+ # deployment, deletion will be blocked and an ABORTED error will be returned.
956
+ class DeleteDeploymentRequest
957
+ include ::Google::Protobuf::MessageExts
958
+ extend ::Google::Protobuf::MessageExts::ClassMethods
959
+ end
960
+
961
+ # Request message for
962
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_toolsets AgentService.ListToolsets}.
963
+ # @!attribute [rw] parent
964
+ # @return [::String]
965
+ # Required. The resource name of the app to list toolsets from.
966
+ # @!attribute [rw] page_size
967
+ # @return [::Integer]
968
+ # Optional. Requested page size. Server may return fewer items than
969
+ # requested. If unspecified, server will pick an appropriate default.
970
+ # @!attribute [rw] page_token
971
+ # @return [::String]
972
+ # Optional. The
973
+ # {::Google::Cloud::Ces::V1::ListToolsetsResponse#next_page_token next_page_token}
974
+ # value returned from a previous list
975
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_toolsets AgentService.ListToolsets}
976
+ # call.
977
+ # @!attribute [rw] filter
978
+ # @return [::String]
979
+ # Optional. Filter to be applied when listing the toolsets.
980
+ # See https://google.aip.dev/160 for more details.
981
+ # @!attribute [rw] order_by
982
+ # @return [::String]
983
+ # Optional. Field to sort by. Only "name" and "create_time" is supported.
984
+ # See https://google.aip.dev/132#ordering for more details.
985
+ class ListToolsetsRequest
986
+ include ::Google::Protobuf::MessageExts
987
+ extend ::Google::Protobuf::MessageExts::ClassMethods
988
+ end
989
+
990
+ # Response message for
991
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_toolsets AgentService.ListToolsets}.
992
+ # @!attribute [rw] toolsets
993
+ # @return [::Array<::Google::Cloud::Ces::V1::Toolset>]
994
+ # The list of toolsets.
995
+ # @!attribute [rw] next_page_token
996
+ # @return [::String]
997
+ # A token that can be sent as
998
+ # {::Google::Cloud::Ces::V1::ListToolsetsRequest#page_token ListToolsetsRequest.page_token}
999
+ # to retrieve the next page. Absence of this field indicates there are no
1000
+ # subsequent pages.
1001
+ class ListToolsetsResponse
1002
+ include ::Google::Protobuf::MessageExts
1003
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1004
+ end
1005
+
1006
+ # Request message for
1007
+ # {::Google::Cloud::Ces::V1::AgentService::Client#get_toolset AgentService.GetToolset}.
1008
+ # @!attribute [rw] name
1009
+ # @return [::String]
1010
+ # Required. The resource name of the toolset to retrieve.
1011
+ class GetToolsetRequest
1012
+ include ::Google::Protobuf::MessageExts
1013
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1014
+ end
1015
+
1016
+ # Request message for
1017
+ # {::Google::Cloud::Ces::V1::AgentService::Client#create_toolset AgentService.CreateToolset}.
1018
+ # @!attribute [rw] parent
1019
+ # @return [::String]
1020
+ # Required. The resource name of the app to create a toolset in.
1021
+ # @!attribute [rw] toolset_id
1022
+ # @return [::String]
1023
+ # Optional. The ID to use for the toolset, which will become the final
1024
+ # component of the toolset's resource name. If not provided, a unique ID will
1025
+ # be automatically assigned for the toolset.
1026
+ # @!attribute [rw] toolset
1027
+ # @return [::Google::Cloud::Ces::V1::Toolset]
1028
+ # Required. The toolset to create.
1029
+ class CreateToolsetRequest
1030
+ include ::Google::Protobuf::MessageExts
1031
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1032
+ end
1033
+
1034
+ # Request message for
1035
+ # {::Google::Cloud::Ces::V1::AgentService::Client#update_toolset AgentService.UpdateToolset}.
1036
+ # @!attribute [rw] toolset
1037
+ # @return [::Google::Cloud::Ces::V1::Toolset]
1038
+ # Required. The toolset to update.
1039
+ # @!attribute [rw] update_mask
1040
+ # @return [::Google::Protobuf::FieldMask]
1041
+ # Optional. Field mask is used to control which fields get updated. If the
1042
+ # mask is not present, all fields will be updated.
1043
+ class UpdateToolsetRequest
1044
+ include ::Google::Protobuf::MessageExts
1045
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1046
+ end
1047
+
1048
+ # Request message for
1049
+ # {::Google::Cloud::Ces::V1::AgentService::Client#delete_toolset AgentService.DeleteToolset}.
1050
+ # @!attribute [rw] name
1051
+ # @return [::String]
1052
+ # Required. The resource name of the toolset to delete.
1053
+ # @!attribute [rw] force
1054
+ # @return [::Boolean]
1055
+ # Optional. Indicates whether to forcefully delete the toolset, even if it is
1056
+ # still referenced by app/agents.
1057
+ #
1058
+ # * If `force = false`, the deletion fails if any agents still
1059
+ # reference the toolset.
1060
+ # * If `force = true`, all existing references from agents will be
1061
+ # removed and the toolset will be deleted.
1062
+ # @!attribute [rw] etag
1063
+ # @return [::String]
1064
+ # Optional. The current etag of the toolset. If an etag is not provided, the
1065
+ # deletion will overwrite any concurrent changes. If an etag is provided and
1066
+ # does not match the current etag of the toolset, deletion will be blocked
1067
+ # and an ABORTED error will be returned.
1068
+ class DeleteToolsetRequest
1069
+ include ::Google::Protobuf::MessageExts
1070
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1071
+ end
1072
+
1073
+ # Request message for
1074
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_app_versions AgentService.ListAppVersions}.
1075
+ # @!attribute [rw] parent
1076
+ # @return [::String]
1077
+ # Required. The resource name of the app to list app versions from.
1078
+ # @!attribute [rw] page_size
1079
+ # @return [::Integer]
1080
+ # Optional. Requested page size. Server may return fewer items than
1081
+ # requested. If unspecified, server will pick an appropriate default.
1082
+ # @!attribute [rw] page_token
1083
+ # @return [::String]
1084
+ # Optional. The
1085
+ # {::Google::Cloud::Ces::V1::ListAppVersionsResponse#next_page_token next_page_token}
1086
+ # value returned from a previous list
1087
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_app_versions AgentService.ListAppVersions}
1088
+ # call.
1089
+ # @!attribute [rw] filter
1090
+ # @return [::String]
1091
+ # Optional. Filter to be applied when listing the app versions.
1092
+ # See https://google.aip.dev/160 for more details.
1093
+ # @!attribute [rw] order_by
1094
+ # @return [::String]
1095
+ # Optional. Field to sort by. Only "name" and "create_time" is supported.
1096
+ # See https://google.aip.dev/132#ordering for more details.
1097
+ class ListAppVersionsRequest
1098
+ include ::Google::Protobuf::MessageExts
1099
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1100
+ end
1101
+
1102
+ # Response message for
1103
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_app_versions AgentService.ListAppVersions}.
1104
+ # @!attribute [rw] app_versions
1105
+ # @return [::Array<::Google::Cloud::Ces::V1::AppVersion>]
1106
+ # The list of app versions.
1107
+ # @!attribute [rw] next_page_token
1108
+ # @return [::String]
1109
+ # A token that can be sent as
1110
+ # {::Google::Cloud::Ces::V1::ListAppVersionsRequest#page_token ListAppVersionsRequest.page_token}
1111
+ # to retrieve the next page. Absence of this field indicates there are no
1112
+ # subsequent pages.
1113
+ class ListAppVersionsResponse
1114
+ include ::Google::Protobuf::MessageExts
1115
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1116
+ end
1117
+
1118
+ # Request message for
1119
+ # {::Google::Cloud::Ces::V1::AgentService::Client#get_app_version AgentService.GetAppVersion}.
1120
+ # @!attribute [rw] name
1121
+ # @return [::String]
1122
+ # Required. The resource name of the app version to retrieve.
1123
+ class GetAppVersionRequest
1124
+ include ::Google::Protobuf::MessageExts
1125
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1126
+ end
1127
+
1128
+ # Request message for
1129
+ # {::Google::Cloud::Ces::V1::AgentService::Client#delete_app_version AgentService.DeleteAppVersion}.
1130
+ # @!attribute [rw] name
1131
+ # @return [::String]
1132
+ # Required. The resource name of the app version to delete.
1133
+ # @!attribute [rw] etag
1134
+ # @return [::String]
1135
+ # Optional. The current etag of the app version. If an etag is not provided,
1136
+ # the deletion will overwrite any concurrent changes. If an etag is provided
1137
+ # and does not match the current etag of the app version, deletion will be
1138
+ # blocked and an ABORTED error will be returned.
1139
+ class DeleteAppVersionRequest
1140
+ include ::Google::Protobuf::MessageExts
1141
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1142
+ end
1143
+
1144
+ # Request message for
1145
+ # {::Google::Cloud::Ces::V1::AgentService::Client#create_app_version AgentService.CreateAppVersion}
1146
+ # @!attribute [rw] parent
1147
+ # @return [::String]
1148
+ # Required. The resource name of the app to create an app version in.
1149
+ # @!attribute [rw] app_version_id
1150
+ # @return [::String]
1151
+ # Optional. The ID to use for the app version, which will become the final
1152
+ # component of the app version's resource name. If not provided, a unique ID
1153
+ # will be automatically assigned for the app version.
1154
+ # @!attribute [rw] app_version
1155
+ # @return [::Google::Cloud::Ces::V1::AppVersion]
1156
+ # Required. The app version to create.
1157
+ class CreateAppVersionRequest
1158
+ include ::Google::Protobuf::MessageExts
1159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1160
+ end
1161
+
1162
+ # Request message for
1163
+ # {::Google::Cloud::Ces::V1::AgentService::Client#restore_app_version AgentService.RestoreAppVersion}
1164
+ # @!attribute [rw] name
1165
+ # @return [::String]
1166
+ # Required. The resource name of the app version to restore.
1167
+ class RestoreAppVersionRequest
1168
+ include ::Google::Protobuf::MessageExts
1169
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1170
+ end
1171
+
1172
+ # Response message for
1173
+ # {::Google::Cloud::Ces::V1::AgentService::Client#restore_app_version AgentService.RestoreAppVersion}
1174
+ class RestoreAppVersionResponse
1175
+ include ::Google::Protobuf::MessageExts
1176
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1177
+ end
1178
+
1179
+ # Request message for
1180
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_changelogs AgentService.ListChangelogs}.
1181
+ # @!attribute [rw] parent
1182
+ # @return [::String]
1183
+ # Required. The resource name of the app to list changelogs from.
1184
+ # @!attribute [rw] page_size
1185
+ # @return [::Integer]
1186
+ # Optional. Requested page size. Server may return fewer items than
1187
+ # requested. If unspecified, server will pick an appropriate default.
1188
+ # @!attribute [rw] page_token
1189
+ # @return [::String]
1190
+ # Optional. The
1191
+ # {::Google::Cloud::Ces::V1::ListChangelogsResponse#next_page_token next_page_token}
1192
+ # value returned from a previous list
1193
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_changelogs AgentService.ListChangelogs}
1194
+ # call.
1195
+ # @!attribute [rw] filter
1196
+ # @return [::String]
1197
+ # Optional. Filter to be applied when listing the changelogs.
1198
+ # See https://google.aip.dev/160 for more details.
1199
+ #
1200
+ # The filter string can be used to filter by `action`, `resource_type`,
1201
+ # `resource_name`, `author`, and `create_time`.
1202
+ # The `:` comparator can be used for case-insensitive partial matching on
1203
+ # string fields, while `=` performs an exact case-sensitive match.
1204
+ #
1205
+ # Examples:
1206
+ # * `action:update` (case-insensitive partial match)
1207
+ # * `action="Create"` (case-sensitive exact match)
1208
+ # * `resource_type:agent`
1209
+ # * `resource_name:my-agent`
1210
+ # * `author:me@example.com`
1211
+ # * `create_time > "2025-01-01T00:00:00Z"`
1212
+ # * `create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool`
1213
+ # @!attribute [rw] order_by
1214
+ # @return [::String]
1215
+ # Optional. Field to sort by. Only "name" and "create_time" is supported.
1216
+ # See https://google.aip.dev/132#ordering for more details.
1217
+ class ListChangelogsRequest
1218
+ include ::Google::Protobuf::MessageExts
1219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1220
+ end
1221
+
1222
+ # Response message for
1223
+ # {::Google::Cloud::Ces::V1::AgentService::Client#list_changelogs AgentService.ListChangelogs}.
1224
+ # @!attribute [rw] changelogs
1225
+ # @return [::Array<::Google::Cloud::Ces::V1::Changelog>]
1226
+ # The list of changelogs.
1227
+ # @!attribute [rw] next_page_token
1228
+ # @return [::String]
1229
+ # A token that can be sent as
1230
+ # {::Google::Cloud::Ces::V1::ListChangelogsRequest#page_token ListChangelogsRequest.page_token}
1231
+ # to retrieve the next page. Absence of this field indicates there are no
1232
+ # subsequent pages.
1233
+ class ListChangelogsResponse
1234
+ include ::Google::Protobuf::MessageExts
1235
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1236
+ end
1237
+
1238
+ # Request message for
1239
+ # {::Google::Cloud::Ces::V1::AgentService::Client#get_changelog AgentService.GetChangelog}.
1240
+ # @!attribute [rw] name
1241
+ # @return [::String]
1242
+ # Required. The resource name of the changelog to retrieve.
1243
+ class GetChangelogRequest
1244
+ include ::Google::Protobuf::MessageExts
1245
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1246
+ end
1247
+ end
1248
+ end
1249
+ end
1250
+ end