google-cloud-metastore-v1 0.6.0 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -28,8 +28,8 @@ module Google
28
28
  # software as the metastore service.
29
29
  # @!attribute [rw] name
30
30
  # @return [::String]
31
- # Immutable. The relative resource name of the metastore service, in the following
32
- # format:
31
+ # Immutable. The relative resource name of the metastore service, in the
32
+ # following format:
33
33
  #
34
34
  # `projects/{project_number}/locations/{location_id}/services/{service_id}`.
35
35
  # @!attribute [r] create_time
@@ -43,8 +43,8 @@ module Google
43
43
  # User-defined labels for the metastore service.
44
44
  # @!attribute [rw] network
45
45
  # @return [::String]
46
- # Immutable. The relative resource name of the VPC network on which the instance can be
47
- # accessed. It is specified in the following form:
46
+ # Immutable. The relative resource name of the VPC network on which the
47
+ # instance can be accessed. It is specified in the following form:
48
48
  #
49
49
  # `projects/{project_number}/global/networks/{network_id}`.
50
50
  # @!attribute [r] endpoint_uri
@@ -58,12 +58,12 @@ module Google
58
58
  # Output only. The current state of the metastore service.
59
59
  # @!attribute [r] state_message
60
60
  # @return [::String]
61
- # Output only. Additional information about the current state of the metastore service, if
62
- # available.
61
+ # Output only. Additional information about the current state of the
62
+ # metastore service, if available.
63
63
  # @!attribute [r] artifact_gcs_uri
64
64
  # @return [::String]
65
- # Output only. A Cloud Storage URI (starting with `gs://`) that specifies where artifacts
66
- # related to the metastore service are stored.
65
+ # Output only. A Cloud Storage URI (starting with `gs://`) that specifies
66
+ # where artifacts related to the metastore service are stored.
67
67
  # @!attribute [rw] tier
68
68
  # @return [::Google::Cloud::Metastore::V1::Service::Tier]
69
69
  # The tier of the service.
@@ -75,7 +75,8 @@ module Google
75
75
  # database type.
76
76
  # @!attribute [r] uid
77
77
  # @return [::String]
78
- # Output only. The globally unique resource identifier of the metastore service.
78
+ # Output only. The globally unique resource identifier of the metastore
79
+ # service.
79
80
  # @!attribute [r] metadata_management_activity
80
81
  # @return [::Google::Cloud::Metastore::V1::MetadataManagementActivity]
81
82
  # Output only. The metadata management activities of the metastore service.
@@ -85,8 +86,8 @@ module Google
85
86
  # If unspecified, defaults to `STABLE`.
86
87
  # @!attribute [rw] encryption_config
87
88
  # @return [::Google::Cloud::Metastore::V1::EncryptionConfig]
88
- # Immutable. Information used to configure the Dataproc Metastore service to encrypt
89
- # customer data at rest. Cannot be updated.
89
+ # Immutable. Information used to configure the Dataproc Metastore service to
90
+ # encrypt customer data at rest. Cannot be updated.
90
91
  # @!attribute [rw] network_config
91
92
  # @return [::Google::Cloud::Metastore::V1::NetworkConfig]
92
93
  # The configuration specifying the network settings for the
@@ -98,6 +99,9 @@ module Google
98
99
  # @return [::Google::Cloud::Metastore::V1::TelemetryConfig]
99
100
  # The configuration specifying telemetry settings for the Dataproc Metastore
100
101
  # service. If unspecified defaults to `JSON`.
102
+ # @!attribute [rw] scaling_config
103
+ # @return [::Google::Cloud::Metastore::V1::ScalingConfig]
104
+ # Scaling configuration of the metastore service.
101
105
  class Service
102
106
  include ::Google::Protobuf::MessageExts
103
107
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -217,6 +221,16 @@ module Google
217
221
  # method and specify this field's path
218
222
  # (`hive_metastore_config.kerberos_config`) in the request's `update_mask`
219
223
  # while omitting this field from the request's `service`.
224
+ # @!attribute [rw] auxiliary_versions
225
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Metastore::V1::AuxiliaryVersionConfig}]
226
+ # A mapping of Hive metastore version to the auxiliary version
227
+ # configuration. When specified, a secondary Hive metastore service is
228
+ # created along with the primary service. All auxiliary versions must be less
229
+ # than the service's primary version. The key is the auxiliary service name
230
+ # and it must match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. This
231
+ # means that the first character must be a lowercase letter, and all the
232
+ # following characters must be hyphens, lowercase letters, or digits, except
233
+ # the last character, which cannot be a hyphen.
220
234
  class HiveMetastoreConfig
