google-cloud-metastore-v1 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,302 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Metastore
23
+ module V1
24
+ # Represents a federation of multiple backend metastores.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Immutable. The relative resource name of the federation, of the
28
+ # form:
29
+ # projects/\\{project_number}/locations/\\{location_id}/federations/\\{federation_id}`.
30
+ # @!attribute [r] create_time
31
+ # @return [::Google::Protobuf::Timestamp]
32
+ # Output only. The time when the metastore federation was created.
33
+ # @!attribute [r] update_time
34
+ # @return [::Google::Protobuf::Timestamp]
35
+ # Output only. The time when the metastore federation was last updated.
36
+ # @!attribute [rw] labels
37
+ # @return [::Google::Protobuf::Map{::String => ::String}]
38
+ # User-defined labels for the metastore federation.
39
+ # @!attribute [rw] version
40
+ # @return [::String]
41
+ # Immutable. The Apache Hive metastore version of the federation. All backend metastore
42
+ # versions must be compatible with the federation version.
43
+ # @!attribute [rw] backend_metastores
44
+ # @return [::Google::Protobuf::Map{::Integer => ::Google::Cloud::Metastore::V1::BackendMetastore}]
45
+ # A map from `BackendMetastore` rank to `BackendMetastore`s from which the
46
+ # federation service serves metadata at query time. The map key represents
47
+ # the order in which `BackendMetastore`s should be evaluated to resolve
48
+ # database names at query time and should be greater than or equal to zero. A
49
+ # `BackendMetastore` with a lower number will be evaluated before a
50
+ # `BackendMetastore` with a higher number.
51
+ # @!attribute [r] endpoint_uri
52
+ # @return [::String]
53
+ # Output only. The federation endpoint.
54
+ # @!attribute [r] state
55
+ # @return [::Google::Cloud::Metastore::V1::Federation::State]
56
+ # Output only. The current state of the federation.
57
+ # @!attribute [r] state_message
58
+ # @return [::String]
59
+ # Output only. Additional information about the current state of the metastore federation,
60
+ # if available.
61
+ # @!attribute [r] uid
62
+ # @return [::String]
63
+ # Output only. The globally unique resource identifier of the metastore federation.
64
+ class Federation
65
+ include ::Google::Protobuf::MessageExts
66
+ extend ::Google::Protobuf::MessageExts::ClassMethods
67
+
68
+ # @!attribute [rw] key
69
+ # @return [::String]
70
+ # @!attribute [rw] value
71
+ # @return [::String]
72
+ class LabelsEntry
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
+ end
76
+
77
+ # @!attribute [rw] key
78
+ # @return [::Integer]
79
+ # @!attribute [rw] value
80
+ # @return [::Google::Cloud::Metastore::V1::BackendMetastore]
81
+ class BackendMetastoresEntry
82
+ include ::Google::Protobuf::MessageExts
83
+ extend ::Google::Protobuf::MessageExts::ClassMethods
84
+ end
85
+
86
+ # The current state of the federation.
87
+ module State
88
+ # The state of the metastore federation is unknown.
89
+ STATE_UNSPECIFIED = 0
90
+
91
+ # The metastore federation is in the process of being created.
92
+ CREATING = 1
93
+
94
+ # The metastore federation is running and ready to serve queries.
95
+ ACTIVE = 2
96
+
97
+ # The metastore federation is being updated. It remains usable but cannot
98
+ # accept additional update requests or be deleted at this time.
99
+ UPDATING = 3
100
+
101
+ # The metastore federation is undergoing deletion. It cannot be used.
102
+ DELETING = 4
103
+
104
+ # The metastore federation has encountered an error and cannot be used. The
105
+ # metastore federation should be deleted.
106
+ ERROR = 5
107
+ end
108
+ end
109
+
110
+ # Represents a backend metastore for the federation.
111
+ # @!attribute [rw] name
112
+ # @return [::String]
113
+ # The relative resource name of the metastore that is being federated.
114
+ # The formats of the relative resource names for the currently supported
115
+ # metastores are listed below:
116
+ #
117
+ # * Dataplex
118
+ # * `projects/{project_id}/locations/{location}/lakes/{lake_id}`
119
+ # * BigQuery
120
+ # * `projects/{project_id}`
121
+ # * Dataproc Metastore
122
+ # * `projects/{project_id}/locations/{location}/services/{service_id}`
123
+ # @!attribute [rw] metastore_type
124
+ # @return [::Google::Cloud::Metastore::V1::BackendMetastore::MetastoreType]
125
+ # The type of the backend metastore.
126
+ class BackendMetastore
127
+ include ::Google::Protobuf::MessageExts
128
+ extend ::Google::Protobuf::MessageExts::ClassMethods
129
+
130
+ # The type of the backend metastore.
131
+ module MetastoreType
132
+ # The metastore type is not set.
133
+ METASTORE_TYPE_UNSPECIFIED = 0
134
+
135
+ # The backend metastore is Dataproc Metastore.
136
+ DATAPROC_METASTORE = 3
137
+ end
138
+ end
139
+
140
+ # Request message for ListFederations.
141
+ # @!attribute [rw] parent
142
+ # @return [::String]
143
+ # Required. The relative resource name of the location of metastore federations
144
+ # to list, in the following form:
145
+ # `projects/{project_number}/locations/{location_id}`.
146
+ # @!attribute [rw] page_size
147
+ # @return [::Integer]
148
+ # Optional. The maximum number of federations to return. The response may contain less
149
+ # than the maximum number. If unspecified, no more than 500 services are
150
+ # returned. The maximum value is 1000; values above 1000 are changed to 1000.
151
+ # @!attribute [rw] page_token
152
+ # @return [::String]
153
+ # Optional. A page token, received from a previous ListFederationServices
154
+ # call. Provide this token to retrieve the subsequent page.
155
+ #
156
+ # To retrieve the first page, supply an empty page token.
157
+ #
158
+ # When paginating, other parameters provided to
159
+ # ListFederationServices must match the call that provided the
160
+ # page token.
161
+ # @!attribute [rw] filter
162
+ # @return [::String]
163
+ # Optional. The filter to apply to list results.
164
+ # @!attribute [rw] order_by
165
+ # @return [::String]
166
+ # Optional. Specify the ordering of results as described in [Sorting
167
+ # Order](https://cloud.google.com/apis/design/design_patterns#sorting_order).
168
+ # If not specified, the results will be sorted in the default order.
169
+ class ListFederationsRequest
170
+ include ::Google::Protobuf::MessageExts
171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
172
+ end
173
+
174
+ # Response message for ListFederations
175
+ # @!attribute [rw] federations
176
+ # @return [::Array<::Google::Cloud::Metastore::V1::Federation>]
177
+ # The services in the specified location.
178
+ # @!attribute [rw] next_page_token
179
+ # @return [::String]
180
+ # A token that can be sent as `page_token` to retrieve the next page. If this
181
+ # field is omitted, there are no subsequent pages.
182
+ # @!attribute [rw] unreachable
183
+ # @return [::Array<::String>]
184
+ # Locations that could not be reached.
185
+ class ListFederationsResponse
186
+ include ::Google::Protobuf::MessageExts
187
+ extend ::Google::Protobuf::MessageExts::ClassMethods
188
+ end
189
+
190
+ # Request message for GetFederation.
191
+ # @!attribute [rw] name
192
+ # @return [::String]
193
+ # Required. The relative resource name of the metastore federation to retrieve,
194
+ # in the following form:
195
+ #
196
+ # `projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
197
+ class GetFederationRequest
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Request message for CreateFederation.
203
+ # @!attribute [rw] parent
204
+ # @return [::String]
205
+ # Required. The relative resource name of the location in which to create a federation
206
+ # service, in the following form:
207
+ #
208
+ # `projects/{project_number}/locations/{location_id}`.
209
+ # @!attribute [rw] federation_id
210
+ # @return [::String]
211
+ # Required. The ID of the metastore federation, which is used as the final
212
+ # component of the metastore federation's name.
213
+ #
214
+ # This value must be between 2 and 63 characters long inclusive, begin with a
215
+ # letter, end with a letter or number, and consist of alpha-numeric
216
+ # ASCII characters or hyphens.
217
+ # @!attribute [rw] federation
218
+ # @return [::Google::Cloud::Metastore::V1::Federation]
219
+ # Required. The Metastore Federation to create. The `name` field is
220
+ # ignored. The ID of the created metastore federation must be
221
+ # provided in the request's `federation_id` field.
222
+ # @!attribute [rw] request_id
223
+ # @return [::String]
224
+ # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
225
+ # request if it has completed. The server will ignore subsequent requests
226
+ # that provide a duplicate request ID for at least 60 minutes after the first
227
+ # request.
228
+ #
229
+ # For example, if an initial request times out, followed by another request
230
+ # with the same request ID, the server ignores the second request to prevent
231
+ # the creation of duplicate commitments.
232
+ #
233
+ # The request ID must be a valid
234
+ # [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
235
+ # A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
236
+ class CreateFederationRequest
237
+ include ::Google::Protobuf::MessageExts
238
+ extend ::Google::Protobuf::MessageExts::ClassMethods
239
+ end
240
+
241
+ # Request message for UpdateFederation.
242
+ # @!attribute [rw] update_mask
243
+ # @return [::Google::Protobuf::FieldMask]
244
+ # Required. A field mask used to specify the fields to be overwritten in the
245
+ # metastore federation resource by the update.
246
+ # Fields specified in the `update_mask` are relative to the resource (not
247
+ # to the full request). A field is overwritten if it is in the mask.
248
+ # @!attribute [rw] federation
249
+ # @return [::Google::Cloud::Metastore::V1::Federation]
250
+ # Required. The metastore federation to update. The server only merges fields
251
+ # in the service if they are specified in `update_mask`.
252
+ #
253
+ # The metastore federation's `name` field is used to identify the
254
+ # metastore service to be updated.
255
+ # @!attribute [rw] request_id
256
+ # @return [::String]
257
+ # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
258
+ # request if it has completed. The server will ignore subsequent requests
259
+ # that provide a duplicate request ID for at least 60 minutes after the first
260
+ # request.
261
+ #
262
+ # For example, if an initial request times out, followed by another request
263
+ # with the same request ID, the server ignores the second request to prevent
264
+ # the creation of duplicate commitments.
265
+ #
266
+ # The request ID must be a valid
267
+ # [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
268
+ # A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
269
+ class UpdateFederationRequest
270
+ include ::Google::Protobuf::MessageExts
271
+ extend ::Google::Protobuf::MessageExts::ClassMethods
272
+ end
273
+
274
+ # Request message for DeleteFederation.
275
+ # @!attribute [rw] name
276
+ # @return [::String]
277
+ # Required. The relative resource name of the metastore federation to delete,
278
+ # in the following form:
279
+ #
280
+ # `projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
281
+ # @!attribute [rw] request_id
282
+ # @return [::String]
283
+ # Optional. A request ID. Specify a unique request ID to allow the server to ignore the
284
+ # request if it has completed. The server will ignore subsequent requests
285
+ # that provide a duplicate request ID for at least 60 minutes after the first
286
+ # request.
287
+ #
288
+ # For example, if an initial request times out, followed by another request
289
+ # with the same request ID, the server ignores the second request to prevent
290
+ # the creation of duplicate commitments.
291
+ #
292
+ # The request ID must be a valid
293
+ # [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
294
+ # A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
295
+ class DeleteFederationRequest
296
+ include ::Google::Protobuf::MessageExts
297
+ extend ::Google::Protobuf::MessageExts::ClassMethods
298
+ end
299
+ end
300
+ end
301
+ end
302
+ end
@@ -26,8 +26,6 @@ module Google
26
26
  # service Foo {
