google-cloud-discovery_engine-v1 2.2.0 → 2.3.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 (87) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +4 -4
  4. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/client.rb +803 -0
  5. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/credentials.rb +47 -0
  6. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/operations.rb +813 -0
  7. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/paths.rb +135 -0
  8. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/client.rb +749 -0
  9. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/operations.rb +1148 -0
  10. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/service_stub.rb +341 -0
  11. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/rest.rb +53 -0
  12. data/lib/google/cloud/discovery_engine/v1/cmek_config_service.rb +56 -0
  13. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +8 -0
  14. data/lib/google/cloud/discovery_engine/v1/control_service/paths.rb +53 -0
  15. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +11 -1
  16. data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +104 -0
  17. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +11 -1
  18. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +8 -0
  19. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +8 -0
  20. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +8 -0
  21. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/client.rb +1160 -0
  22. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/credentials.rb +47 -0
  23. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/operations.rb +813 -0
  24. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/paths.rb +154 -0
  25. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/client.rb +1085 -0
  26. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/operations.rb +1148 -0
  27. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/service_stub.rb +511 -0
  28. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest.rb +53 -0
  29. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service.rb +56 -0
  30. data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +8 -0
  31. data/lib/google/cloud/discovery_engine/v1/rest.rb +4 -1
  32. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +8 -0
  33. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/operations.rb +8 -0
  34. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +8 -0
  35. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +8 -0
  36. data/lib/google/cloud/discovery_engine/v1/user_license_service/client.rb +630 -0
  37. data/lib/google/cloud/discovery_engine/v1/user_license_service/credentials.rb +47 -0
  38. data/lib/google/cloud/discovery_engine/v1/user_license_service/operations.rb +813 -0
  39. data/lib/google/cloud/discovery_engine/v1/user_license_service/paths.rb +71 -0
  40. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/client.rb +590 -0
  41. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/operations.rb +1148 -0
  42. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/service_stub.rb +204 -0
  43. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest.rb +53 -0
  44. data/lib/google/cloud/discovery_engine/v1/user_license_service.rb +56 -0
  45. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  46. data/lib/google/cloud/discovery_engine/v1.rb +5 -2
  47. data/lib/google/cloud/discoveryengine/v1/answer_pb.rb +1 -1
  48. data/lib/google/cloud/discoveryengine/v1/chunk_pb.rb +4 -1
  49. data/lib/google/cloud/discoveryengine/v1/cmek_config_service_pb.rb +61 -0
  50. data/lib/google/cloud/discoveryengine/v1/cmek_config_service_services_pb.rb +55 -0
  51. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +3 -1
  52. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +1 -1
  53. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +4 -1
  54. data/lib/google/cloud/discoveryengine/v1/data_store_service_pb.rb +1 -1
  55. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +5 -1
  56. data/lib/google/cloud/discoveryengine/v1/document_processing_config_pb.rb +1 -1
  57. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +7 -1
  58. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +1 -1
  59. data/lib/google/cloud/discoveryengine/v1/grounding_pb.rb +1 -1
  60. data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_pb.rb +48 -0
  61. data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_service_pb.rb +68 -0
  62. data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_service_services_pb.rb +58 -0
  63. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +1 -1
  64. data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +1 -1
  65. data/lib/google/cloud/discoveryengine/v1/user_license_pb.rb +48 -0
  66. data/lib/google/cloud/discoveryengine/v1/user_license_service_pb.rb +61 -0
  67. data/lib/google/cloud/discoveryengine/v1/user_license_service_services_pb.rb +48 -0
  68. data/proto_docs/google/cloud/discoveryengine/v1/answer.rb +17 -0
  69. data/proto_docs/google/cloud/discoveryengine/v1/chunk.rb +54 -0
  70. data/proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb +222 -0
  71. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +55 -0
  72. data/proto_docs/google/cloud/discoveryengine/v1/control.rb +1 -3
  73. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +3 -0
  74. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +43 -1
  75. data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +12 -0
  76. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +99 -4
  77. data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +23 -0
  78. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +141 -5
  79. data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +8 -0
  80. data/proto_docs/google/cloud/discoveryengine/v1/grounding.rb +9 -0
  81. data/proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store.rb +81 -0
  82. data/proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store_service.rb +279 -0
  83. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +6 -0
  84. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +6 -0
  85. data/proto_docs/google/cloud/discoveryengine/v1/user_license.rb +85 -0
  86. data/proto_docs/google/cloud/discoveryengine/v1/user_license_service.rb +153 -0
  87. metadata +42 -2