221
235
  include ::Google::Protobuf::MessageExts
222
236
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -229,6 +243,15 @@ module Google
229
243
  include ::Google::Protobuf::MessageExts
230
244
  extend ::Google::Protobuf::MessageExts::ClassMethods
231
245
  end
246
+
247
+ # @!attribute [rw] key
248
+ # @return [::String]
249
+ # @!attribute [rw] value
250
+ # @return [::Google::Cloud::Metastore::V1::AuxiliaryVersionConfig]
251
+ class AuxiliaryVersionsEntry
252
+ include ::Google::Protobuf::MessageExts
253
+ extend ::Google::Protobuf::MessageExts::ClassMethods
254
+ end
232
255
  end
233
256
 
234
257
  # Configuration information for a Kerberos principal.
@@ -275,11 +298,41 @@ module Google
275
298
  extend ::Google::Protobuf::MessageExts::ClassMethods
276
299
  end
277
300
 
301
+ # Configuration information for the auxiliary service versions.
302
+ # @!attribute [rw] version
303
+ # @return [::String]
304
+ # The Hive metastore version of the auxiliary service. It must be less
305
+ # than the primary Hive metastore service's version.
306
+ # @!attribute [rw] config_overrides
307
+ # @return [::Google::Protobuf::Map{::String => ::String}]
308
+ # A mapping of Hive metastore configuration key-value pairs to apply to the
309
+ # auxiliary Hive metastore (configured in `hive-site.xml`) in addition to
310
+ # the primary version's overrides. If keys are present in both the auxiliary
311
+ # version's overrides and the primary version's overrides, the value from
312
+ # the auxiliary version's overrides takes precedence.
313
+ # @!attribute [r] network_config
314
+ # @return [::Google::Cloud::Metastore::V1::NetworkConfig]
315
+ # Output only. The network configuration contains the endpoint URI(s) of the
316
+ # auxiliary Hive metastore service.
317
+ class AuxiliaryVersionConfig
318
+ include ::Google::Protobuf::MessageExts
319
+ extend ::Google::Protobuf::MessageExts::ClassMethods
320
+
321
+ # @!attribute [rw] key
322
+ # @return [::String]
323
+ # @!attribute [rw] value
324
+ # @return [::String]
325
+ class ConfigOverridesEntry
326
+ include ::Google::Protobuf::MessageExts
327
+ extend ::Google::Protobuf::MessageExts::ClassMethods
328
+ end
329
+ end
330
+
278
331
  # Network configuration for the Dataproc Metastore service.
279
332
  # @!attribute [rw] consumers
280
333
  # @return [::Array<::Google::Cloud::Metastore::V1::NetworkConfig::Consumer>]
281
- # Immutable. The consumer-side network configuration for the Dataproc Metastore
282
- # instance.
334
+ # Immutable. The consumer-side network configuration for the Dataproc
335
+ # Metastore instance.
283
336
  class NetworkConfig
284
337
  include ::Google::Protobuf::MessageExts
285
338
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -287,8 +340,8 @@ module Google
287
340
  # Contains information of the customer's network configurations.
288
341
  # @!attribute [rw] subnetwork
289
342
  # @return [::String]
290
- # Immutable. The subnetwork of the customer project from which an IP address is
291
- # reserved and used as the Dataproc Metastore service's
343
+ # Immutable. The subnetwork of the customer project from which an IP
344
+ # address is reserved and used as the Dataproc Metastore service's
292
345
  # endpoint. It is accessible to hosts in the subnet and to all
293
346
  # hosts in a subnet in the same region and same network. There must
294
347
  # be at least one IP address available in the subnet's primary range. The
@@ -297,7 +350,8 @@ module Google
297
350
  # `projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}`
298
351
  # @!attribute [r] endpoint_uri
299
352
  # @return [::String]
300
- # Output only. The URI of the endpoint used to access the metastore service.
353
+ # Output only. The URI of the endpoint used to access the metastore
354
+ # service.
301
355
  class Consumer
302
356
  include ::Google::Protobuf::MessageExts
303
357
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -375,7 +429,8 @@ module Google
375
429
  # to import metadata. It must begin with `gs://`.
376
430
  # @!attribute [rw] type
377
431
  # @return [::Google::Cloud::Metastore::V1::DatabaseDumpSpec::Type]
378
- # Optional. The type of the database dump. If unspecified, defaults to `MYSQL`.
432
+ # Optional. The type of the database dump. If unspecified, defaults to
433
+ # `MYSQL`.
379
434
  class DatabaseDump