27
27
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
28
28
  # }
29
- #
30
- # The JSON representation for `Empty` is empty JSON object `{}`.
31
29
  class Empty
32
30
  include ::Google::Protobuf::MessageExts
33
31
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -28,12 +28,14 @@ module Google
28
28
  # [API Design Guide](https://cloud.google.com/apis/design/errors).
29
29
  # @!attribute [rw] code
30
30
  # @return [::Integer]
31
- # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
31
+ # The status code, which should be an enum value of
32
+ # [google.rpc.Code][google.rpc.Code].
32
33
  # @!attribute [rw] message
33
34
  # @return [::String]
34
35
  # A developer-facing error message, which should be in English. Any
35
36
  # user-facing error message should be localized and sent in the
36
- # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
37
+ # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
38
+ # by the client.
37
39
  # @!attribute [rw] details
38
40
  # @return [::Array<::Google::Protobuf::Any>]
39
41
  # A list of messages that carry the error details. There is a common set of
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-metastore-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-07-05 00:00:00.000000000 Z
11
+ date: 2023-02-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.10'
19
+ version: 0.17.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.10'
29
+ version: 0.17.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -44,20 +44,60 @@ dependencies:
44
44
  - - "~>"
45
45
  - !ruby/object:Gem::Version
46
46
  version: '1.0'