@@ -0,0 +1,279 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 DiscoveryEngine
23
+ module V1
24
+ # Request message for
25
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#create_identity_mapping_store IdentityMappingStoreService.CreateIdentityMappingStore}
26
+ # @!attribute [rw] cmek_config_name
27
+ # @return [::String]
28
+ # Resource name of the CmekConfig to use for protecting this Identity
29
+ # Mapping Store.
30
+ #
31
+ # Note: The following fields are mutually exclusive: `cmek_config_name`, `disable_cmek`. If a field in that set is populated, all other fields in the set will automatically be cleared.
32
+ # @!attribute [rw] disable_cmek
33
+ # @return [::Boolean]
34
+ # Identity Mapping Store without CMEK protections. If a default CmekConfig
35
+ # is set for the project, setting this field will override the default
36
+ # CmekConfig as well.
37
+ #
38
+ # Note: The following fields are mutually exclusive: `disable_cmek`, `cmek_config_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.
39
+ # @!attribute [rw] parent
40
+ # @return [::String]
41
+ # Required. The parent collection resource name, such as
42
+ # `projects/{project}/locations/{location}`.
43
+ # @!attribute [rw] identity_mapping_store_id
44
+ # @return [::String]
45
+ # Required. The ID of the Identity Mapping Store to create.
46
+ #
47
+ # The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
48
+ # (_), and hyphens (-). The maximum length is 63 characters.
49
+ # @!attribute [rw] identity_mapping_store
50
+ # @return [::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore]
51
+ # Required. The Identity Mapping Store to create.
52
+ class CreateIdentityMappingStoreRequest
53
+ include ::Google::Protobuf::MessageExts
54
+ extend ::Google::Protobuf::MessageExts::ClassMethods
55
+ end
56
+
57
+ # Request message for
58
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#get_identity_mapping_store IdentityMappingStoreService.GetIdentityMappingStore}
59
+ # @!attribute [rw] name
60
+ # @return [::String]
61
+ # Required. The name of the Identity Mapping Store to get.
62
+ # Format:
63
+ # `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
64
+ class GetIdentityMappingStoreRequest
65
+ include ::Google::Protobuf::MessageExts
66
+ extend ::Google::Protobuf::MessageExts::ClassMethods
67
+ end
68
+
69
+ # Request message for
70
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#delete_identity_mapping_store IdentityMappingStoreService.DeleteIdentityMappingStore}
71
+ # @!attribute [rw] name
72
+ # @return [::String]
73
+ # Required. The name of the Identity Mapping Store to delete.
74
+ # Format:
75
+ # `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
76
+ class DeleteIdentityMappingStoreRequest
77
+ include ::Google::Protobuf::MessageExts
78
+ extend ::Google::Protobuf::MessageExts::ClassMethods
79
+ end
80
+
81
+ # Request message for
82
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#import_identity_mappings IdentityMappingStoreService.ImportIdentityMappings}
83
+ # @!attribute [rw] inline_source
84
+ # @return [::Google::Cloud::DiscoveryEngine::V1::ImportIdentityMappingsRequest::InlineSource]
85
+ # The inline source to import identity mapping entries from.
86
+ # @!attribute [rw] identity_mapping_store
87
+ # @return [::String]
88
+ # Required. The name of the Identity Mapping Store to import Identity Mapping
89
+ # Entries to. Format:
90
+ # `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
91
+ class ImportIdentityMappingsRequest
92
+ include ::Google::Protobuf::MessageExts
93
+ extend ::Google::Protobuf::MessageExts::ClassMethods
94
+
95
+ # The inline source to import identity mapping entries from.
96
+ # @!attribute [rw] identity_mapping_entries
97
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>]
98
+ # A maximum of 10000 entries can be imported at one time
99
+ class InlineSource
100
+ include ::Google::Protobuf::MessageExts
101
+ extend ::Google::Protobuf::MessageExts::ClassMethods
102
+ end
103
+ end
104
+
105
+ # Response message for
106
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#import_identity_mappings IdentityMappingStoreService.ImportIdentityMappings}
107
+ # @!attribute [rw] error_samples
108
+ # @return [::Array<::Google::Rpc::Status>]
109
+ # A sample of errors encountered while processing the request.
110
+ class ImportIdentityMappingsResponse
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
+ end
114
+
115
+ # Request message for
116
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#purge_identity_mappings IdentityMappingStoreService.PurgeIdentityMappings}
117
+ # @!attribute [rw] inline_source
118
+ # @return [::Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest::InlineSource]
119
+ # The inline source to purge identity mapping entries from.
120
+ # @!attribute [rw] identity_mapping_store
121
+ # @return [::String]
122
+ # Required. The name of the Identity Mapping Store to purge Identity Mapping
123
+ # Entries from. Format:
124
+ # `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
125
+ # @!attribute [rw] filter
126
+ # @return [::String]
127
+ # Filter matching identity mappings to purge.
128
+ # The eligible field for filtering is:
129
+ # * `update_time`: in ISO 8601 "zulu" format.
130
+ # * `external_id`
131
+ #
132
+ # Examples:
133
+ #
134
+ # * Deleting all identity mappings updated in a time range:
135
+ # `update_time > "2012-04-23T18:25:43.511Z" AND update_time <
136
+ # "2012-04-23T18:30:43.511Z"`
137
+ # * Deleting all identity mappings for a given external_id:
138
+ # `external_id = "id1"`
139
+ # * Deleting all identity mappings inside an identity mapping store:
140
+ # `*`
141
+ #
142
+ # The filtering fields are assumed to have an implicit AND.
143
+ # Should not be used with source. An error will be thrown, if both are
144
+ # provided.
145
+ # @!attribute [rw] force
146
+ # @return [::Boolean]
147
+ # Actually performs the purge. If `force` is set to false, return the
148
+ # expected purge count without deleting any identity mappings. This field is
149
+ # only supported for purge with filter. For input source this field is
150
+ # ignored and data will be purged regardless of the value of this field.
151
+ class PurgeIdentityMappingsRequest
152
+ include ::Google::Protobuf::MessageExts
153
+ extend ::Google::Protobuf::MessageExts::ClassMethods
154
+
155
+ # The inline source to purge identity mapping entries from.
156
+ # @!attribute [rw] identity_mapping_entries
157
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>]
158
+ # A maximum of 10000 entries can be purged at one time
159
+ class InlineSource
160
+ include ::Google::Protobuf::MessageExts
161
+ extend ::Google::Protobuf::MessageExts::ClassMethods
162
+ end
163
+ end
164
+
165
+ # Request message for
166
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#list_identity_mappings IdentityMappingStoreService.ListIdentityMappings}
167
+ # @!attribute [rw] identity_mapping_store
168
+ # @return [::String]
169
+ # Required. The name of the Identity Mapping Store to list Identity Mapping
170
+ # Entries in. Format:
171
+ # `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
172
+ # @!attribute [rw] page_size
173
+ # @return [::Integer]
174
+ # Maximum number of IdentityMappings to return. If unspecified, defaults
175
+ # to 2000. The maximum allowed value is 10000. Values above 10000 will be
176
+ # coerced to 10000.
177
+ # @!attribute [rw] page_token
178
+ # @return [::String]
179
+ # A page token, received from a previous `ListIdentityMappings` call.
180
+ # Provide this to retrieve the subsequent page.
181
+ #
182
+ # When paginating, all other parameters provided to
183
+ # `ListIdentityMappings` must match the call that provided the page
184
+ # token.
185
+ class ListIdentityMappingsRequest
186
+ include ::Google::Protobuf::MessageExts
187
+ extend ::Google::Protobuf::MessageExts::ClassMethods
188
+ end
189
+
190
+ # Response message for
191
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#list_identity_mappings IdentityMappingStoreService.ListIdentityMappings}
192
+ # @!attribute [rw] identity_mapping_entries
193
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingEntry>]
194
+ # The Identity Mapping Entries.
195
+ # @!attribute [rw] next_page_token
196
+ # @return [::String]
197
+ # A token that can be sent as `page_token` to retrieve the next page. If this
198
+ # field is omitted, there are no subsequent pages.
199
+ class ListIdentityMappingsResponse
200
+ include ::Google::Protobuf::MessageExts
201
+ extend ::Google::Protobuf::MessageExts::ClassMethods
202
+ end
203
+
204
+ # Request message for
205
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#list_identity_mapping_stores IdentityMappingStoreService.ListIdentityMappingStores}
206
+ # @!attribute [rw] parent
207
+ # @return [::String]
208
+ # Required. The parent of the Identity Mapping Stores to list.
209
+ # Format:
210
+ # `projects/{project}/locations/{location}`.
211
+ # @!attribute [rw] page_size
212
+ # @return [::Integer]
213
+ # Maximum number of IdentityMappingStores to return. If unspecified, defaults
214
+ # to 100. The maximum allowed value is 1000. Values above 1000 will be
215
+ # coerced to 1000.
216
+ # @!attribute [rw] page_token
217
+ # @return [::String]
218
+ # A page token, received from a previous `ListIdentityMappingStores` call.
219
+ # Provide this to retrieve the subsequent page.
220
+ #
221
+ # When paginating, all other parameters provided to
222
+ # `ListIdentityMappingStores` must match the call that provided the page
223
+ # token.
224
+ class ListIdentityMappingStoresRequest
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Response message for
230
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#list_identity_mapping_stores IdentityMappingStoreService.ListIdentityMappingStores}
231
+ # @!attribute [rw] identity_mapping_stores
232
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore>]
233
+ # The Identity Mapping Stores.
234
+ # @!attribute [rw] next_page_token
235
+ # @return [::String]
236
+ # A token that can be sent as `page_token` to retrieve the next page. If this
237
+ # field is omitted, there are no subsequent pages.
238
+ class ListIdentityMappingStoresResponse
239
+ include ::Google::Protobuf::MessageExts
240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
241
+ end
242
+
243
+ # IdentityMappingEntry LongRunningOperation metadata for
244
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#import_identity_mappings IdentityMappingStoreService.ImportIdentityMappings}
245
+ # and
246
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#purge_identity_mappings IdentityMappingStoreService.PurgeIdentityMappings}
247
+ # @!attribute [rw] success_count
248
+ # @return [::Integer]
249
+ # The number of IdentityMappingEntries that were successfully processed.
250
+ # @!attribute [rw] failure_count
251
+ # @return [::Integer]
252
+ # The number of IdentityMappingEntries that failed to be processed.
253
+ # @!attribute [rw] total_count
254
+ # @return [::Integer]
255
+ # The total number of IdentityMappingEntries that were processed.
256
+ class IdentityMappingEntryOperationMetadata
257
+ include ::Google::Protobuf::MessageExts
258
+ extend ::Google::Protobuf::MessageExts::ClassMethods
259
+ end
260
+
261
+ # Metadata related to the progress of the
262
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStoreService::Client#delete_identity_mapping_store IdentityMappingStoreService.DeleteIdentityMappingStore}
263
+ # operation. This will be returned by the google.longrunning.Operation.metadata
264
+ # field.
265
+ # @!attribute [rw] create_time
266
+ # @return [::Google::Protobuf::Timestamp]
267
+ # Operation create time.
268
+ # @!attribute [rw] update_time
269
+ # @return [::Google::Protobuf::Timestamp]
270
+ # Operation last update time. If the operation is done, this is also the
271
+ # finish time.
272
+ class DeleteIdentityMappingStoreMetadata
273
+ include ::Google::Protobuf::MessageExts
274
+ extend ::Google::Protobuf::MessageExts::ClassMethods
275
+ end
276
+ end
277
+ end
278
+ end
279
+ end
@@ -312,6 +312,12 @@ module Google
312
312
  # Optional. Boost specification to boost certain documents.
