-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
metastore_v1.projects.locations.services.html
1192 lines (1095 loc) 路 146 KB
/
metastore_v1.projects.locations.services.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="metastore_v1.html">Dataproc Metastore API</a> . <a href="metastore_v1.projects.html">projects</a> . <a href="metastore_v1.projects.locations.html">locations</a> . <a href="metastore_v1.projects.locations.services.html">services</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="metastore_v1.projects.locations.services.backups.html">backups()</a></code>
</p>
<p class="firstline">Returns the backups Resource.</p>
<p class="toc_element">
<code><a href="metastore_v1.projects.locations.services.metadataImports.html">metadataImports()</a></code>
</p>
<p class="firstline">Returns the metadataImports Resource.</p>
<p class="toc_element">
<code><a href="#alterLocation">alterLocation(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.</p>
<p class="toc_element">
<code><a href="#alterTableProperties">alterTableProperties(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Alter metadata table properties.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, requestId=None, serviceId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a metastore service in a project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single service.</p>
<p class="toc_element">
<code><a href="#exportMetadata">exportMetadata(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports metadata from a service.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a single service.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists services in a project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#moveTableToDatabase">moveTableToDatabase(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Move a table to another database.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single service.</p>
<p class="toc_element">
<code><a href="#queryMetadata">queryMetadata(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Query DPMS metadata.</p>
<p class="toc_element">
<code><a href="#restore">restore(service, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restores a service from a backup.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="alterLocation">alterLocation(service, body=None, x__xgafv=None)</code>
<pre>Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.
Args:
service: string, Required. The relative resource name of the metastore service to mutate metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for DataprocMetastore.AlterMetadataResourceLocation.
"locationUri": "A String", # Required. The new location URI for the metadata resource.
"resourceName": "A String", # Required. The relative metadata resource name in the following format.databases/{database_id} or databases/{database_id}/tables/{table_id} or databases/{database_id}/tables/{table_id}/partitions/{partition_id}
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="alterTableProperties">alterTableProperties(service, body=None, x__xgafv=None)</code>
<pre>Alter metadata table properties.
Args:
service: string, Required. The relative resource name of the Dataproc Metastore service that's being used to mutate metadata table properties, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for DataprocMetastore.AlterTableProperties.
"properties": { # A map that describes the desired values to mutate. If update_mask is empty, the properties will not update. Otherwise, the properties only alters the value whose associated paths exist in the update mask
"a_key": "A String",
},
"tableName": "A String", # Required. The name of the table containing the properties you're altering in the following format.databases/{database_id}/tables/{table_id}
"updateMask": "A String", # A field mask that specifies the metadata table properties that are overwritten by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.For example, given the target properties: properties { a: 1 b: 2 } And an update properties: properties { a: 2 b: 3 c: 4 } then if the field mask is:paths: "properties.b", "properties.c"then the result will be: properties { a: 1 b: 3 c: 4 }
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, requestId=None, serviceId=None, x__xgafv=None)</code>
<pre>Creates a metastore service in a project and location.
Args:
parent: string, Required. The relative resource name of the location in which to create a metastore service, in the following form:projects/{project_number}/locations/{location_id}. (required)
body: object, The request body.
The object takes the form of:
{ # A managed metastore service that serves metadata queries.
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"hiveMetastoreConfig": { # Specifies configuration information specific to running Hive metastore software as the metastore service. # Configuration information specific to running Hive metastore software as the metastore service.
"auxiliaryVersions": { # A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
"a_key": { # Configuration information for the auxiliary service versions.
"configOverrides": { # A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.
"a_key": "A String",
},
"networkConfig": { # Network configuration for the Dataproc Metastore service. # Output only. The network configuration contains the endpoint URI(s) of the auxiliary Hive metastore service.
"consumers": [ # Immutable. The consumer-side network configuration for the Dataproc Metastore instance.
{ # Contains information of the customer's network configurations.
"endpointLocation": "A String", # Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"subnetwork": "A String", # Immutable. The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form:projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}
},
],
},
"version": "A String", # The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.
},
},
"configOverrides": { # A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version's AuxiliaryVersionConfig.
"a_key": "A String",
},
"endpointProtocol": "A String", # The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT.
"kerberosConfig": { # Configuration information for a Kerberos principal. # Information used to configure the Hive metastore service as a service principal in a Kerberos realm. To disable Kerberos, use the UpdateService method and specify this field's path (hive_metastore_config.kerberos_config) in the request's update_mask while omitting this field from the request's service.
"keytab": { # A securely stored value. # A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
"cloudSecret": "A String", # The relative resource name of a Secret Manager secret version, in the following form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}.
},
"krb5ConfigGcsUri": "A String", # A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.
"principal": "A String", # A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form primary/instance@REALM, but there is no exact format.
},
"version": "A String", # Immutable. The Hive metastore schema version.
},
"labels": { # User-defined labels for the metastore service.
"a_key": "A String",
},
"maintenanceWindow": { # Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service. # The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type.
"dayOfWeek": "A String", # The day of week, when the window starts.
"hourOfDay": 42, # The hour of day (0-23) when the window starts.
},
"metadataIntegration": { # Specifies how metastore metadata should be integrated with external services. # Optional. The setting that defines how metastore metadata should be integrated with external services and systems.
"dataCatalogConfig": { # Specifies how metastore metadata should be integrated with the Data Catalog service. # Optional. The integration config for the Data Catalog service.
"enabled": True or False, # Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.
},
},
"metadataManagementActivity": { # The metadata management activities of the metastore service. # Output only. The metadata management activities of the metastore service.
"metadataExports": [ # Output only. The latest metadata exports of the metastore service.
{ # The details of a metadata export operation.
"databaseDumpType": "A String", # Output only. The type of the database dump.
"destinationGcsUri": "A String", # Output only. A Cloud Storage URI of a folder that metadata are exported to, in the form of gs:////, where is automatically generated.
"endTime": "A String", # Output only. The time when the export ended.
"startTime": "A String", # Output only. The time when the export started.
"state": "A String", # Output only. The current state of the export.
},
],
"restores": [ # Output only. The latest restores of the metastore service.
{ # The details of a metadata restore operation.
"backup": "A String", # Output only. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.
"backupLocation": "A String", # Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///.
"details": "A String", # Output only. The restore details containing the revision of the service to be restored to, in format of JSON.
"endTime": "A String", # Output only. The time when the restore ended.
"startTime": "A String", # Output only. The time when the restore started.
"state": "A String", # Output only. The current state of the restore.
"type": "A String", # Output only. The type of restore.
},
],
},
"name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
"network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}.
"networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service.
"consumers": [ # Immutable. The consumer-side network configuration for the Dataproc Metastore instance.
{ # Contains information of the customer's network configurations.
"endpointLocation": "A String", # Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"subnetwork": "A String", # Immutable. The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form:projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}
},
],
},
"port": 42, # The TCP port at which the metastore service is reached. Default: 9083.
"releaseChannel": "A String", # Immutable. The release channel of the service. If unspecified, defaults to STABLE.
"scalingConfig": { # Represents the scaling configuration of a metastore service. # Scaling configuration of the metastore service.
"instanceSize": "A String", # An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))
"scalingFactor": 3.14, # Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0.
},
"scheduledBackup": { # This specifies the configuration of scheduled backup. # Optional. The configuration of scheduled backup for the metastore service.
"backupLocation": "A String", # Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.
"cronSchedule": "A String", # Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.
"enabled": True or False, # Optional. Defines whether the scheduled backup is enabled. The default value is false.
"latestBackup": { # The details of the latest scheduled backup. # Output only. The details of the latest scheduled backup.
"backupId": "A String", # Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
"duration": "A String", # Output only. The duration of the backup completion.
"startTime": "A String", # Output only. The time when the backup was started.
"state": "A String", # Output only. The current state of the backup.
},
"nextScheduledTime": "A String", # Output only. The time when the next backups execution is scheduled to start.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.
},
"state": "A String", # Output only. The current state of the metastore service.
"stateMessage": "A String", # Output only. Additional information about the current state of the metastore service, if available.
"telemetryConfig": { # Telemetry Configuration for the Dataproc Metastore service. # The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.
"logFormat": "A String", # The output format of the Dataproc Metastore service's logs.
},
"tier": "A String", # The tier of the service.
"uid": "A String", # Output only. The globally unique resource identifier of the metastore service.
"updateTime": "A String", # Output only. The time when the metastore service was last updated.
}
requestId: string, Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
serviceId: string, Required. The ID of the metastore service, which is used as the final component of the metastore service's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
<pre>Deletes a single service.
Args:
name: string, Required. The relative resource name of the metastore service to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}. (required)
requestId: string, Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="exportMetadata">exportMetadata(service, body=None, x__xgafv=None)</code>
<pre>Exports metadata from a service.
Args:
service: string, Required. The relative resource name of the metastore service to run export, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for DataprocMetastore.ExportMetadata.
"databaseDumpType": "A String", # Optional. The type of the database dump. If unspecified, defaults to MYSQL.
"destinationGcsFolder": "A String", # A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing exported files will be created below it.
"requestId": "A String", # Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets the details of a single service.
Args:
name: string, Required. The relative resource name of the metastore service to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A managed metastore service that serves metadata queries.
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"hiveMetastoreConfig": { # Specifies configuration information specific to running Hive metastore software as the metastore service. # Configuration information specific to running Hive metastore software as the metastore service.
"auxiliaryVersions": { # A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
"a_key": { # Configuration information for the auxiliary service versions.
"configOverrides": { # A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.
"a_key": "A String",
},
"networkConfig": { # Network configuration for the Dataproc Metastore service. # Output only. The network configuration contains the endpoint URI(s) of the auxiliary Hive metastore service.
"consumers": [ # Immutable. The consumer-side network configuration for the Dataproc Metastore instance.
{ # Contains information of the customer's network configurations.
"endpointLocation": "A String", # Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"subnetwork": "A String", # Immutable. The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form:projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}
},
],
},
"version": "A String", # The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.
},
},
"configOverrides": { # A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version's AuxiliaryVersionConfig.
"a_key": "A String",
},
"endpointProtocol": "A String", # The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT.
"kerberosConfig": { # Configuration information for a Kerberos principal. # Information used to configure the Hive metastore service as a service principal in a Kerberos realm. To disable Kerberos, use the UpdateService method and specify this field's path (hive_metastore_config.kerberos_config) in the request's update_mask while omitting this field from the request's service.
"keytab": { # A securely stored value. # A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
"cloudSecret": "A String", # The relative resource name of a Secret Manager secret version, in the following form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}.
},
"krb5ConfigGcsUri": "A String", # A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.
"principal": "A String", # A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form primary/instance@REALM, but there is no exact format.
},
"version": "A String", # Immutable. The Hive metastore schema version.
},
"labels": { # User-defined labels for the metastore service.
"a_key": "A String",
},
"maintenanceWindow": { # Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service. # The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type.
"dayOfWeek": "A String", # The day of week, when the window starts.
"hourOfDay": 42, # The hour of day (0-23) when the window starts.
},
"metadataIntegration": { # Specifies how metastore metadata should be integrated with external services. # Optional. The setting that defines how metastore metadata should be integrated with external services and systems.
"dataCatalogConfig": { # Specifies how metastore metadata should be integrated with the Data Catalog service. # Optional. The integration config for the Data Catalog service.
"enabled": True or False, # Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.
},
},
"metadataManagementActivity": { # The metadata management activities of the metastore service. # Output only. The metadata management activities of the metastore service.
"metadataExports": [ # Output only. The latest metadata exports of the metastore service.
{ # The details of a metadata export operation.
"databaseDumpType": "A String", # Output only. The type of the database dump.
"destinationGcsUri": "A String", # Output only. A Cloud Storage URI of a folder that metadata are exported to, in the form of gs:////, where is automatically generated.
"endTime": "A String", # Output only. The time when the export ended.
"startTime": "A String", # Output only. The time when the export started.
"state": "A String", # Output only. The current state of the export.
},
],
"restores": [ # Output only. The latest restores of the metastore service.
{ # The details of a metadata restore operation.
"backup": "A String", # Output only. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.
"backupLocation": "A String", # Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///.
"details": "A String", # Output only. The restore details containing the revision of the service to be restored to, in format of JSON.
"endTime": "A String", # Output only. The time when the restore ended.
"startTime": "A String", # Output only. The time when the restore started.
"state": "A String", # Output only. The current state of the restore.
"type": "A String", # Output only. The type of restore.
},
],
},
"name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
"network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}.
"networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service.
"consumers": [ # Immutable. The consumer-side network configuration for the Dataproc Metastore instance.
{ # Contains information of the customer's network configurations.
"endpointLocation": "A String", # Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"subnetwork": "A String", # Immutable. The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form:projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}
},
],
},
"port": 42, # The TCP port at which the metastore service is reached. Default: 9083.
"releaseChannel": "A String", # Immutable. The release channel of the service. If unspecified, defaults to STABLE.
"scalingConfig": { # Represents the scaling configuration of a metastore service. # Scaling configuration of the metastore service.
"instanceSize": "A String", # An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))
"scalingFactor": 3.14, # Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0.
},
"scheduledBackup": { # This specifies the configuration of scheduled backup. # Optional. The configuration of scheduled backup for the metastore service.
"backupLocation": "A String", # Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.
"cronSchedule": "A String", # Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.
"enabled": True or False, # Optional. Defines whether the scheduled backup is enabled. The default value is false.
"latestBackup": { # The details of the latest scheduled backup. # Output only. The details of the latest scheduled backup.
"backupId": "A String", # Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
"duration": "A String", # Output only. The duration of the backup completion.
"startTime": "A String", # Output only. The time when the backup was started.
"state": "A String", # Output only. The current state of the backup.
},
"nextScheduledTime": "A String", # Output only. The time when the next backups execution is scheduled to start.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.
},
"state": "A String", # Output only. The current state of the metastore service.
"stateMessage": "A String", # Output only. Additional information about the current state of the metastore service, if available.
"telemetryConfig": { # Telemetry Configuration for the Dataproc Metastore service. # The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.
"logFormat": "A String", # The output format of the Dataproc Metastore service's logs.
},
"tier": "A String", # The tier of the service.
"uid": "A String", # Output only. The globally unique resource identifier of the metastore service.
"updateTime": "A String", # Output only. The time when the metastore service was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
},
],
"bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
{ # Associates members, or principals, with a role.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
"A String",
],
"role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists services in a project and location.
Args:
parent: string, Required. The relative resource name of the location of metastore services to list, in the following form:projects/{project_number}/locations/{location_id}. (required)
filter: string, Optional. The filter to apply to list results.
orderBy: string, Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.
pageSize: integer, Optional. The maximum number of services to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.
pageToken: string, Optional. A page token, received from a previous DataprocMetastore.ListServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to DataprocMetastore.ListServices must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for DataprocMetastore.ListServices.
"nextPageToken": "A String", # A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
"services": [ # The services in the specified location.
{ # A managed metastore service that serves metadata queries.
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"hiveMetastoreConfig": { # Specifies configuration information specific to running Hive metastore software as the metastore service. # Configuration information specific to running Hive metastore software as the metastore service.
"auxiliaryVersions": { # A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
"a_key": { # Configuration information for the auxiliary service versions.
"configOverrides": { # A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.
"a_key": "A String",
},
"networkConfig": { # Network configuration for the Dataproc Metastore service. # Output only. The network configuration contains the endpoint URI(s) of the auxiliary Hive metastore service.
"consumers": [ # Immutable. The consumer-side network configuration for the Dataproc Metastore instance.
{ # Contains information of the customer's network configurations.
"endpointLocation": "A String", # Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"subnetwork": "A String", # Immutable. The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form:projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}
},
],
},
"version": "A String", # The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.
},
},
"configOverrides": { # A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version's AuxiliaryVersionConfig.
"a_key": "A String",
},
"endpointProtocol": "A String", # The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT.
"kerberosConfig": { # Configuration information for a Kerberos principal. # Information used to configure the Hive metastore service as a service principal in a Kerberos realm. To disable Kerberos, use the UpdateService method and specify this field's path (hive_metastore_config.kerberos_config) in the request's update_mask while omitting this field from the request's service.
"keytab": { # A securely stored value. # A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
"cloudSecret": "A String", # The relative resource name of a Secret Manager secret version, in the following form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}.
},
"krb5ConfigGcsUri": "A String", # A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.
"principal": "A String", # A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form primary/instance@REALM, but there is no exact format.
},
"version": "A String", # Immutable. The Hive metastore schema version.
},
"labels": { # User-defined labels for the metastore service.
"a_key": "A String",
},
"maintenanceWindow": { # Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service. # The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type.
"dayOfWeek": "A String", # The day of week, when the window starts.
"hourOfDay": 42, # The hour of day (0-23) when the window starts.
},
"metadataIntegration": { # Specifies how metastore metadata should be integrated with external services. # Optional. The setting that defines how metastore metadata should be integrated with external services and systems.
"dataCatalogConfig": { # Specifies how metastore metadata should be integrated with the Data Catalog service. # Optional. The integration config for the Data Catalog service.
"enabled": True or False, # Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.
},
},
"metadataManagementActivity": { # The metadata management activities of the metastore service. # Output only. The metadata management activities of the metastore service.
"metadataExports": [ # Output only. The latest metadata exports of the metastore service.
{ # The details of a metadata export operation.
"databaseDumpType": "A String", # Output only. The type of the database dump.
"destinationGcsUri": "A String", # Output only. A Cloud Storage URI of a folder that metadata are exported to, in the form of gs:////, where is automatically generated.
"endTime": "A String", # Output only. The time when the export ended.
"startTime": "A String", # Output only. The time when the export started.
"state": "A String", # Output only. The current state of the export.
},
],
"restores": [ # Output only. The latest restores of the metastore service.
{ # The details of a metadata restore operation.
"backup": "A String", # Output only. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.
"backupLocation": "A String", # Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///.
"details": "A String", # Output only. The restore details containing the revision of the service to be restored to, in format of JSON.
"endTime": "A String", # Output only. The time when the restore ended.
"startTime": "A String", # Output only. The time when the restore started.
"state": "A String", # Output only. The current state of the restore.
"type": "A String", # Output only. The type of restore.
},
],
},
"name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
"network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}.
"networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service.
"consumers": [ # Immutable. The consumer-side network configuration for the Dataproc Metastore instance.
{ # Contains information of the customer's network configurations.
"endpointLocation": "A String", # Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"subnetwork": "A String", # Immutable. The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form:projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}
},
],
},
"port": 42, # The TCP port at which the metastore service is reached. Default: 9083.
"releaseChannel": "A String", # Immutable. The release channel of the service. If unspecified, defaults to STABLE.
"scalingConfig": { # Represents the scaling configuration of a metastore service. # Scaling configuration of the metastore service.
"instanceSize": "A String", # An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))
"scalingFactor": 3.14, # Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0.
},
"scheduledBackup": { # This specifies the configuration of scheduled backup. # Optional. The configuration of scheduled backup for the metastore service.
"backupLocation": "A String", # Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.
"cronSchedule": "A String", # Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.
"enabled": True or False, # Optional. Defines whether the scheduled backup is enabled. The default value is false.
"latestBackup": { # The details of the latest scheduled backup. # Output only. The details of the latest scheduled backup.
"backupId": "A String", # Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
"duration": "A String", # Output only. The duration of the backup completion.
"startTime": "A String", # Output only. The time when the backup was started.
"state": "A String", # Output only. The current state of the backup.
},
"nextScheduledTime": "A String", # Output only. The time when the next backups execution is scheduled to start.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.
},
"state": "A String", # Output only. The current state of the metastore service.
"stateMessage": "A String", # Output only. Additional information about the current state of the metastore service, if available.
"telemetryConfig": { # Telemetry Configuration for the Dataproc Metastore service. # The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.
"logFormat": "A String", # The output format of the Dataproc Metastore service's logs.
},
"tier": "A String", # The tier of the service.
"uid": "A String", # Output only. The globally unique resource identifier of the metastore service.
"updateTime": "A String", # Output only. The time when the metastore service was last updated.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="moveTableToDatabase">moveTableToDatabase(service, body=None, x__xgafv=None)</code>
<pre>Move a table to another database.
Args:
service: string, Required. The relative resource name of the metastore service to mutate metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for DataprocMetastore.MoveTableToDatabase.
"dbName": "A String", # Required. The name of the database where the table resides.
"destinationDbName": "A String", # Required. The name of the database where the table should be moved.
"tableName": "A String", # Required. The name of the table to be moved.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the parameters of a single service.
Args:
name: string, Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. (required)
body: object, The request body.
The object takes the form of:
{ # A managed metastore service that serves metadata queries.
"artifactGcsUri": "A String", # Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
"createTime": "A String", # Output only. The time when the metastore service was created.
"databaseType": "A String", # Immutable. The database type that the Metastore service stores its data.
"encryptionConfig": { # Encryption settings for the service. # Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.
"kmsKey": "A String", # The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.
},
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"hiveMetastoreConfig": { # Specifies configuration information specific to running Hive metastore software as the metastore service. # Configuration information specific to running Hive metastore software as the metastore service.
"auxiliaryVersions": { # A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
"a_key": { # Configuration information for the auxiliary service versions.
"configOverrides": { # A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.
"a_key": "A String",
},
"networkConfig": { # Network configuration for the Dataproc Metastore service. # Output only. The network configuration contains the endpoint URI(s) of the auxiliary Hive metastore service.
"consumers": [ # Immutable. The consumer-side network configuration for the Dataproc Metastore instance.
{ # Contains information of the customer's network configurations.
"endpointLocation": "A String", # Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"subnetwork": "A String", # Immutable. The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form:projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}
},
],
},
"version": "A String", # The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.
},
},
"configOverrides": { # A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version's AuxiliaryVersionConfig.
"a_key": "A String",
},
"endpointProtocol": "A String", # The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT.
"kerberosConfig": { # Configuration information for a Kerberos principal. # Information used to configure the Hive metastore service as a service principal in a Kerberos realm. To disable Kerberos, use the UpdateService method and specify this field's path (hive_metastore_config.kerberos_config) in the request's update_mask while omitting this field from the request's service.
"keytab": { # A securely stored value. # A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
"cloudSecret": "A String", # The relative resource name of a Secret Manager secret version, in the following form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}.
},
"krb5ConfigGcsUri": "A String", # A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.
"principal": "A String", # A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form primary/instance@REALM, but there is no exact format.
},
"version": "A String", # Immutable. The Hive metastore schema version.
},
"labels": { # User-defined labels for the metastore service.
"a_key": "A String",
},
"maintenanceWindow": { # Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service. # The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type.
"dayOfWeek": "A String", # The day of week, when the window starts.
"hourOfDay": 42, # The hour of day (0-23) when the window starts.
},
"metadataIntegration": { # Specifies how metastore metadata should be integrated with external services. # Optional. The setting that defines how metastore metadata should be integrated with external services and systems.
"dataCatalogConfig": { # Specifies how metastore metadata should be integrated with the Data Catalog service. # Optional. The integration config for the Data Catalog service.
"enabled": True or False, # Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.
},
},
"metadataManagementActivity": { # The metadata management activities of the metastore service. # Output only. The metadata management activities of the metastore service.
"metadataExports": [ # Output only. The latest metadata exports of the metastore service.
{ # The details of a metadata export operation.
"databaseDumpType": "A String", # Output only. The type of the database dump.
"destinationGcsUri": "A String", # Output only. A Cloud Storage URI of a folder that metadata are exported to, in the form of gs:////, where is automatically generated.
"endTime": "A String", # Output only. The time when the export ended.
"startTime": "A String", # Output only. The time when the export started.
"state": "A String", # Output only. The current state of the export.
},
],
"restores": [ # Output only. The latest restores of the metastore service.
{ # The details of a metadata restore operation.
"backup": "A String", # Output only. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.
"backupLocation": "A String", # Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///.
"details": "A String", # Output only. The restore details containing the revision of the service to be restored to, in format of JSON.
"endTime": "A String", # Output only. The time when the restore ended.
"startTime": "A String", # Output only. The time when the restore started.
"state": "A String", # Output only. The current state of the restore.
"type": "A String", # Output only. The type of restore.
},
],
},
"name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
"network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}.
"networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service.
"consumers": [ # Immutable. The consumer-side network configuration for the Dataproc Metastore instance.
{ # Contains information of the customer's network configurations.
"endpointLocation": "A String", # Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.
"endpointUri": "A String", # Output only. The URI of the endpoint used to access the metastore service.
"subnetwork": "A String", # Immutable. The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form:projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}
},
],
},
"port": 42, # The TCP port at which the metastore service is reached. Default: 9083.
"releaseChannel": "A String", # Immutable. The release channel of the service. If unspecified, defaults to STABLE.
"scalingConfig": { # Represents the scaling configuration of a metastore service. # Scaling configuration of the metastore service.
"instanceSize": "A String", # An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))
"scalingFactor": 3.14, # Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0.
},
"scheduledBackup": { # This specifies the configuration of scheduled backup. # Optional. The configuration of scheduled backup for the metastore service.
"backupLocation": "A String", # Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.
"cronSchedule": "A String", # Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.
"enabled": True or False, # Optional. Defines whether the scheduled backup is enabled. The default value is false.
"latestBackup": { # The details of the latest scheduled backup. # Output only. The details of the latest scheduled backup.
"backupId": "A String", # Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
"duration": "A String", # Output only. The duration of the backup completion.
"startTime": "A String", # Output only. The time when the backup was started.
"state": "A String", # Output only. The current state of the backup.
},
"nextScheduledTime": "A String", # Output only. The time when the next backups execution is scheduled to start.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.
},
"state": "A String", # Output only. The current state of the metastore service.
"stateMessage": "A String", # Output only. Additional information about the current state of the metastore service, if available.
"telemetryConfig": { # Telemetry Configuration for the Dataproc Metastore service. # The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.
"logFormat": "A String", # The output format of the Dataproc Metastore service's logs.
},
"tier": "A String", # The tier of the service.
"uid": "A String", # Output only. The globally unique resource identifier of the metastore service.
"updateTime": "A String", # Output only. The time when the metastore service was last updated.
}
requestId: string, Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
updateMask: string, Required. A field mask used to specify the fields to be overwritten in the metastore service resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="queryMetadata">queryMetadata(service, body=None, x__xgafv=None)</code>
<pre>Query DPMS metadata.
Args:
service: string, Required. The relative resource name of the metastore service to query metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for DataprocMetastore.QueryMetadata.
"query": "A String", # Required. A read-only SQL query to execute against the metadata database. The query cannot change or mutate the data.