47
+ - !ruby/object:Gem::Dependency
48
+ name: google-cloud-location
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '0.4'
54
+ - - "<"
55
+ - !ruby/object:Gem::Version
56
+ version: 2.a
57
+ type: :runtime
58
+ prerelease: false
59
+ version_requirements: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: '0.4'
64
+ - - "<"
65
+ - !ruby/object:Gem::Version
66
+ version: 2.a
67
+ - !ruby/object:Gem::Dependency
68
+ name: google-iam-v1
69
+ requirement: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - ">="
72
+ - !ruby/object:Gem::Version
73
+ version: '0.4'
74
+ - - "<"
75
+ - !ruby/object:Gem::Version
76
+ version: 2.a
77
+ type: :runtime
78
+ prerelease: false
79
+ version_requirements: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: '0.4'
84
+ - - "<"
85
+ - !ruby/object:Gem::Version
86
+ version: 2.a
47
87
  - !ruby/object:Gem::Dependency
48
88
  name: google-style
49
89
  requirement: !ruby/object:Gem::Requirement
50
90
  requirements:
51
91
  - - "~>"
52
92
  - !ruby/object:Gem::Version
53
- version: 1.26.1
93
+ version: 1.26.3
54
94
  type: :development
55
95
  prerelease: false
56
96
  version_requirements: !ruby/object:Gem::Requirement