313
313
  # For more information on boosting, see
314
314
  # [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
315
+ # @!attribute [rw] custom_search_operators
316
+ # @return [::String]
317
+ # Optional. Custom search operators which if specified will be used to
318
+ # filter results from workspace data stores. For more information on custom
319
+ # search operators, see
320
+ # [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
315
321
  class DataStoreSpec
316
322
  include ::Google::Protobuf::MessageExts
317
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -128,6 +128,12 @@ module Google
128
128
  # 1. target site deleted if unindexing is successful;
129
129
  # 2. state reverts to SUCCEEDED if the unindexing fails.
130
130
  DELETING = 4
131
+
132
+ # The target site change is pending but cancellable.
133
+ CANCELLABLE = 5
134
+
135
+ # The target site change is cancelled.
136
+ CANCELLED = 6
131
137
  end
132
138
  end
133
139
 
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 DiscoveryEngine
23
+ module V1
24
+ # User License information assigned by the admin.
25
+ # @!attribute [rw] user_principal
26
+ # @return [::String]
27
+ # Required. Immutable. The user principal of the User, could be email address
28
+ # or other prinical identifier. This field is immutable. Admin assign
29
+ # licenses based on the user principal.
30
+ # @!attribute [rw] user_profile
31
+ # @return [::String]
32
+ # Optional. The user profile.
33
+ # We user user full name(First name + Last name) as user profile.
34
+ # @!attribute [r] license_assignment_state
35
+ # @return [::Google::Cloud::DiscoveryEngine::V1::UserLicense::LicenseAssignmentState]
36
+ # Output only. License assignment state of the user.
37
+ # If the user is assigned with a license config, the user loggin will be
38
+ # assigned with the license;
39
+ # If the user's license assignment state is unassigned or unspecified, no
40
+ # license config will be associated to the user;
41
+ # @!attribute [rw] license_config
42
+ # @return [::String]
43
+ # Optional. The full resource name of the Subscription(LicenseConfig)
44
+ # assigned to the user.
45
+ # @!attribute [r] create_time
46
+ # @return [::Google::Protobuf::Timestamp]
47
+ # Output only. User created timestamp.
48
+ # @!attribute [r] update_time
49
+ # @return [::Google::Protobuf::Timestamp]
50
+ # Output only. User update timestamp.
51
+ # @!attribute [r] last_login_time
52
+ # @return [::Google::Protobuf::Timestamp]
53
+ # Output only. User last logged in time.
54
+ # If the user has not logged in yet, this field will be empty.
55
+ class UserLicense
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+
59
+ # License assignment state enumeration.
60
+ module LicenseAssignmentState
61
+ # Default value.
62
+ LICENSE_ASSIGNMENT_STATE_UNSPECIFIED = 0
63
+
64
+ # License assigned to the user.
65
+ ASSIGNED = 1
66
+
67
+ # No license assigned to the user.
68
+ # Deprecated, translated to NO_LICENSE.
69
+ UNASSIGNED = 2
70
+
71
+ # No license assigned to the user.
72
+ NO_LICENSE = 3
73
+
74
+ # User attempted to login but no license assigned to the user.
75
+ # This state is only used for no user first time login attempt but cannot
76
+ # get license assigned.
77
+ # Users already logged in but cannot get license assigned will be assigned
78
+ # NO_LICENSE state(License could be unassigned by admin).
79
+ NO_LICENSE_ATTEMPTED_LOGIN = 4
80
+ end
81
+ end
82
+ end
83
+ end
84
+ end
85
+ end
@@ -0,0 +1,153 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 DiscoveryEngine
23
+ module V1
24
+ # Request message for
25
+ # {::Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client#list_user_licenses UserLicenseService.ListUserLicenses}.
26
+ # @!attribute [rw] parent
27
+ # @return [::String]
28
+ # Required. The parent [UserStore][] resource name, format:
29
+ # `projects/{project}/locations/{location}/userStores/{user_store_id}`.
30
+ # @!attribute [rw] page_size
31
+ # @return [::Integer]
32
+ # Optional. Requested page size. Server may return fewer items than
33
+ # requested. If unspecified, defaults to 10. The maximum value is 50; values
34
+ # above 50 will be coerced to 50.
35
+ #
36
+ # If this field is negative, an INVALID_ARGUMENT error is returned.
37
+ # @!attribute [rw] page_token
38
+ # @return [::String]
39
+ # Optional. A page token, received from a previous `ListUserLicenses` call.
40
+ # Provide this to retrieve the subsequent page.
41
+ #
42
+ # When paginating, all other parameters provided to `ListUserLicenses`
43
+ # must match the call that provided the page token.
44
+ # @!attribute [rw] filter
45
+ # @return [::String]
46
+ # Optional. Filter for the list request.
47
+ #
48
+ # Supported fields:
49
+ #
50
+ # * `license_assignment_state`
51
+ #
52
+ # Examples:
53
+ #
54
+ # * `license_assignment_state = ASSIGNED` to list assigned user licenses.
55
+ # * `license_assignment_state = NO_LICENSE` to list not licensed users.
56
+ # * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users
57
+ # who attempted login but no license assigned.
58
+ # * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter
59
+ # out users who attempted login but no license assigned.
60
+ class ListUserLicensesRequest
61
+ include ::Google::Protobuf::MessageExts
62
+ extend ::Google::Protobuf::MessageExts::ClassMethods
63
+ end
64
+
65
+ # Response message for
66
+ # {::Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client#list_user_licenses UserLicenseService.ListUserLicenses}.
67
+ # @!attribute [rw] user_licenses
68
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::UserLicense>]
69
+ # All the customer's
70
+ # {::Google::Cloud::DiscoveryEngine::V1::UserLicense UserLicense}s.
71
+ # @!attribute [rw] next_page_token
72
+ # @return [::String]
73
+ # A token, which can be sent as `page_token` to retrieve the next page. If
74
+ # this field is omitted, there are no subsequent pages.
75
+ class ListUserLicensesResponse
76
+ include ::Google::Protobuf::MessageExts
77
+ extend ::Google::Protobuf::MessageExts::ClassMethods
78
+ end
79
+
80
+ # Request message for
81
+ # {::Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client#batch_update_user_licenses UserLicenseService.BatchUpdateUserLicenses}
82
+ # method.
83
+ # @!attribute [rw] inline_source
84
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BatchUpdateUserLicensesRequest::InlineSource]
85
+ # The inline source for the input content for document embeddings.
86
+ # @!attribute [rw] parent
87
+ # @return [::String]
88
+ # Required. The parent [UserStore][] resource name, format:
89
+ # `projects/{project}/locations/{location}/userStores/{user_store_id}`.
90
+ # @!attribute [rw] delete_unassigned_user_licenses
91
+ # @return [::Boolean]
92
+ # Optional. If true, if user licenses removed associated license config, the
93
+ # user license will be deleted. By default which is false, the user license
94
+ # will be updated to unassigned state.
95
+ class BatchUpdateUserLicensesRequest
96
+ include ::Google::Protobuf::MessageExts
97
+ extend ::Google::Protobuf::MessageExts::ClassMethods
98
+
99
+ # The inline source for the input config for BatchUpdateUserLicenses
100
+ # method.
101
+ # @!attribute [rw] user_licenses
102
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::UserLicense>]
103
+ # Required. A list of user licenses to update. Each user license
104
+ # must have a valid
105
+ # {::Google::Cloud::DiscoveryEngine::V1::UserLicense#user_principal UserLicense.user_principal}.
106
+ # @!attribute [rw] update_mask
107
+ # @return [::Google::Protobuf::FieldMask]
108
+ # Optional. The list of fields to update.
109
+ class InlineSource
110
+ include ::Google::Protobuf::MessageExts
111
+ extend ::Google::Protobuf::MessageExts::ClassMethods
112
+ end
113
+ end
114
+
115
+ # Metadata related to the progress of the
116
+ # {::Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client#batch_update_user_licenses UserLicenseService.BatchUpdateUserLicenses}
117
+ # operation. This will be returned by the google.longrunning.Operation.metadata
118
+ # field.
119
+ # @!attribute [rw] create_time
120
+ # @return [::Google::Protobuf::Timestamp]
121
+ # Operation create time.
122
+ # @!attribute [rw] update_time
123
+ # @return [::Google::Protobuf::Timestamp]
124
+ # Operation last update time. If the operation is done, this is also the
125
+ # finish time.
126
+ # @!attribute [rw] success_count
127
+ # @return [::Integer]
128
+ # Count of user licenses successfully updated.
129
+ # @!attribute [rw] failure_count
130
+ # @return [::Integer]
131
+ # Count of user licenses that failed to be updated.
132
+ class BatchUpdateUserLicensesMetadata
133
+ include ::Google::Protobuf::MessageExts
134
+ extend ::Google::Protobuf::MessageExts::ClassMethods
135
+ end
136
+
137
+ # Response message for
138
+ # {::Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client#batch_update_user_licenses UserLicenseService.BatchUpdateUserLicenses}
139
+ # method.
140
+ # @!attribute [rw] user_licenses
141
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::UserLicense>]
142
+ # UserLicenses successfully updated.
143
+ # @!attribute [rw] error_samples
144
+ # @return [::Array<::Google::Rpc::Status>]
145
+ # A sample of errors encountered while processing the request.
146
+ class BatchUpdateUserLicensesResponse
147
+ include ::Google::Protobuf::MessageExts
148
+ extend ::Google::Protobuf::MessageExts::ClassMethods
149
+ end
150
+ end
151
+ end
152
+ end
153
+ end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-discovery_engine-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.2.0
4
+ version: 2.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -65,6 +65,15 @@ files:
65
65
  - README.md