380
435
  include ::Google::Protobuf::MessageExts
381
436
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -413,8 +468,9 @@ module Google
413
468
  # The details of a metadata export operation.
414
469
  # @!attribute [r] destination_gcs_uri
415
470
  # @return [::String]
416
- # Output only. A Cloud Storage URI of a folder that metadata are exported to, in the
417
- # form of `gs://<bucket_name>/<path_inside_bucket>/<export_folder>`, where
471
+ # Output only. A Cloud Storage URI of a folder that metadata are exported
472
+ # to, in the form of
473
+ # `gs://<bucket_name>/<path_inside_bucket>/<export_folder>`, where
418
474
  # `<export_folder>` is automatically generated.
419
475
  # @!attribute [r] start_time
420
476
  # @return [::Google::Protobuf::Timestamp]
@@ -513,8 +569,8 @@ module Google
513
569
  # Output only. The current state of the restore.
514
570
  # @!attribute [r] backup
515
571
  # @return [::String]
516
- # Output only. The relative resource name of the metastore service backup to restore
517
- # from, in the following form:
572
+ # Output only. The relative resource name of the metastore service backup to
573
+ # restore from, in the following form:
518
574
  #
519
575
  # `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`.
520
576
  # @!attribute [r] type
@@ -522,8 +578,8 @@ module Google
522
578
  # Output only. The type of restore.
523
579
  # @!attribute [r] details
524
580
  # @return [::String]
525
- # Output only. The restore details containing the revision of the service to be restored
526
- # to, in format of JSON.
581
+ # Output only. The restore details containing the revision of the service to
582
+ # be restored to, in format of JSON.
527
583
  class Restore
528
584
  include ::Google::Protobuf::MessageExts
529
585
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -559,28 +615,66 @@ module Google
559
615
  end
560
616
  end
561
617
 
562
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}.
618
+ # Represents the scaling configuration of a metastore service.
619
+ # @!attribute [rw] instance_size
620
+ # @return [::Google::Cloud::Metastore::V1::ScalingConfig::InstanceSize]
621
+ # An enum of readable instance sizes, with each instance size mapping to a
622
+ # float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))
623
+ # @!attribute [rw] scaling_factor
624
+ # @return [::Float]
625
+ # Scaling factor, increments of 0.1 for values less than 1.0, and
626
+ # increments of 1.0 for values greater than 1.0.
627
+ class ScalingConfig
628
+ include ::Google::Protobuf::MessageExts
629
+ extend ::Google::Protobuf::MessageExts::ClassMethods
630
+
631
+ # Metastore instance sizes.
632
+ module InstanceSize
633
+ # Unspecified instance size
634
+ INSTANCE_SIZE_UNSPECIFIED = 0
635
+
636
+ # Extra small instance size, maps to a scaling factor of 0.1.
637
+ EXTRA_SMALL = 1
638
+
639
+ # Small instance size, maps to a scaling factor of 0.5.
640
+ SMALL = 2
641
+
642
+ # Medium instance size, maps to a scaling factor of 1.0.
643
+ MEDIUM = 3
644
+
645
+ # Large instance size, maps to a scaling factor of 3.0.
646
+ LARGE = 4
647
+
648
+ # Extra large instance size, maps to a scaling factor of 6.0.
649
+ EXTRA_LARGE = 5
650
+ end
651
+ end
652
+
653
+ # Request message for
654
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}.
563
655
  # @!attribute [rw] parent
564
656
  # @return [::String]
565
- # Required. The relative resource name of the location of metastore services to
566
- # list, in the following form:
657
+ # Required. The relative resource name of the location of metastore services
658
+ # to list, in the following form:
567
659
  #
568
660
  # `projects/{project_number}/locations/{location_id}`.
569
661
  # @!attribute [rw] page_size
570
662
  # @return [::Integer]
571
- # Optional. The maximum number of services to return. The response may contain less
572
- # than the maximum number. If unspecified, no more than 500 services are
573
- # returned. The maximum value is 1000; values above 1000 are changed to 1000.
663
+ # Optional. The maximum number of services to return. The response may
664
+ # contain less than the maximum number. If unspecified, no more than 500
665
+ # services are returned. The maximum value is 1000; values above 1000 are
666
+ # changed to 1000.
574
667
  # @!attribute [rw] page_token
575
668
  # @return [::String]
576
- # Optional. A page token, received from a previous {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}
669
+ # Optional. A page token, received from a previous
670
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}
577
671
  # call. Provide this token to retrieve the subsequent page.