57
97
  requirements:
58
98
  - - "~>"
59
99
  - !ruby/object:Gem::Version
60
- version: 1.26.1
100
+ version: 1.26.3
61
101
  - !ruby/object:Gem::Dependency
62
102
  name: minitest
63
103
  requirement: !ruby/object:Gem::Requirement
@@ -179,13 +219,23 @@ files:
179
219
  - lib/google/cloud/metastore/v1/dataproc_metastore/credentials.rb
180
220
  - lib/google/cloud/metastore/v1/dataproc_metastore/operations.rb
181
221
  - lib/google/cloud/metastore/v1/dataproc_metastore/paths.rb
222
+ - lib/google/cloud/metastore/v1/dataproc_metastore_federation.rb
223
+ - lib/google/cloud/metastore/v1/dataproc_metastore_federation/client.rb
224
+ - lib/google/cloud/metastore/v1/dataproc_metastore_federation/credentials.rb
225
+ - lib/google/cloud/metastore/v1/dataproc_metastore_federation/operations.rb
226
+ - lib/google/cloud/metastore/v1/dataproc_metastore_federation/paths.rb
227
+ - lib/google/cloud/metastore/v1/metastore_federation_pb.rb
228
+ - lib/google/cloud/metastore/v1/metastore_federation_services_pb.rb
182
229
  - lib/google/cloud/metastore/v1/metastore_pb.rb
183
230
  - lib/google/cloud/metastore/v1/metastore_services_pb.rb
184
231
  - lib/google/cloud/metastore/v1/version.rb
185
232
  - proto_docs/README.md
233
+ - proto_docs/google/api/client.rb
186
234
  - proto_docs/google/api/field_behavior.rb
235
+ - proto_docs/google/api/launch_stage.rb
187
236
  - proto_docs/google/api/resource.rb
188
237
  - proto_docs/google/cloud/metastore/v1/metastore.rb
238
+ - proto_docs/google/cloud/metastore/v1/metastore_federation.rb
189
239
  - proto_docs/google/longrunning/operations.rb
190
240
  - proto_docs/google/protobuf/any.rb
191
241
  - proto_docs/google/protobuf/duration.rb
@@ -214,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
214
264
  - !ruby/object:Gem::Version
215
265
  version: '0'
216
266
  requirements: []
217
- rubygems_version: 3.3.14
267
+ rubygems_version: 3.4.2
218
268
  signing_key:
219
269
  specification_version: 4
220
270
  summary: API Client library for the Dataproc Metastore V1 API