66
66
  - lib/google-cloud-discovery_engine-v1.rb
67
67
  - lib/google/cloud/discovery_engine/v1.rb
68
+ - lib/google/cloud/discovery_engine/v1/cmek_config_service.rb
69
+ - lib/google/cloud/discovery_engine/v1/cmek_config_service/client.rb
70
+ - lib/google/cloud/discovery_engine/v1/cmek_config_service/credentials.rb
71
+ - lib/google/cloud/discovery_engine/v1/cmek_config_service/operations.rb
72
+ - lib/google/cloud/discovery_engine/v1/cmek_config_service/paths.rb
73
+ - lib/google/cloud/discovery_engine/v1/cmek_config_service/rest.rb
74
+ - lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/client.rb
75
+ - lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/operations.rb
76
+ - lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/service_stub.rb
68
77
  - lib/google/cloud/discovery_engine/v1/completion_service.rb
69
78
  - lib/google/cloud/discovery_engine/v1/completion_service/client.rb
70
79
  - lib/google/cloud/discovery_engine/v1/completion_service/credentials.rb
@@ -122,6 +131,15 @@ files:
122
131
  - lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest.rb
123
132
  - lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/client.rb
124
133
  - lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/service_stub.rb
134
+ - lib/google/cloud/discovery_engine/v1/identity_mapping_store_service.rb
135
+ - lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/client.rb
136
+ - lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/credentials.rb
137
+ - lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/operations.rb
138
+ - lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/paths.rb
139
+ - lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest.rb
140
+ - lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/client.rb
141
+ - lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/operations.rb
142
+ - lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/service_stub.rb
125
143
  - lib/google/cloud/discovery_engine/v1/project_service.rb