578
672
  #
579
673
  # To retrieve the first page, supply an empty page token.
580
674
  #
581
675
  # When paginating, other parameters provided to
582
- # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices} must match the call that provided the
583
- # page token.
676
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}
677
+ # must match the call that provided the page token.
584
678
  # @!attribute [rw] filter
585
679
  # @return [::String]
586
680
  # Optional. The filter to apply to list results.
@@ -594,7 +688,8 @@ module Google
594
688
  extend ::Google::Protobuf::MessageExts::ClassMethods
595
689
  end
596
690
 
597
- # Response message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}.
691
+ # Response message for
692
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}.
598
693
  # @!attribute [rw] services
599
694
  # @return [::Array<::Google::Cloud::Metastore::V1::Service>]
600
695
  # The services in the specified location.
@@ -610,11 +705,12 @@ module Google
610
705
  extend ::Google::Protobuf::MessageExts::ClassMethods
611
706
  end
612
707
 
613
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#get_service DataprocMetastore.GetService}.
708
+ # Request message for
709
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#get_service DataprocMetastore.GetService}.
614
710
  # @!attribute [rw] name
615
711
  # @return [::String]
616
- # Required. The relative resource name of the metastore service to retrieve, in the
617
- # following form:
712
+ # Required. The relative resource name of the metastore service to retrieve,
713
+ # in the following form:
618
714
  #
619
715
  # `projects/{project_number}/locations/{location_id}/services/{service_id}`.
620
716
  class GetServiceRequest
@@ -622,11 +718,12 @@ module Google
622
718
  extend ::Google::Protobuf::MessageExts::ClassMethods
623
719
  end
624
720
 
625
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#create_service DataprocMetastore.CreateService}.
721
+ # Request message for
722
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#create_service DataprocMetastore.CreateService}.
626
723
  # @!attribute [rw] parent
627
724
  # @return [::String]
628
- # Required. The relative resource name of the location in which to create a metastore
629
- # service, in the following form:
725
+ # Required. The relative resource name of the location in which to create a
726
+ # metastore service, in the following form:
630
727
  #
631
728
  # `projects/{project_number}/locations/{location_id}`.
632
729
  # @!attribute [rw] service_id
@@ -644,10 +741,10 @@ module Google
644
741
  # the request's `service_id` field.
645
742
  # @!attribute [rw] request_id
646
743
  # @return [::String]
647
- # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
648
- # request if it has completed. The server will ignore subsequent requests
649
- # that provide a duplicate request ID for at least 60 minutes after the first
650
- # request.
744
+ # Optional. A request ID. Specify a unique request ID to allow the server to
745
+ # ignore the request if it has completed. The server will ignore subsequent
746
+ # requests that provide a duplicate request ID for at least 60 minutes after
747
+ # the first request.
651
748
  #
652
749
  # For example, if an initial request times out, followed by another request
653
750
  # with the same request ID, the server ignores the second request to prevent
@@ -661,7 +758,8 @@ module Google
661
758
  extend ::Google::Protobuf::MessageExts::ClassMethods
662
759
  end
663
760
 
664
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#update_service DataprocMetastore.UpdateService}.
761
+ # Request message for
762
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#update_service DataprocMetastore.UpdateService}.
665
763
  # @!attribute [rw] update_mask
666
764
  # @return [::Google::Protobuf::FieldMask]
667
765
  # Required. A field mask used to specify the fields to be overwritten in the
@@ -677,10 +775,10 @@ module Google
677
775
  # service to be updated.
678
776
  # @!attribute [rw] request_id
679
777
  # @return [::String]
680
- # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
681
- # request if it has completed. The server will ignore subsequent requests
682
- # that provide a duplicate request ID for at least 60 minutes after the first
683
- # request.
778
+ # Optional. A request ID. Specify a unique request ID to allow the server to
779
+ # ignore the request if it has completed. The server will ignore subsequent
780
+ # requests that provide a duplicate request ID for at least 60 minutes after
781
+ # the first request.
684
782
  #
685
783
  # For example, if an initial request times out, followed by another request
686
784
  # with the same request ID, the server ignores the second request to prevent
@@ -694,19 +792,20 @@ module Google
694
792
  extend ::Google::Protobuf::MessageExts::ClassMethods
695
793
  end
696
794
 
697
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#delete_service DataprocMetastore.DeleteService}.
795
+ # Request message for
796
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#delete_service DataprocMetastore.DeleteService}.
698
797
  # @!attribute [rw] name
