google-cloud-metastore-v1beta 0.2.0 → 0.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.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +1 -1
- data/lib/google/cloud/metastore/v1beta/dataproc_metastore/client.rb +8 -8
- data/lib/google/cloud/metastore/v1beta/dataproc_metastore/paths.rb +38 -0
- data/lib/google/cloud/metastore/v1beta/dataproc_metastore.rb +2 -2
- data/lib/google/cloud/metastore/v1beta/dataproc_metastore_federation/client.rb +900 -0
- data/lib/google/cloud/metastore/v1beta/dataproc_metastore_federation/credentials.rb +51 -0
- data/lib/google/cloud/metastore/v1beta/dataproc_metastore_federation/operations.rb +770 -0
- data/lib/google/cloud/metastore/v1beta/dataproc_metastore_federation/paths.rb +69 -0
- data/lib/google/cloud/metastore/v1beta/dataproc_metastore_federation.rb +62 -0
- data/lib/google/cloud/metastore/v1beta/metastore_federation_pb.rb +95 -0
- data/lib/google/cloud/metastore/v1beta/metastore_federation_services_pb.rb +65 -0
- data/lib/google/cloud/metastore/v1beta/metastore_pb.rb +62 -0
- data/lib/google/cloud/metastore/v1beta/metastore_services_pb.rb +3 -3
- data/lib/google/cloud/metastore/v1beta/version.rb +1 -1
- data/lib/google/cloud/metastore/v1beta.rb +1 -0
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/metastore/v1beta/metastore.rb +217 -12
- data/proto_docs/google/cloud/metastore/v1beta/metastore_federation.rb +305 -0
- data/proto_docs/google/protobuf/empty.rb +0 -2
- metadata +14 -4
@@ -28,8 +28,8 @@ module Google
|
|
28
28
|
# software as the metastore service.
|
29
29
|
# @!attribute [rw] name
|
30
30
|
# @return [::String]
|
31
|
-
# Immutable. The relative resource name of the metastore service,
|
32
|
-
#
|
31
|
+
# Immutable. The relative resource name of the metastore service, in the
|
32
|
+
# following format:
|
33
33
|
#
|
34
34
|
# `projects/{project_number}/locations/{location_id}/services/{service_id}`.
|
35
35
|
# @!attribute [r] create_time
|
@@ -75,6 +75,8 @@ module Google
|
|
75
75
|
# @return [::Google::Cloud::Metastore::V1beta::MaintenanceWindow]
|
76
76
|
# The one hour maintenance window of the metastore service. This specifies
|
77
77
|
# when the service can be restarted for maintenance purposes in UTC time.
|
78
|
+
# Maintenance window is not needed for services with the SPANNER
|
79
|
+
# database type.
|
78
80
|
# @!attribute [r] uid
|
79
81
|
# @return [::String]
|
80
82
|
# Output only. The globally unique resource identifier of the metastore
|
@@ -86,6 +88,21 @@ module Google
|
|
86
88
|
# @return [::Google::Cloud::Metastore::V1beta::Service::ReleaseChannel]
|
87
89
|
# Immutable. The release channel of the service.
|
88
90
|
# If unspecified, defaults to `STABLE`.
|
91
|
+
# @!attribute [rw] encryption_config
|
92
|
+
# @return [::Google::Cloud::Metastore::V1beta::EncryptionConfig]
|
93
|
+
# Immutable. Information used to configure the Dataproc Metastore service to
|
94
|
+
# encrypt customer data at rest. Cannot be updated.
|
95
|
+
# @!attribute [rw] network_config
|
96
|
+
# @return [::Google::Cloud::Metastore::V1beta::NetworkConfig]
|
97
|
+
# The configuration specifying the network settings for the
|
98
|
+
# Dataproc Metastore service.
|
99
|
+
# @!attribute [rw] database_type
|
100
|
+
# @return [::Google::Cloud::Metastore::V1beta::Service::DatabaseType]
|
101
|
+
# Immutable. The database type that the Metastore service stores its data.
|
102
|
+
# @!attribute [rw] telemetry_config
|
103
|
+
# @return [::Google::Cloud::Metastore::V1beta::TelemetryConfig]
|
104
|
+
# The configuration specifying telemetry settings for the Dataproc Metastore
|
105
|
+
# service. If unspecified defaults to `JSON`.
|
89
106
|
class Service
|
90
107
|
include ::Google::Protobuf::MessageExts
|
91
108
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -159,12 +176,27 @@ module Google
|
|
159
176
|
# and have been validated for production use.
|
160
177
|
STABLE = 2
|
161
178
|
end
|
179
|
+
|
180
|
+
# The backend database type for the metastore service.
|
181
|
+
module DatabaseType
|
182
|
+
# The DATABASE_TYPE is not set.
|
183
|
+
DATABASE_TYPE_UNSPECIFIED = 0
|
184
|
+
|
185
|
+
# MySQL is used to persist the metastore data.
|
186
|
+
MYSQL = 1
|
187
|
+
|
188
|
+
# Spanner is used to persist the metastore data.
|
189
|
+
SPANNER = 2
|
190
|
+
end
|
162
191
|
end
|
163
192
|
|
164
193
|
# Specifies how metastore metadata should be integrated with external services.
|
165
194
|
# @!attribute [rw] data_catalog_config
|
166
195
|
# @return [::Google::Cloud::Metastore::V1beta::DataCatalogConfig]
|
167
196
|
# The integration config for the Data Catalog service.
|
197
|
+
# @!attribute [rw] dataplex_config
|
198
|
+
# @return [::Google::Cloud::Metastore::V1beta::DataplexConfig]
|
199
|
+
# The integration config for the Dataplex service.
|
168
200
|
class MetadataIntegration
|
169
201
|
include ::Google::Protobuf::MessageExts
|
170
202
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -181,6 +213,38 @@ module Google
|
|
181
213
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
182
214
|
end
|
183
215
|
|
216
|
+
# Specifies how metastore metadata should be integrated with the Dataplex
|
217
|
+
# service.
|
218
|
+
# @!attribute [rw] lake_resources
|
219
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Metastore::V1beta::Lake}]
|
220
|
+
# A reference to the Lake resources that this metastore service is attached
|
221
|
+
# to. The key is the lake resource name. Example:
|
222
|
+
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
|
223
|
+
class DataplexConfig
|
224
|
+
include ::Google::Protobuf::MessageExts
|
225
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
226
|
+
|
227
|
+
# @!attribute [rw] key
|
228
|
+
# @return [::String]
|
229
|
+
# @!attribute [rw] value
|
230
|
+
# @return [::Google::Cloud::Metastore::V1beta::Lake]
|
231
|
+
class LakeResourcesEntry
|
232
|
+
include ::Google::Protobuf::MessageExts
|
233
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
234
|
+
end
|
235
|
+
end
|
236
|
+
|
237
|
+
# Represents a Lake resource
|
238
|
+
# @!attribute [rw] name
|
239
|
+
# @return [::String]
|
240
|
+
# The Lake resource name.
|
241
|
+
# Example:
|
242
|
+
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`
|
243
|
+
class Lake
|
244
|
+
include ::Google::Protobuf::MessageExts
|
245
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
246
|
+
end
|
247
|
+
|
184
248
|
# Maintenance window. This specifies when Dataproc Metastore
|
185
249
|
# may perform system maintenance operation to the service.
|
186
250
|
# @!attribute [rw] hour_of_day
|
@@ -203,7 +267,9 @@ module Google
|
|
203
267
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
204
268
|
# A mapping of Hive metastore configuration key-value pairs to apply to the
|
205
269
|
# Hive metastore (configured in `hive-site.xml`). The mappings
|
206
|
-
# override system defaults (some keys cannot be overridden).
|
270
|
+
# override system defaults (some keys cannot be overridden). These
|
271
|
+
# overrides are also applied to auxiliary versions and can be further
|
272
|
+
# customized in the auxiliary version's `AuxiliaryVersionConfig`.
|
207
273
|
# @!attribute [rw] kerberos_config
|
208
274
|
# @return [::Google::Cloud::Metastore::V1beta::KerberosConfig]
|
209
275
|
# Information used to configure the Hive metastore service as a service
|
@@ -211,6 +277,20 @@ module Google
|
|
211
277
|
# method and specify this field's path
|
212
278
|
# (`hive_metastore_config.kerberos_config`) in the request's `update_mask`
|
213
279
|
# while omitting this field from the request's `service`.
|
280
|
+
# @!attribute [rw] endpoint_protocol
|
281
|
+
# @return [::Google::Cloud::Metastore::V1beta::HiveMetastoreConfig::EndpointProtocol]
|
282
|
+
# The protocol to use for the metastore service endpoint. If unspecified,
|
283
|
+
# defaults to `THRIFT`.
|
284
|
+
# @!attribute [rw] auxiliary_versions
|
285
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Metastore::V1beta::AuxiliaryVersionConfig}]
|
286
|
+
# A mapping of Hive metastore version to the auxiliary version
|
287
|
+
# configuration. When specified, a secondary Hive metastore service is
|
288
|
+
# created along with the primary service. All auxiliary versions must be less
|
289
|
+
# than the service's primary version. The key is the auxiliary service name
|
290
|
+
# and it must match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. This
|
291
|
+
# means that the first character must be a lowercase letter, and all the
|
292
|
+
# following characters must be hyphens, lowercase letters, or digits, except
|
293
|
+
# the last character, which cannot be a hyphen.
|
214
294
|
class HiveMetastoreConfig
|
215
295
|
include ::Google::Protobuf::MessageExts
|
216
296
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -223,6 +303,27 @@ module Google
|
|
223
303
|
include ::Google::Protobuf::MessageExts
|
224
304
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
225
305
|
end
|
306
|
+
|
307
|
+
# @!attribute [rw] key
|
308
|
+
# @return [::String]
|
309
|
+
# @!attribute [rw] value
|
310
|
+
# @return [::Google::Cloud::Metastore::V1beta::AuxiliaryVersionConfig]
|
311
|
+
class AuxiliaryVersionsEntry
|
312
|
+
include ::Google::Protobuf::MessageExts
|
313
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
314
|
+
end
|
315
|
+
|
316
|
+
# Protocols available for serving the metastore service endpoint.
|
317
|
+
module EndpointProtocol
|
318
|
+
# The protocol is not set.
|
319
|
+
ENDPOINT_PROTOCOL_UNSPECIFIED = 0
|
320
|
+
|
321
|
+
# Use the legacy Apache Thrift protocol for the metastore service endpoint.
|
322
|
+
THRIFT = 1
|
323
|
+
|
324
|
+
# Use the modernized gRPC protocol for the metastore service endpoint.
|
325
|
+
GRPC = 2
|
326
|
+
end
|
226
327
|
end
|
227
328
|
|
228
329
|
# Configuration information for a Kerberos principal.
|
@@ -238,7 +339,7 @@ module Google
|
|
238
339
|
# @!attribute [rw] krb5_config_gcs_uri
|
239
340
|
# @return [::String]
|
240
341
|
# A Cloud Storage URI that specifies the path to a
|
241
|
-
# krb5.conf file. It is of the form gs
|
342
|
+
# krb5.conf file. It is of the form `gs://{bucket_name}/path/to/krb5.conf`,
|
242
343
|
# although the file does not need to be named krb5.conf explicitly.
|
243
344
|
class KerberosConfig
|
244
345
|
include ::Google::Protobuf::MessageExts
|
@@ -257,6 +358,98 @@ module Google
|
|
257
358
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
258
359
|
end
|
259
360
|
|
361
|
+
# Encryption settings for the service.
|
362
|
+
# @!attribute [rw] kms_key
|
363
|
+
# @return [::String]
|
364
|
+
# The fully qualified customer provided Cloud KMS key name to use for
|
365
|
+
# customer data encryption, in the following form:
|
366
|
+
#
|
367
|
+
# `projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}`.
|
368
|
+
class EncryptionConfig
|
369
|
+
include ::Google::Protobuf::MessageExts
|
370
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
371
|
+
end
|
372
|
+
|
373
|
+
# Configuration information for the auxiliary service versions.
|
374
|
+
# @!attribute [rw] version
|
375
|
+
# @return [::String]
|
376
|
+
# The Hive metastore version of the auxiliary service. It must be less
|
377
|
+
# than the primary Hive metastore service's version.
|
378
|
+
# @!attribute [rw] config_overrides
|
379
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
380
|
+
# A mapping of Hive metastore configuration key-value pairs to apply to the
|
381
|
+
# auxiliary Hive metastore (configured in `hive-site.xml`) in addition to
|
382
|
+
# the primary version's overrides. If keys are present in both the auxiliary
|
383
|
+
# version's overrides and the primary version's overrides, the value from
|
384
|
+
# the auxiliary version's overrides takes precedence.
|
385
|
+
# @!attribute [r] network_config
|
386
|
+
# @return [::Google::Cloud::Metastore::V1beta::NetworkConfig]
|
387
|
+
# Output only. The network configuration contains the endpoint URI(s) of the
|
388
|
+
# auxiliary Hive metastore service.
|
389
|
+
class AuxiliaryVersionConfig
|
390
|
+
include ::Google::Protobuf::MessageExts
|
391
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
392
|
+
|
393
|
+
# @!attribute [rw] key
|
394
|
+
# @return [::String]
|
395
|
+
# @!attribute [rw] value
|
396
|
+
# @return [::String]
|
397
|
+
class ConfigOverridesEntry
|
398
|
+
include ::Google::Protobuf::MessageExts
|
399
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
400
|
+
end
|
401
|
+
end
|
402
|
+
|
403
|
+
# Network configuration for the Dataproc Metastore service.
|
404
|
+
# @!attribute [rw] consumers
|
405
|
+
# @return [::Array<::Google::Cloud::Metastore::V1beta::NetworkConfig::Consumer>]
|
406
|
+
# Immutable. The consumer-side network configuration for the Dataproc
|
407
|
+
# Metastore instance.
|
408
|
+
class NetworkConfig
|
409
|
+
include ::Google::Protobuf::MessageExts
|
410
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
411
|
+
|
412
|
+
# Contains information of the customer's network configurations.
|
413
|
+
# @!attribute [rw] subnetwork
|
414
|
+
# @return [::String]
|
415
|
+
# Immutable. The subnetwork of the customer project from which an IP
|
416
|
+
# address is reserved and used as the Dataproc Metastore service's
|
417
|
+
# endpoint. It is accessible to hosts in the subnet and to all
|
418
|
+
# hosts in a subnet in the same region and same network. There must
|
419
|
+
# be at least one IP address available in the subnet's primary range. The
|
420
|
+
# subnet is specified in the following form:
|
421
|
+
#
|
422
|
+
# `projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}`
|
423
|
+
# @!attribute [r] endpoint_uri
|
424
|
+
# @return [::String]
|
425
|
+
# Output only. The URI of the endpoint used to access the metastore
|
426
|
+
# service.
|
427
|
+
class Consumer
|
428
|
+
include ::Google::Protobuf::MessageExts
|
429
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
430
|
+
end
|
431
|
+
end
|
432
|
+
|
433
|
+
# Telemetry Configuration for the Dataproc Metastore service.
|
434
|
+
# @!attribute [rw] log_format
|
435
|
+
# @return [::Google::Cloud::Metastore::V1beta::TelemetryConfig::LogFormat]
|
436
|
+
# The output format of the Dataproc Metastore service's logs.
|
437
|
+
class TelemetryConfig
|
438
|
+
include ::Google::Protobuf::MessageExts
|
439
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
440
|
+
|
441
|
+
module LogFormat
|
442
|
+
# The LOG_FORMAT is not set.
|
443
|
+
LOG_FORMAT_UNSPECIFIED = 0
|
444
|
+
|
445
|
+
# Logging output uses the legacy `textPayload` format.
|
446
|
+
LEGACY = 1
|
447
|
+
|
448
|
+
# Logging output uses the `jsonPayload` format.
|
449
|
+
JSON = 2
|
450
|
+
end
|
451
|
+
end
|
452
|
+
|
260
453
|
# The metadata management activities of the metastore service.
|
261
454
|
# @!attribute [r] metadata_exports
|
262
455
|
# @return [::Array<::Google::Cloud::Metastore::V1beta::MetadataExport>]
|
@@ -283,10 +476,13 @@ module Google
|
|
283
476
|
# The description of the metadata import.
|
284
477
|
# @!attribute [r] create_time
|
285
478
|
# @return [::Google::Protobuf::Timestamp]
|
286
|
-
# Output only. The time when the metadata import was
|
479
|
+
# Output only. The time when the metadata import was started.
|
287
480
|
# @!attribute [r] update_time
|
288
481
|
# @return [::Google::Protobuf::Timestamp]
|
289
482
|
# Output only. The time when the metadata import was last updated.
|
483
|
+
# @!attribute [r] end_time
|
484
|
+
# @return [::Google::Protobuf::Timestamp]
|
485
|
+
# Output only. The time when the metadata import finished.
|
290
486
|
# @!attribute [r] state
|
291
487
|
# @return [::Google::Cloud::Metastore::V1beta::MetadataImport::State]
|
292
488
|
# Output only. The current state of the metadata import.
|
@@ -407,6 +603,9 @@ module Google
|
|
407
603
|
# @!attribute [rw] description
|
408
604
|
# @return [::String]
|
409
605
|
# The description of the backup.
|
606
|
+
# @!attribute [r] restoring_services
|
607
|
+
# @return [::Array<::String>]
|
608
|
+
# Output only. Services that are restoring from the backup.
|
410
609
|
class Backup
|
411
610
|
include ::Google::Protobuf::MessageExts
|
412
611
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -427,6 +626,9 @@ module Google
|
|
427
626
|
|
428
627
|
# The backup failed.
|
429
628
|
FAILED = 4
|
629
|
+
|
630
|
+
# The backup is being restored.
|
631
|
+
RESTORING = 5
|
430
632
|
end
|
431
633
|
end
|
432
634
|
|
@@ -445,7 +647,7 @@ module Google
|
|
445
647
|
# Output only. The relative resource name of the metastore service backup to
|
446
648
|
# restore from, in the following form:
|
447
649
|
#
|
448
|
-
# `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}
|
650
|
+
# `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`.
|
449
651
|
# @!attribute [r] type
|
450
652
|
# @return [::Google::Cloud::Metastore::V1beta::Restore::RestoreType]
|
451
653
|
# Output only. The type of restore.
|
@@ -475,7 +677,7 @@ module Google
|
|
475
677
|
CANCELLED = 4
|
476
678
|
end
|
477
679
|
|
478
|
-
# The type of restore.
|
680
|
+
# The type of restore. If unspecified, defaults to `METADATA_ONLY`.
|
479
681
|
module RestoreType
|
480
682
|
# The restore type is unknown.
|
481
683
|
RESTORE_TYPE_UNSPECIFIED = 0
|
@@ -731,7 +933,7 @@ module Google
|
|
731
933
|
# Required. The relative resource name of the service in which to create a
|
732
934
|
# metastore import, in the following form:
|
733
935
|
#
|
734
|
-
# `projects/{project_number}/locations/{location_id}/services/{service_id}
|
936
|
+
# `projects/{project_number}/locations/{location_id}/services/{service_id}`.
|
735
937
|
# @!attribute [rw] metadata_import_id
|
736
938
|
# @return [::String]
|
737
939
|
# Required. The ID of the metadata import, which is used as the final
|
@@ -872,7 +1074,7 @@ module Google
|
|
872
1074
|
# Required. The relative resource name of the service in which to create a
|
873
1075
|
# backup of the following form:
|
874
1076
|
#
|
875
|
-
# `projects/{project_number}/locations/{location_id}/services/{service_id}
|
1077
|
+
# `projects/{project_number}/locations/{location_id}/services/{service_id}`.
|
876
1078
|
# @!attribute [rw] backup_id
|
877
1079
|
# @return [::String]
|
878
1080
|
# Required. The ID of the backup, which is used as the final component of the
|
@@ -943,7 +1145,7 @@ module Google
|
|
943
1145
|
# Required. The relative resource name of the metastore service to run
|
944
1146
|
# export, in the following form:
|
945
1147
|
#
|
946
|
-
# `projects/{project_id}/locations/{location_id}/services/{service_id}
|
1148
|
+
# `projects/{project_id}/locations/{location_id}/services/{service_id}`.
|
947
1149
|
# @!attribute [rw] request_id
|
948
1150
|
# @return [::String]
|
949
1151
|
# Optional. A request ID. Specify a unique request ID to allow the server to
|
@@ -973,13 +1175,13 @@ module Google
|
|
973
1175
|
# Required. The relative resource name of the metastore service to run
|
974
1176
|
# restore, in the following form:
|
975
1177
|
#
|
976
|
-
# `projects/{project_id}/locations/{location_id}/services/{service_id}
|
1178
|
+
# `projects/{project_id}/locations/{location_id}/services/{service_id}`.
|
977
1179
|
# @!attribute [rw] backup
|
978
1180
|
# @return [::String]
|
979
1181
|
# Required. The relative resource name of the metastore service backup to
|
980
1182
|
# restore from, in the following form:
|
981
1183
|
#
|
982
|
-
# `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}
|
1184
|
+
# `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`.
|
983
1185
|
# @!attribute [rw] restore_type
|
984
1186
|
# @return [::Google::Cloud::Metastore::V1beta::Restore::RestoreType]
|
985
1187
|
# Optional. The type of restore. If unspecified, defaults to `METADATA_ONLY`.
|
@@ -1069,6 +1271,9 @@ module Google
|
|
1069
1271
|
|
1070
1272
|
# Database dump is a MySQL dump file.
|
1071
1273
|
MYSQL = 1
|
1274
|
+
|
1275
|
+
# Database dump contains Avro files.
|
1276
|
+
AVRO = 2
|
1072
1277
|
end
|
1073
1278
|
end
|
1074
1279
|
end
|
@@ -0,0 +1,305 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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 Metastore
|
23
|
+
module V1beta
|
24
|
+
# Represents a federation of multiple backend metastores.
|
25
|
+
# @!attribute [rw] name
|
26
|
+
# @return [::String]
|
27
|
+
# Immutable. The relative resource name of the federation, of the
|
28
|
+
# form:
|
29
|
+
# projects/\\{project_number}/locations/\\{location_id}/federations/\\{federation_id}`.
|
30
|
+
# @!attribute [r] create_time
|
31
|
+
# @return [::Google::Protobuf::Timestamp]
|
32
|
+
# Output only. The time when the metastore federation was created.
|
33
|
+
# @!attribute [r] update_time
|
34
|
+
# @return [::Google::Protobuf::Timestamp]
|
35
|
+
# Output only. The time when the metastore federation was last updated.
|
36
|
+
# @!attribute [rw] labels
|
37
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
38
|
+
# User-defined labels for the metastore federation.
|
39
|
+
# @!attribute [rw] version
|
40
|
+
# @return [::String]
|
41
|
+
# Immutable. The Apache Hive metastore version of the federation. All backend metastore
|
42
|
+
# versions must be compatible with the federation version.
|
43
|
+
# @!attribute [rw] backend_metastores
|
44
|
+
# @return [::Google::Protobuf::Map{::Integer => ::Google::Cloud::Metastore::V1beta::BackendMetastore}]
|
45
|
+
# A map from `BackendMetastore` rank to `BackendMetastore`s from which the
|
46
|
+
# federation service serves metadata at query time. The map key represents
|
47
|
+
# the order in which `BackendMetastore`s should be evaluated to resolve
|
48
|
+
# database names at query time and should be greater than or equal to zero. A
|
49
|
+
# `BackendMetastore` with a lower number will be evaluated before a
|
50
|
+
# `BackendMetastore` with a higher number.
|
51
|
+
# @!attribute [r] endpoint_uri
|
52
|
+
# @return [::String]
|
53
|
+
# Output only. The federation endpoint.
|
54
|
+
# @!attribute [r] state
|
55
|
+
# @return [::Google::Cloud::Metastore::V1beta::Federation::State]
|
56
|
+
# Output only. The current state of the federation.
|
57
|
+
# @!attribute [r] state_message
|
58
|
+
# @return [::String]
|
59
|
+
# Output only. Additional information about the current state of the metastore federation,
|
60
|
+
# if available.
|
61
|
+
# @!attribute [r] uid
|
62
|
+
# @return [::String]
|
63
|
+
# Output only. The globally unique resource identifier of the metastore federation.
|
64
|
+
class Federation
|
65
|
+
include ::Google::Protobuf::MessageExts
|
66
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
67
|
+
|
68
|
+
# @!attribute [rw] key
|
69
|
+
# @return [::String]
|
70
|
+
# @!attribute [rw] value
|
71
|
+
# @return [::String]
|
72
|
+
class LabelsEntry
|
73
|
+
include ::Google::Protobuf::MessageExts
|
74
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
75
|
+
end
|
76
|
+
|
77
|
+
# @!attribute [rw] key
|
78
|
+
# @return [::Integer]
|
79
|
+
# @!attribute [rw] value
|
80
|
+
# @return [::Google::Cloud::Metastore::V1beta::BackendMetastore]
|
81
|
+
class BackendMetastoresEntry
|
82
|
+
include ::Google::Protobuf::MessageExts
|
83
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
84
|
+
end
|
85
|
+
|
86
|
+
# The current state of the federation.
|
87
|
+
module State
|
88
|
+
# The state of the metastore federation is unknown.
|
89
|
+
STATE_UNSPECIFIED = 0
|
90
|
+
|
91
|
+
# The metastore federation is in the process of being created.
|
92
|
+
CREATING = 1
|
93
|
+
|
94
|
+
# The metastore federation is running and ready to serve queries.
|
95
|
+
ACTIVE = 2
|
96
|
+
|
97
|
+
# The metastore federation is being updated. It remains usable but cannot
|
98
|
+
# accept additional update requests or be deleted at this time.
|
99
|
+
UPDATING = 3
|
100
|
+
|
101
|
+
# The metastore federation is undergoing deletion. It cannot be used.
|
102
|
+
DELETING = 4
|
103
|
+
|
104
|
+
# The metastore federation has encountered an error and cannot be used. The
|
105
|
+
# metastore federation should be deleted.
|
106
|
+
ERROR = 5
|
107
|
+
end
|
108
|
+
end
|
109
|
+
|
110
|
+
# Represents a backend metastore for the federation.
|
111
|
+
# @!attribute [rw] name
|
112
|
+
# @return [::String]
|
113
|
+
# The relative resource name of the metastore that is being federated.
|
114
|
+
# The formats of the relative resource names for the currently supported
|
115
|
+
# metastores are listed below:
|
116
|
+
#
|
117
|
+
# * Dataplex
|
118
|
+
# * `projects/{project_id}/locations/{location}/lakes/{lake_id}`
|
119
|
+
# * BigQuery
|
120
|
+
# * `projects/{project_id}`
|
121
|
+
# * Dataproc Metastore
|
122
|
+
# * `projects/{project_id}/locations/{location}/services/{service_id}`
|
123
|
+
# @!attribute [rw] metastore_type
|
124
|
+
# @return [::Google::Cloud::Metastore::V1beta::BackendMetastore::MetastoreType]
|
125
|
+
# The type of the backend metastore.
|
126
|
+
class BackendMetastore
|
127
|
+
include ::Google::Protobuf::MessageExts
|
128
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
129
|
+
|
130
|
+
# The type of the backend metastore.
|
131
|
+
module MetastoreType
|
132
|
+
# The metastore type is not set.
|
133
|
+
METASTORE_TYPE_UNSPECIFIED = 0
|
134
|
+
|
135
|
+
# The backend metastore is BigQuery.
|
136
|
+
BIGQUERY = 2
|
137
|
+
|
138
|
+
# The backend metastore is Dataproc Metastore.
|
139
|
+
DATAPROC_METASTORE = 3
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
# Request message for ListFederations.
|
144
|
+
# @!attribute [rw] parent
|
145
|
+
# @return [::String]
|
146
|
+
# Required. The relative resource name of the location of metastore federations
|
147
|
+
# to list, in the following form:
|
148
|
+
# `projects/{project_number}/locations/{location_id}`.
|
149
|
+
# @!attribute [rw] page_size
|
150
|
+
# @return [::Integer]
|
151
|
+
# Optional. The maximum number of federations to return. The response may contain less
|
152
|
+
# than the maximum number. If unspecified, no more than 500 services are
|
153
|
+
# returned. The maximum value is 1000; values above 1000 are changed to 1000.
|
154
|
+
# @!attribute [rw] page_token
|
155
|
+
# @return [::String]
|
156
|
+
# Optional. A page token, received from a previous ListFederationServices
|
157
|
+
# call. Provide this token to retrieve the subsequent page.
|
158
|
+
#
|
159
|
+
# To retrieve the first page, supply an empty page token.
|
160
|
+
#
|
161
|
+
# When paginating, other parameters provided to
|
162
|
+
# ListFederationServices must match the call that provided the
|
163
|
+
# page token.
|
164
|
+
# @!attribute [rw] filter
|
165
|
+
# @return [::String]
|
166
|
+
# Optional. The filter to apply to list results.
|
167
|
+
# @!attribute [rw] order_by
|
168
|
+
# @return [::String]
|
169
|
+
# Optional. Specify the ordering of results as described in [Sorting
|
170
|
+
# Order](https://cloud.google.com/apis/design/design_patterns#sorting_order).
|
171
|
+
# If not specified, the results will be sorted in the default order.
|
172
|
+
class ListFederationsRequest
|
173
|
+
include ::Google::Protobuf::MessageExts
|
174
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
175
|
+
end
|
176
|
+
|
177
|
+
# Response message for ListFederations
|
178
|
+
# @!attribute [rw] federations
|
179
|
+
# @return [::Array<::Google::Cloud::Metastore::V1beta::Federation>]
|
180
|
+
# The services in the specified location.
|
181
|
+
# @!attribute [rw] next_page_token
|
182
|
+
# @return [::String]
|
183
|
+
# A token that can be sent as `page_token` to retrieve the next page. If this
|
184
|
+
# field is omitted, there are no subsequent pages.
|
185
|
+
# @!attribute [rw] unreachable
|
186
|
+
# @return [::Array<::String>]
|
187
|
+
# Locations that could not be reached.
|
188
|
+
class ListFederationsResponse
|
189
|
+
include ::Google::Protobuf::MessageExts
|
190
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
191
|
+
end
|
192
|
+
|
193
|
+
# Request message for GetFederation.
|
194
|
+
# @!attribute [rw] name
|
195
|
+
# @return [::String]
|
196
|
+
# Required. The relative resource name of the metastore federation to retrieve,
|
197
|
+
# in the following form:
|
198
|
+
#
|
199
|
+
# `projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
|
200
|
+
class GetFederationRequest
|
201
|
+
include ::Google::Protobuf::MessageExts
|
202
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
203
|
+
end
|
204
|
+
|
205
|
+
# Request message for CreateFederation.
|
206
|
+
# @!attribute [rw] parent
|
207
|
+
# @return [::String]
|
208
|
+
# Required. The relative resource name of the location in which to create a federation
|
209
|
+
# service, in the following form:
|
210
|
+
#
|
211
|
+
# `projects/{project_number}/locations/{location_id}`.
|
212
|
+
# @!attribute [rw] federation_id
|
213
|
+
# @return [::String]
|
214
|
+
# Required. The ID of the metastore federation, which is used as the final
|
215
|
+
# component of the metastore federation's name.
|
216
|
+
#
|
217
|
+
# This value must be between 2 and 63 characters long inclusive, begin with a
|
218
|
+
# letter, end with a letter or number, and consist of alpha-numeric
|
219
|
+
# ASCII characters or hyphens.
|
220
|
+
# @!attribute [rw] federation
|
221
|
+
# @return [::Google::Cloud::Metastore::V1beta::Federation]
|
222
|
+
# Required. The Metastore Federation to create. The `name` field is
|
223
|
+
# ignored. The ID of the created metastore federation must be
|
224
|
+
# provided in the request's `federation_id` field.
|
225
|
+
# @!attribute [rw] request_id
|
226
|
+
# @return [::String]
|
227
|
+
# Optional. A request ID. Specify a unique request ID to allow the server to ignore the
|
228
|
+
# request if it has completed. The server will ignore subsequent requests
|
229
|
+
# that provide a duplicate request ID for at least 60 minutes after the first
|
230
|
+
# request.
|
231
|
+
#
|
232
|
+
# For example, if an initial request times out, followed by another request
|
233
|
+
# with the same request ID, the server ignores the second request to prevent
|
234
|
+
# the creation of duplicate commitments.
|
235
|
+
#
|
236
|
+
# The request ID must be a valid
|
237
|
+
# [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
|
238
|
+
# A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
|
239
|
+
class CreateFederationRequest
|
240
|
+
include ::Google::Protobuf::MessageExts
|
241
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
242
|
+
end
|
243
|
+
|
244
|
+
# Request message for UpdateFederation.
|
245
|
+
# @!attribute [rw] update_mask
|
246
|
+
# @return [::Google::Protobuf::FieldMask]
|
247
|
+
# Required. A field mask used to specify the fields to be overwritten in the
|
248
|
+
# metastore federation resource by the update.
|
249
|
+
# Fields specified in the `update_mask` are relative to the resource (not
|
250
|
+
# to the full request). A field is overwritten if it is in the mask.
|
251
|
+
# @!attribute [rw] federation
|
252
|
+
# @return [::Google::Cloud::Metastore::V1beta::Federation]
|
253
|
+
# Required. The metastore federation to update. The server only merges fields
|
254
|
+
# in the service if they are specified in `update_mask`.
|
255
|
+
#
|
256
|
+
# The metastore federation's `name` field is used to identify the
|
257
|
+
# metastore service to be updated.
|
258
|
+
# @!attribute [rw] request_id
|
259
|
+
# @return [::String]
|
260
|
+
# Optional. A request ID. Specify a unique request ID to allow the server to ignore the
|
261
|
+
# request if it has completed. The server will ignore subsequent requests
|
262
|
+
# that provide a duplicate request ID for at least 60 minutes after the first
|
263
|
+
# request.
|
264
|
+
#
|
265
|
+
# For example, if an initial request times out, followed by another request
|
266
|
+
# with the same request ID, the server ignores the second request to prevent
|
267
|
+
# the creation of duplicate commitments.
|
268
|
+
#
|
269
|
+
# The request ID must be a valid
|
270
|
+
# [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
|
271
|
+
# A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
|
272
|
+
class UpdateFederationRequest
|
273
|
+
include ::Google::Protobuf::MessageExts
|
274
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
275
|
+
end
|
276
|
+
|
277
|
+
# Request message for DeleteFederation.
|
278
|
+
# @!attribute [rw] name
|
279
|
+
# @return [::String]
|
280
|
+
# Required. The relative resource name of the metastore federation to delete,
|
281
|
+
# in the following form:
|
282
|
+
#
|
283
|
+
# `projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
|
284
|
+
# @!attribute [rw] request_id
|
285
|
+
# @return [::String]
|
286
|
+
# Optional. A request ID. Specify a unique request ID to allow the server to ignore the
|
287
|
+
# request if it has completed. The server will ignore subsequent requests
|
288
|
+
# that provide a duplicate request ID for at least 60 minutes after the first
|
289
|
+
# request.
|
290
|
+
#
|
291
|
+
# For example, if an initial request times out, followed by another request
|
292
|
+
# with the same request ID, the server ignores the second request to prevent
|
293
|
+
# the creation of duplicate commitments.
|
294
|
+
#
|
295
|
+
# The request ID must be a valid
|
296
|
+
# [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
|
297
|
+
# A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
|
298
|
+
class DeleteFederationRequest
|
299
|
+
include ::Google::Protobuf::MessageExts
|
300
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
301
|
+
end
|
302
|
+
end
|
303
|
+
end
|
304
|
+
end
|
305
|
+
end
|