126
144
  - lib/google/cloud/discovery_engine/v1/project_service/client.rb
127
145
  - lib/google/cloud/discovery_engine/v1/project_service/credentials.rb
@@ -196,9 +214,20 @@ files:
196
214
  - lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb
197
215
  - lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb
198
216
  - lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb
217
+ - lib/google/cloud/discovery_engine/v1/user_license_service.rb
218
+ - lib/google/cloud/discovery_engine/v1/user_license_service/client.rb
219
+ - lib/google/cloud/discovery_engine/v1/user_license_service/credentials.rb
220
+ - lib/google/cloud/discovery_engine/v1/user_license_service/operations.rb
221
+ - lib/google/cloud/discovery_engine/v1/user_license_service/paths.rb
222
+ - lib/google/cloud/discovery_engine/v1/user_license_service/rest.rb
223
+ - lib/google/cloud/discovery_engine/v1/user_license_service/rest/client.rb
224
+ - lib/google/cloud/discovery_engine/v1/user_license_service/rest/operations.rb
225
+ - lib/google/cloud/discovery_engine/v1/user_license_service/rest/service_stub.rb
199
226
  - lib/google/cloud/discovery_engine/v1/version.rb
200
227
  - lib/google/cloud/discoveryengine/v1/answer_pb.rb