699
798
  # @return [::String]
700
- # Required. The relative resource name of the metastore service to delete, in the
701
- # following form:
799
+ # Required. The relative resource name of the metastore service to delete, in
800
+ # the following form:
702
801
  #
703
802
  # `projects/{project_number}/locations/{location_id}/services/{service_id}`.
704
803
  # @!attribute [rw] request_id
705
804
  # @return [::String]
706
- # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
707
- # request if it has completed. The server will ignore subsequent requests
708
- # that provide a duplicate request ID for at least 60 minutes after the first
709
- # request.
805
+ # Optional. A request ID. Specify a unique request ID to allow the server to
806
+ # ignore the request if it has completed. The server will ignore subsequent
807
+ # requests that provide a duplicate request ID for at least 60 minutes after
808
+ # the first request.
710
809
  #
711
810
  # For example, if an initial request times out, followed by another request
712
811
  # with the same request ID, the server ignores the second request to prevent
@@ -720,28 +819,30 @@ module Google
720
819
  extend ::Google::Protobuf::MessageExts::ClassMethods
721
820
  end
722
821
 
723
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_metadata_imports DataprocMetastore.ListMetadataImports}.
822
+ # Request message for
823
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_metadata_imports DataprocMetastore.ListMetadataImports}.
724
824
  # @!attribute [rw] parent
725
825
  # @return [::String]
726
- # Required. The relative resource name of the service whose metadata imports to
727
- # list, in the following form:
826
+ # Required. The relative resource name of the service whose metadata imports
827
+ # to list, in the following form:
728
828
  #
729
829
  # `projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports`.
730
830
  # @!attribute [rw] page_size
731
831
  # @return [::Integer]
732
- # Optional. The maximum number of imports to return. The response may contain less
733
- # than the maximum number. If unspecified, no more than 500 imports are
832
+ # Optional. The maximum number of imports to return. The response may contain
833
+ # less than the maximum number. If unspecified, no more than 500 imports are
734
834
  # returned. The maximum value is 1000; values above 1000 are changed to 1000.
735
835
  # @!attribute [rw] page_token
736
836
  # @return [::String]
737
- # Optional. A page token, received from a previous {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}
837
+ # Optional. A page token, received from a previous
838
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}
738
839
  # call. Provide this token to retrieve the subsequent page.
739
840
  #
740
841
  # To retrieve the first page, supply an empty page token.
741
842
  #
742
843
  # When paginating, other parameters provided to
743
- # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices} must match the call that provided the
744
- # page token.
844
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_services DataprocMetastore.ListServices}
845
+ # must match the call that provided the page token.
745
846
  # @!attribute [rw] filter
746
847
  # @return [::String]
747
848
  # Optional. The filter to apply to list results.
@@ -755,7 +856,8 @@ module Google
755
856
  extend ::Google::Protobuf::MessageExts::ClassMethods
756
857
  end
757
858
 
758
- # Response message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_metadata_imports DataprocMetastore.ListMetadataImports}.
859
+ # Response message for
860
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_metadata_imports DataprocMetastore.ListMetadataImports}.
759
861
  # @!attribute [rw] metadata_imports
760
862
  # @return [::Array<::Google::Cloud::Metastore::V1::MetadataImport>]
761
863
  # The imports in the specified service.
@@ -771,11 +873,12 @@ module Google
771
873
  extend ::Google::Protobuf::MessageExts::ClassMethods
772
874
  end
773
875
 
774
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#get_metadata_import DataprocMetastore.GetMetadataImport}.
876
+ # Request message for
877
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#get_metadata_import DataprocMetastore.GetMetadataImport}.
775
878
  # @!attribute [rw] name
776
879
  # @return [::String]
777
- # Required. The relative resource name of the metadata import to retrieve, in the
778
- # following form:
880
+ # Required. The relative resource name of the metadata import to retrieve, in
881
+ # the following form:
779
882
  #
780
883
  # `projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}`.
781
884
  class GetMetadataImportRequest
@@ -783,32 +886,33 @@ module Google
783
886
  extend ::Google::Protobuf::MessageExts::ClassMethods
784
887
  end
785
888
 
786
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#create_metadata_import DataprocMetastore.CreateMetadataImport}.
889
+ # Request message for
890
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#create_metadata_import DataprocMetastore.CreateMetadataImport}.
787
891
  # @!attribute [rw] parent
788
892
  # @return [::String]
789
- # Required. The relative resource name of the service in which to create a metastore
790
- # import, in the following form:
893
+ # Required. The relative resource name of the service in which to create a
894
+ # metastore import, in the following form:
791
895
  #