201
228
  - lib/google/cloud/discoveryengine/v1/chunk_pb.rb
229
+ - lib/google/cloud/discoveryengine/v1/cmek_config_service_pb.rb
230
+ - lib/google/cloud/discoveryengine/v1/cmek_config_service_services_pb.rb
202
231
  - lib/google/cloud/discoveryengine/v1/common_pb.rb
203
232
  - lib/google/cloud/discoveryengine/v1/completion_pb.rb
204
233
  - lib/google/cloud/discoveryengine/v1/completion_service_pb.rb
@@ -223,6 +252,9 @@ files:
223
252
  - lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb
224
253
  - lib/google/cloud/discoveryengine/v1/grounded_generation_service_services_pb.rb
225
254
  - lib/google/cloud/discoveryengine/v1/grounding_pb.rb
255
+ - lib/google/cloud/discoveryengine/v1/identity_mapping_store_pb.rb
256
+ - lib/google/cloud/discoveryengine/v1/identity_mapping_store_service_pb.rb
257
+ - lib/google/cloud/discoveryengine/v1/identity_mapping_store_service_services_pb.rb
226
258
  - lib/google/cloud/discoveryengine/v1/import_config_pb.rb
227
259
  - lib/google/cloud/discoveryengine/v1/project_pb.rb