792
896
  # `projects/{project_number}/locations/{location_id}/services/{service_id}`.
793
897
  # @!attribute [rw] metadata_import_id
794
898
  # @return [::String]
795
- # Required. The ID of the metadata import, which is used as the final component of the
796
- # metadata import's name.
899
+ # Required. The ID of the metadata import, which is used as the final
900
+ # component of the metadata import's name.
797
901
  #
798
902
  # This value must be between 1 and 64 characters long, begin with a letter,
799
903
  # end with a letter or number, and consist of alpha-numeric ASCII characters
800
904
  # or hyphens.
801
905
  # @!attribute [rw] metadata_import
802
906
  # @return [::Google::Cloud::Metastore::V1::MetadataImport]
803
- # Required. The metadata import to create. The `name` field is ignored. The ID of the
804
- # created metadata import must be provided in the request's
907
+ # Required. The metadata import to create. The `name` field is ignored. The
908
+ # ID of the created metadata import must be provided in the request's
805
909
  # `metadata_import_id` field.
806
910
  # @!attribute [rw] request_id
807
911
  # @return [::String]
808
- # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
809
- # request if it has completed. The server will ignore subsequent requests
810
- # that provide a duplicate request ID for at least 60 minutes after the first
811
- # request.
912
+ # Optional. A request ID. Specify a unique request ID to allow the server to
913
+ # ignore the request if it has completed. The server will ignore subsequent
914
+ # requests that provide a duplicate request ID for at least 60 minutes after
915
+ # the first request.
812
916
  #
813
917
  # For example, if an initial request times out, followed by another request
814
918
  # with the same request ID, the server ignores the second request to prevent
@@ -822,7 +926,8 @@ module Google
822
926
  extend ::Google::Protobuf::MessageExts::ClassMethods
823
927
  end
824
928
 
825
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#update_metadata_import DataprocMetastore.UpdateMetadataImport}.
929
+ # Request message for
930
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#update_metadata_import DataprocMetastore.UpdateMetadataImport}.
826
931
  # @!attribute [rw] update_mask
827
932
  # @return [::Google::Protobuf::FieldMask]
828
933
  # Required. A field mask used to specify the fields to be overwritten in the
@@ -838,10 +943,10 @@ module Google
838
943
  # import to be updated.
839
944
  # @!attribute [rw] request_id
840
945
  # @return [::String]
841
- # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
842
- # request if it has completed. The server will ignore subsequent requests
843
- # that provide a duplicate request ID for at least 60 minutes after the first
844
- # request.
946
+ # Optional. A request ID. Specify a unique request ID to allow the server to
947
+ # ignore the request if it has completed. The server will ignore subsequent
948
+ # requests that provide a duplicate request ID for at least 60 minutes after
949
+ # the first request.
845
950
  #
846
951
  # For example, if an initial request times out, followed by another request
847
952
  # with the same request ID, the server ignores the second request to prevent
@@ -855,7 +960,8 @@ module Google
855
960
  extend ::Google::Protobuf::MessageExts::ClassMethods
856
961
  end
857
962
 
858
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_backups DataprocMetastore.ListBackups}.
963
+ # Request message for
964
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_backups DataprocMetastore.ListBackups}.
859
965
  # @!attribute [rw] parent
860
966
  # @return [::String]
861
967
  # Required. The relative resource name of the service whose backups to
@@ -864,19 +970,20 @@ module Google
864
970
  # `projects/{project_number}/locations/{location_id}/services/{service_id}/backups`.
865
971
  # @!attribute [rw] page_size
866
972
  # @return [::Integer]
867
- # Optional. The maximum number of backups to return. The response may contain less
868
- # than the maximum number. If unspecified, no more than 500 backups are
973
+ # Optional. The maximum number of backups to return. The response may contain
974
+ # less than the maximum number. If unspecified, no more than 500 backups are
869
975
  # returned. The maximum value is 1000; values above 1000 are changed to 1000.
870
976
  # @!attribute [rw] page_token
871
977
  # @return [::String]
872
- # Optional. A page token, received from a previous {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_backups DataprocMetastore.ListBackups}
978
+ # Optional. A page token, received from a previous
979
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_backups DataprocMetastore.ListBackups}
873
980
  # call. Provide this token to retrieve the subsequent page.
874
981
  #
875
982
  # To retrieve the first page, supply an empty page token.
876
983
  #
877
984
  # When paginating, other parameters provided to