228
260
  - lib/google/cloud/discoveryengine/v1/project_service_pb.rb
@@ -250,6 +282,9 @@ files:
250
282
  - lib/google/cloud/discoveryengine/v1/user_event_pb.rb
251
283
  - lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb
252
284
  - lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb
285
+ - lib/google/cloud/discoveryengine/v1/user_license_pb.rb
286
+ - lib/google/cloud/discoveryengine/v1/user_license_service_pb.rb
287
+ - lib/google/cloud/discoveryengine/v1/user_license_service_services_pb.rb
253
288
  - proto_docs/README.md
254
289
  - proto_docs/google/api/client.rb
255
290
  - proto_docs/google/api/field_behavior.rb
@@ -258,6 +293,7 @@ files:
258
293
  - proto_docs/google/api/resource.rb
259
294
  - proto_docs/google/cloud/discoveryengine/v1/answer.rb
260
295
  - proto_docs/google/cloud/discoveryengine/v1/chunk.rb
296
+ - proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb
261
297
  - proto_docs/google/cloud/discoveryengine/v1/common.rb
262
298
  - proto_docs/google/cloud/discoveryengine/v1/completion.rb
263
299
  - proto_docs/google/cloud/discoveryengine/v1/completion_service.rb
@@ -275,6 +311,8 @@ files:
275
311
  - proto_docs/google/cloud/discoveryengine/v1/engine_service.rb