878
- # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_backups DataprocMetastore.ListBackups} must match the call that provided the
879
- # page token.
985
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_backups DataprocMetastore.ListBackups}
986
+ # must match the call that provided the page token.
880
987
  # @!attribute [rw] filter
881
988
  # @return [::String]
882
989
  # Optional. The filter to apply to list results.
@@ -890,7 +997,8 @@ module Google
890
997
  extend ::Google::Protobuf::MessageExts::ClassMethods
891
998
  end
892
999
 
893
- # Response message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_backups DataprocMetastore.ListBackups}.
1000
+ # Response message for
1001
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#list_backups DataprocMetastore.ListBackups}.
894
1002
  # @!attribute [rw] backups
895
1003
  # @return [::Array<::Google::Cloud::Metastore::V1::Backup>]
896
1004
  # The backups of the specified service.
@@ -906,7 +1014,8 @@ module Google
906
1014
  extend ::Google::Protobuf::MessageExts::ClassMethods
907
1015
  end
908
1016
 
909
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#get_backup DataprocMetastore.GetBackup}.
1017
+ # Request message for
1018
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#get_backup DataprocMetastore.GetBackup}.
910
1019
  # @!attribute [rw] name
911
1020
  # @return [::String]
912
1021
  # Required. The relative resource name of the backup to retrieve, in the
@@ -918,11 +1027,12 @@ module Google
918
1027
  extend ::Google::Protobuf::MessageExts::ClassMethods
919
1028
  end
920
1029
 
921
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#create_backup DataprocMetastore.CreateBackup}.
1030
+ # Request message for
1031
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#create_backup DataprocMetastore.CreateBackup}.
922
1032
  # @!attribute [rw] parent
923
1033
  # @return [::String]
924
- # Required. The relative resource name of the service in which to create a backup
925
- # of the following form:
1034
+ # Required. The relative resource name of the service in which to create a
1035
+ # backup of the following form:
926
1036
  #
927
1037
  # `projects/{project_number}/locations/{location_id}/services/{service_id}`.
928
1038
  # @!attribute [rw] backup_id
@@ -935,14 +1045,14 @@ module Google
935
1045
  # or hyphens.
936
1046
  # @!attribute [rw] backup
937
1047
  # @return [::Google::Cloud::Metastore::V1::Backup]
938
- # Required. The backup to create. The `name` field is ignored. The ID of the created
939
- # backup must be provided in the request's `backup_id` field.
1048
+ # Required. The backup to create. The `name` field is ignored. The ID of the
1049
+ # created backup must be provided in the request's `backup_id` field.
940
1050
  # @!attribute [rw] request_id
941
1051
  # @return [::String]
942
- # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
943
- # request if it has completed. The server will ignore subsequent requests
944
- # that provide a duplicate request ID for at least 60 minutes after the first
945
- # request.
1052
+ # Optional. A request ID. Specify a unique request ID to allow the server to
1053
+ # ignore the request if it has completed. The server will ignore subsequent
1054
+ # requests that provide a duplicate request ID for at least 60 minutes after
1055
+ # the first request.
946
1056
  #
947
1057
  # For example, if an initial request times out, followed by another request
948
1058
  # with the same request ID, the server ignores the second request to prevent
@@ -956,7 +1066,8 @@ module Google
956
1066
  extend ::Google::Protobuf::MessageExts::ClassMethods
957
1067
  end
958
1068
 
959
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#delete_backup DataprocMetastore.DeleteBackup}.
1069
+ # Request message for
1070
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#delete_backup DataprocMetastore.DeleteBackup}.
960
1071
  # @!attribute [rw] name
961
1072
  # @return [::String]
962
1073
  # Required. The relative resource name of the backup to delete, in the
@@ -965,10 +1076,10 @@ module Google
965
1076
  # `projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}`.
966
1077
  # @!attribute [rw] request_id
967
1078
  # @return [::String]
968
- # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
969
- # request if it has completed. The server will ignore subsequent requests
970
- # that provide a duplicate request ID for at least 60 minutes after the first
971
- # request.
1079
+ # Optional. A request ID. Specify a unique request ID to allow the server to
1080
+ # ignore the request if it has completed. The server will ignore subsequent
1081
+ # requests that provide a duplicate request ID for at least 60 minutes after
1082
+ # the first request.
972
1083
  #
973
1084
  # For example, if an initial request times out, followed by another request
974
1085
  # with the same request ID, the server ignores the second request to prevent
@@ -982,7 +1093,8 @@ module Google
982
1093
  extend ::Google::Protobuf::MessageExts::ClassMethods