276
312
  - proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb
277
313
  - proto_docs/google/cloud/discoveryengine/v1/grounding.rb
314
+ - proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store.rb
315
+ - proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store_service.rb
278
316
  - proto_docs/google/cloud/discoveryengine/v1/import_config.rb
279
317
  - proto_docs/google/cloud/discoveryengine/v1/project.rb
280
318
  - proto_docs/google/cloud/discoveryengine/v1/project_service.rb
@@ -293,6 +331,8 @@ files:
293
331
  - proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb
294
332
  - proto_docs/google/cloud/discoveryengine/v1/user_event.rb
295
333
  - proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb
334
+ - proto_docs/google/cloud/discoveryengine/v1/user_license.rb
335
+ - proto_docs/google/cloud/discoveryengine/v1/user_license_service.rb
296
336
  - proto_docs/google/longrunning/operations.rb
297
337
  - proto_docs/google/protobuf/any.rb
298
338
  - proto_docs/google/protobuf/duration.rb
@@ -320,7 +360,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
320
360
  - !ruby/object:Gem::Version
321
361
  version: '0'
322
362
  requirements: []
323
- rubygems_version: 3.6.8
363
+ rubygems_version: 3.6.9
324
364
  specification_version: 4
325
365
  summary: Discovery Engine API.
326
366
  test_files: []