983
1094
  end
984
1095
 
985
- # Request message for {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#export_metadata DataprocMetastore.ExportMetadata}.
1096
+ # Request message for
1097
+ # {::Google::Cloud::Metastore::V1::DataprocMetastore::Client#export_metadata DataprocMetastore.ExportMetadata}.
986
1098
  # @!attribute [rw] destination_gcs_folder
987
1099
  # @return [::String]
988
1100
  # A Cloud Storage URI of a folder, in the format
@@ -990,16 +1102,16 @@ module Google
990
1102
  # `<export_folder>` containing exported files will be created below it.
991
1103
  # @!attribute [rw] service
992
1104
  # @return [::String]
993
- # Required. The relative resource name of the metastore service to run export, in the
994
- # following form:
1105
+ # Required. The relative resource name of the metastore service to run
1106
+ # export, in the following form:
995
1107
  #
996
1108
  # `projects/{project_id}/locations/{location_id}/services/{service_id}`.
997
1109
  # @!attribute [rw] request_id
998
1110
  # @return [::String]
999
- # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
1000
- # request if it has completed. The server will ignore subsequent requests
1001
- # that provide a duplicate request ID for at least 60 minutes after the first
1002
- # request.
1111
+ # Optional. A request ID. Specify a unique request ID to allow the server to
1112
+ # ignore the request if it has completed. The server will ignore subsequent
1113
+ # requests that provide a duplicate request ID for at least 60 minutes after
1114
+ # the first request.
1003
1115
  #
1004
1116
  # For example, if an initial request times out, followed by another request
1005
1117
  # with the same request ID, the server ignores the second request to prevent
@@ -1010,7 +1122,8 @@ module Google
1010
1122
  # A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
1011
1123
  # @!attribute [rw] database_dump_type
1012
1124
  # @return [::Google::Cloud::Metastore::V1::DatabaseDumpSpec::Type]
1013
- # Optional. The type of the database dump. If unspecified, defaults to `MYSQL`.
1125
+ # Optional. The type of the database dump. If unspecified, defaults to
1126
+ # `MYSQL`.
1014
1127
  class ExportMetadataRequest
1015
1128
  include ::Google::Protobuf::MessageExts
1016
1129
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1019,14 +1132,14 @@ module Google
1019
1132
  # Request message for [DataprocMetastore.Restore][].
1020
1133
  # @!attribute [rw] service
1021
1134
  # @return [::String]
1022
- # Required. The relative resource name of the metastore service to run restore, in the
1023
- # following form:
1135
+ # Required. The relative resource name of the metastore service to run
1136
+ # restore, in the following form:
1024
1137
  #
1025
1138
  # `projects/{project_id}/locations/{location_id}/services/{service_id}`.
1026
1139
  # @!attribute [rw] backup
1027
1140
  # @return [::String]
1028
- # Required. The relative resource name of the metastore service backup to restore
1029
- # from, in the following form:
1141
+ # Required. The relative resource name of the metastore service backup to
1142
+ # restore from, in the following form:
1030
1143
  #
1031
1144
  # `projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`.
1032
1145
  # @!attribute [rw] restore_type
@@ -1034,10 +1147,10 @@ module Google
1034
1147
  # Optional. The type of restore. If unspecified, defaults to `METADATA_ONLY`.
1035
1148
  # @!attribute [rw] request_id
1036
1149
  # @return [::String]
1037
- # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
1038
- # request if it has completed. The server will ignore subsequent requests
1039
- # that provide a duplicate request ID for at least 60 minutes after the first
1040
- # request.
1150
+ # Optional. A request ID. Specify a unique request ID to allow the server to
1151
+ # ignore the request if it has completed. The server will ignore subsequent
1152
+ # requests that provide a duplicate request ID for at least 60 minutes after
1153
+ # the first request.
1041
1154
  #
1042
1155
  # For example, if an initial request times out, followed by another request
1043
1156
  # with the same request ID, the server ignores the second request to prevent
@@ -1071,8 +1184,9 @@ module Google
1071
1184
  # @return [::Boolean]
1072
1185
  # Output only. Identifies whether the caller has requested cancellation
1073
1186
  # of the operation. Operations that have successfully been cancelled
1074
- # have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
1075
- # corresponding to `Code.CANCELLED`.
1187
+ # have [Operation.error][] value with a
1188
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
1189
+ # `Code.CANCELLED`.
1076
1190
  # @!attribute [r] api_version
1077
1191
  # @return [::String]
1078
1192
  # Output only. API version used to start the operation.