google-apis-firebasedataconnect_v1 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google/apis/firebasedataconnect_v1/classes.rb +1119 -0
- data/lib/google/apis/firebasedataconnect_v1/gem_version.rb +28 -0
- data/lib/google/apis/firebasedataconnect_v1/representations.rb +502 -0
- data/lib/google/apis/firebasedataconnect_v1/service.rb +1200 -0
- data/lib/google/apis/firebasedataconnect_v1.rb +39 -0
- data/lib/google-apis-firebasedataconnect_v1.rb +15 -0
- metadata +79 -0
|
@@ -0,0 +1,1200 @@
|
|
|
1
|
+
# Copyright 2020 Google LLC
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
require 'google/apis/core/base_service'
|
|
16
|
+
require 'google/apis/core/json_representation'
|
|
17
|
+
require 'google/apis/core/hashable'
|
|
18
|
+
require 'google/apis/errors'
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Apis
|
|
22
|
+
module FirebasedataconnectV1
|
|
23
|
+
# Firebase Data Connect API
|
|
24
|
+
#
|
|
25
|
+
# Firebase Data Connect is a relational database service for mobile and web apps
|
|
26
|
+
# that lets you build and scale using a fully-managed PostgreSQL database
|
|
27
|
+
# powered by Cloud SQL. The REST API lets developers manage the connections to
|
|
28
|
+
# their database, change the schema of their database, and query the database.
|
|
29
|
+
#
|
|
30
|
+
# @example
|
|
31
|
+
# require 'google/apis/firebasedataconnect_v1'
|
|
32
|
+
#
|
|
33
|
+
# Firebasedataconnect = Google::Apis::FirebasedataconnectV1 # Alias the module
|
|
34
|
+
# service = Firebasedataconnect::FirebaseDataConnectService.new
|
|
35
|
+
#
|
|
36
|
+
# @see https://firebase.google.com/docs/data-connect
|
|
37
|
+
class FirebaseDataConnectService < Google::Apis::Core::BaseService
|
|
38
|
+
DEFAULT_ENDPOINT_TEMPLATE = "https://firebasedataconnect.$UNIVERSE_DOMAIN$/"
|
|
39
|
+
|
|
40
|
+
# @return [String]
|
|
41
|
+
# API key. Your API key identifies your project and provides you with API access,
|
|
42
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
|
43
|
+
attr_accessor :key
|
|
44
|
+
|
|
45
|
+
# @return [String]
|
|
46
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
47
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
48
|
+
attr_accessor :quota_user
|
|
49
|
+
|
|
50
|
+
def initialize
|
|
51
|
+
super(DEFAULT_ENDPOINT_TEMPLATE, '',
|
|
52
|
+
client_name: 'google-apis-firebasedataconnect_v1',
|
|
53
|
+
client_version: Google::Apis::FirebasedataconnectV1::GEM_VERSION)
|
|
54
|
+
@batch_path = 'batch'
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Gets information about a location.
|
|
58
|
+
# @param [String] name
|
|
59
|
+
# Resource name for the location.
|
|
60
|
+
# @param [String] fields
|
|
61
|
+
# Selector specifying which fields to include in a partial response.
|
|
62
|
+
# @param [String] quota_user
|
|
63
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
64
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
65
|
+
# @param [Google::Apis::RequestOptions] options
|
|
66
|
+
# Request-specific options
|
|
67
|
+
#
|
|
68
|
+
# @yield [result, err] Result & error if block supplied
|
|
69
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Location] parsed result object
|
|
70
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
71
|
+
#
|
|
72
|
+
# @return [Google::Apis::FirebasedataconnectV1::Location]
|
|
73
|
+
#
|
|
74
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
75
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
76
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
77
|
+
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
78
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
79
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Location::Representation
|
|
80
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Location
|
|
81
|
+
command.params['name'] = name unless name.nil?
|
|
82
|
+
command.query['fields'] = fields unless fields.nil?
|
|
83
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
84
|
+
execute_or_queue_command(command, &block)
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Lists information about the supported locations for this service.
|
|
88
|
+
# @param [String] name
|
|
89
|
+
# The resource that owns the locations collection, if applicable.
|
|
90
|
+
# @param [Array<String>, String] extra_location_types
|
|
91
|
+
# Optional. A list of extra location types that should be used as conditions for
|
|
92
|
+
# controlling the visibility of the locations.
|
|
93
|
+
# @param [String] filter
|
|
94
|
+
# A filter to narrow down results to a preferred subset. The filtering language
|
|
95
|
+
# accepts strings like `"displayName=tokyo"`, and is documented in more detail
|
|
96
|
+
# in [AIP-160](https://google.aip.dev/160).
|
|
97
|
+
# @param [Fixnum] page_size
|
|
98
|
+
# The maximum number of results to return. If not set, the service selects a
|
|
99
|
+
# default.
|
|
100
|
+
# @param [String] page_token
|
|
101
|
+
# A page token received from the `next_page_token` field in the response. Send
|
|
102
|
+
# that page token to receive the subsequent page.
|
|
103
|
+
# @param [String] fields
|
|
104
|
+
# Selector specifying which fields to include in a partial response.
|
|
105
|
+
# @param [String] quota_user
|
|
106
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
107
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
108
|
+
# @param [Google::Apis::RequestOptions] options
|
|
109
|
+
# Request-specific options
|
|
110
|
+
#
|
|
111
|
+
# @yield [result, err] Result & error if block supplied
|
|
112
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::ListLocationsResponse] parsed result object
|
|
113
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
114
|
+
#
|
|
115
|
+
# @return [Google::Apis::FirebasedataconnectV1::ListLocationsResponse]
|
|
116
|
+
#
|
|
117
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
118
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
119
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
120
|
+
def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
121
|
+
command = make_simple_command(:get, 'v1/{+name}/locations', options)
|
|
122
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::ListLocationsResponse::Representation
|
|
123
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::ListLocationsResponse
|
|
124
|
+
command.params['name'] = name unless name.nil?
|
|
125
|
+
command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
|
|
126
|
+
command.query['filter'] = filter unless filter.nil?
|
|
127
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
128
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
129
|
+
command.query['fields'] = fields unless fields.nil?
|
|
130
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
131
|
+
execute_or_queue_command(command, &block)
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
|
135
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
|
136
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
137
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
|
138
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
|
139
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
|
140
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of `1`
|
|
141
|
+
# , corresponding to `Code.CANCELLED`.
|
|
142
|
+
# @param [String] name
|
|
143
|
+
# The name of the operation resource to be cancelled.
|
|
144
|
+
# @param [Google::Apis::FirebasedataconnectV1::CancelOperationRequest] cancel_operation_request_object
|
|
145
|
+
# @param [String] fields
|
|
146
|
+
# Selector specifying which fields to include in a partial response.
|
|
147
|
+
# @param [String] quota_user
|
|
148
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
149
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
150
|
+
# @param [Google::Apis::RequestOptions] options
|
|
151
|
+
# Request-specific options
|
|
152
|
+
#
|
|
153
|
+
# @yield [result, err] Result & error if block supplied
|
|
154
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Empty] parsed result object
|
|
155
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
156
|
+
#
|
|
157
|
+
# @return [Google::Apis::FirebasedataconnectV1::Empty]
|
|
158
|
+
#
|
|
159
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
160
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
161
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
162
|
+
def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
163
|
+
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
|
|
164
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::CancelOperationRequest::Representation
|
|
165
|
+
command.request_object = cancel_operation_request_object
|
|
166
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Empty::Representation
|
|
167
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Empty
|
|
168
|
+
command.params['name'] = name unless name.nil?
|
|
169
|
+
command.query['fields'] = fields unless fields.nil?
|
|
170
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
171
|
+
execute_or_queue_command(command, &block)
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# Deletes a long-running operation. This method indicates that the client is no
|
|
175
|
+
# longer interested in the operation result. It does not cancel the operation.
|
|
176
|
+
# If the server doesn't support this method, it returns `google.rpc.Code.
|
|
177
|
+
# UNIMPLEMENTED`.
|
|
178
|
+
# @param [String] name
|
|
179
|
+
# The name of the operation resource to be deleted.
|
|
180
|
+
# @param [String] fields
|
|
181
|
+
# Selector specifying which fields to include in a partial response.
|
|
182
|
+
# @param [String] quota_user
|
|
183
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
184
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
185
|
+
# @param [Google::Apis::RequestOptions] options
|
|
186
|
+
# Request-specific options
|
|
187
|
+
#
|
|
188
|
+
# @yield [result, err] Result & error if block supplied
|
|
189
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Empty] parsed result object
|
|
190
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
191
|
+
#
|
|
192
|
+
# @return [Google::Apis::FirebasedataconnectV1::Empty]
|
|
193
|
+
#
|
|
194
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
195
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
196
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
197
|
+
def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
198
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
199
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Empty::Representation
|
|
200
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Empty
|
|
201
|
+
command.params['name'] = name unless name.nil?
|
|
202
|
+
command.query['fields'] = fields unless fields.nil?
|
|
203
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
204
|
+
execute_or_queue_command(command, &block)
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
|
208
|
+
# to poll the operation result at intervals as recommended by the API service.
|
|
209
|
+
# @param [String] name
|
|
210
|
+
# The name of the operation resource.
|
|
211
|
+
# @param [String] fields
|
|
212
|
+
# Selector specifying which fields to include in a partial response.
|
|
213
|
+
# @param [String] quota_user
|
|
214
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
215
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
216
|
+
# @param [Google::Apis::RequestOptions] options
|
|
217
|
+
# Request-specific options
|
|
218
|
+
#
|
|
219
|
+
# @yield [result, err] Result & error if block supplied
|
|
220
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Operation] parsed result object
|
|
221
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
222
|
+
#
|
|
223
|
+
# @return [Google::Apis::FirebasedataconnectV1::Operation]
|
|
224
|
+
#
|
|
225
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
226
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
227
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
228
|
+
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
229
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
230
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Operation::Representation
|
|
231
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Operation
|
|
232
|
+
command.params['name'] = name unless name.nil?
|
|
233
|
+
command.query['fields'] = fields unless fields.nil?
|
|
234
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
235
|
+
execute_or_queue_command(command, &block)
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
# Lists operations that match the specified filter in the request. If the server
|
|
239
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
240
|
+
# @param [String] name
|
|
241
|
+
# The name of the operation's parent resource.
|
|
242
|
+
# @param [String] filter
|
|
243
|
+
# The standard list filter.
|
|
244
|
+
# @param [Fixnum] page_size
|
|
245
|
+
# The standard list page size.
|
|
246
|
+
# @param [String] page_token
|
|
247
|
+
# The standard list page token.
|
|
248
|
+
# @param [String] fields
|
|
249
|
+
# Selector specifying which fields to include in a partial response.
|
|
250
|
+
# @param [String] quota_user
|
|
251
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
252
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
253
|
+
# @param [Google::Apis::RequestOptions] options
|
|
254
|
+
# Request-specific options
|
|
255
|
+
#
|
|
256
|
+
# @yield [result, err] Result & error if block supplied
|
|
257
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::ListOperationsResponse] parsed result object
|
|
258
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
259
|
+
#
|
|
260
|
+
# @return [Google::Apis::FirebasedataconnectV1::ListOperationsResponse]
|
|
261
|
+
#
|
|
262
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
263
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
264
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
265
|
+
def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
266
|
+
command = make_simple_command(:get, 'v1/{+name}/operations', options)
|
|
267
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::ListOperationsResponse::Representation
|
|
268
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::ListOperationsResponse
|
|
269
|
+
command.params['name'] = name unless name.nil?
|
|
270
|
+
command.query['filter'] = filter unless filter.nil?
|
|
271
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
272
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
273
|
+
command.query['fields'] = fields unless fields.nil?
|
|
274
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
275
|
+
execute_or_queue_command(command, &block)
|
|
276
|
+
end
|
|
277
|
+
|
|
278
|
+
# Creates a new Service in a given project and location.
|
|
279
|
+
# @param [String] parent
|
|
280
|
+
# Required. Value of parent.
|
|
281
|
+
# @param [Google::Apis::FirebasedataconnectV1::Service] service_object
|
|
282
|
+
# @param [String] request_id
|
|
283
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
284
|
+
# request ID so that if you must retry your request, the server will know to
|
|
285
|
+
# ignore the request if it has already been completed. The server will guarantee
|
|
286
|
+
# that for at least 60 minutes since the first request. For example, consider a
|
|
287
|
+
# situation where you make an initial request and the request times out. If you
|
|
288
|
+
# make the request again with the same request ID, the server can check if
|
|
289
|
+
# original operation with the same request ID was received, and if so, will
|
|
290
|
+
# ignore the second request. This prevents clients from accidentally creating
|
|
291
|
+
# duplicate commitments. The request ID must be a valid UUID with the exception
|
|
292
|
+
# that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
293
|
+
# @param [String] service_id
|
|
294
|
+
# Required. The ID to use for the service, which will become the final component
|
|
295
|
+
# of the service's resource name.
|
|
296
|
+
# @param [Boolean] validate_only
|
|
297
|
+
# Optional. If set, validate the request and preview the Service, but do not
|
|
298
|
+
# actually create it.
|
|
299
|
+
# @param [String] fields
|
|
300
|
+
# Selector specifying which fields to include in a partial response.
|
|
301
|
+
# @param [String] quota_user
|
|
302
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
303
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
304
|
+
# @param [Google::Apis::RequestOptions] options
|
|
305
|
+
# Request-specific options
|
|
306
|
+
#
|
|
307
|
+
# @yield [result, err] Result & error if block supplied
|
|
308
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Operation] parsed result object
|
|
309
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
310
|
+
#
|
|
311
|
+
# @return [Google::Apis::FirebasedataconnectV1::Operation]
|
|
312
|
+
#
|
|
313
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
314
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
315
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
316
|
+
def create_project_location_service(parent, service_object = nil, request_id: nil, service_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
317
|
+
command = make_simple_command(:post, 'v1/{+parent}/services', options)
|
|
318
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::Service::Representation
|
|
319
|
+
command.request_object = service_object
|
|
320
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Operation::Representation
|
|
321
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Operation
|
|
322
|
+
command.params['parent'] = parent unless parent.nil?
|
|
323
|
+
command.query['requestId'] = request_id unless request_id.nil?
|
|
324
|
+
command.query['serviceId'] = service_id unless service_id.nil?
|
|
325
|
+
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
326
|
+
command.query['fields'] = fields unless fields.nil?
|
|
327
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
328
|
+
execute_or_queue_command(command, &block)
|
|
329
|
+
end
|
|
330
|
+
|
|
331
|
+
# Deletes a single Service.
|
|
332
|
+
# @param [String] name
|
|
333
|
+
# Required. The name of the service to delete, in the format: ``` projects/`
|
|
334
|
+
# project`/locations/`location`/services/`service` ```
|
|
335
|
+
# @param [Boolean] allow_missing
|
|
336
|
+
# Optional. If true and the Service is not found, the request will succeed but
|
|
337
|
+
# no action will be taken on the server.
|
|
338
|
+
# @param [String] etag
|
|
339
|
+
# Optional. The etag of the Service. If this is provided, it must match the
|
|
340
|
+
# server's etag.
|
|
341
|
+
# @param [Boolean] force
|
|
342
|
+
# Optional. If set to true, any child resources (i.e. Schema, SchemaRevisions,
|
|
343
|
+
# Connectors, and ConnectorRevisions) will also be deleted. Otherwise, the
|
|
344
|
+
# request will only work if the Service has no child resources.
|
|
345
|
+
# @param [String] request_id
|
|
346
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
347
|
+
# request ID so that if you must retry your request, the server will know to
|
|
348
|
+
# ignore the request if it has already been completed. The server will guarantee
|
|
349
|
+
# that for at least 60 minutes after the first request. For example, consider a
|
|
350
|
+
# situation where you make an initial request and the request times out. If you
|
|
351
|
+
# make the request again with the same request ID, the server can check if
|
|
352
|
+
# original operation with the same request ID was received, and if so, will
|
|
353
|
+
# ignore the second request. This prevents clients from accidentally creating
|
|
354
|
+
# duplicate commitments. The request ID must be a valid UUID with the exception
|
|
355
|
+
# that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
356
|
+
# @param [Boolean] validate_only
|
|
357
|
+
# Optional. If set, validate the request and preview the Service, but do not
|
|
358
|
+
# actually delete it.
|
|
359
|
+
# @param [String] fields
|
|
360
|
+
# Selector specifying which fields to include in a partial response.
|
|
361
|
+
# @param [String] quota_user
|
|
362
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
363
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
364
|
+
# @param [Google::Apis::RequestOptions] options
|
|
365
|
+
# Request-specific options
|
|
366
|
+
#
|
|
367
|
+
# @yield [result, err] Result & error if block supplied
|
|
368
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Operation] parsed result object
|
|
369
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
370
|
+
#
|
|
371
|
+
# @return [Google::Apis::FirebasedataconnectV1::Operation]
|
|
372
|
+
#
|
|
373
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
374
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
375
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
376
|
+
def delete_project_location_service(name, allow_missing: nil, etag: nil, force: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
377
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
378
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Operation::Representation
|
|
379
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Operation
|
|
380
|
+
command.params['name'] = name unless name.nil?
|
|
381
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
|
382
|
+
command.query['etag'] = etag unless etag.nil?
|
|
383
|
+
command.query['force'] = force unless force.nil?
|
|
384
|
+
command.query['requestId'] = request_id unless request_id.nil?
|
|
385
|
+
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
386
|
+
command.query['fields'] = fields unless fields.nil?
|
|
387
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
388
|
+
execute_or_queue_command(command, &block)
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
# Execute any GraphQL query and mutation against the Firebase Data Connect's
|
|
392
|
+
# generated GraphQL schema. Grants full read and write access to the connected
|
|
393
|
+
# data sources. Note: Use introspection query to explore the generated GraphQL
|
|
394
|
+
# schema.
|
|
395
|
+
# @param [String] name
|
|
396
|
+
# Required. The relative resource name of Firebase Data Connect service, in the
|
|
397
|
+
# format: ``` projects/`project`/locations/`location`/services/`service` ```
|
|
398
|
+
# @param [Google::Apis::FirebasedataconnectV1::GraphqlRequest] graphql_request_object
|
|
399
|
+
# @param [String] fields
|
|
400
|
+
# Selector specifying which fields to include in a partial response.
|
|
401
|
+
# @param [String] quota_user
|
|
402
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
403
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
404
|
+
# @param [Google::Apis::RequestOptions] options
|
|
405
|
+
# Request-specific options
|
|
406
|
+
#
|
|
407
|
+
# @yield [result, err] Result & error if block supplied
|
|
408
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::GraphqlResponse] parsed result object
|
|
409
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
410
|
+
#
|
|
411
|
+
# @return [Google::Apis::FirebasedataconnectV1::GraphqlResponse]
|
|
412
|
+
#
|
|
413
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
414
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
415
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
416
|
+
def execute_project_location_service_graphql(name, graphql_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
417
|
+
command = make_simple_command(:post, 'v1/{+name}:executeGraphql', options)
|
|
418
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::GraphqlRequest::Representation
|
|
419
|
+
command.request_object = graphql_request_object
|
|
420
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::GraphqlResponse::Representation
|
|
421
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::GraphqlResponse
|
|
422
|
+
command.params['name'] = name unless name.nil?
|
|
423
|
+
command.query['fields'] = fields unless fields.nil?
|
|
424
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
425
|
+
execute_or_queue_command(command, &block)
|
|
426
|
+
end
|
|
427
|
+
|
|
428
|
+
# Execute any GraphQL query against the Firebase Data Connect's generated
|
|
429
|
+
# GraphQL schema. Grants full read to the connected data sources. `
|
|
430
|
+
# ExecuteGraphqlRead` is identical to `ExecuteGraphql` except it only accepts
|
|
431
|
+
# read-only query.
|
|
432
|
+
# @param [String] name
|
|
433
|
+
# Required. The relative resource name of Firebase Data Connect service, in the
|
|
434
|
+
# format: ``` projects/`project`/locations/`location`/services/`service` ```
|
|
435
|
+
# @param [Google::Apis::FirebasedataconnectV1::GraphqlRequest] graphql_request_object
|
|
436
|
+
# @param [String] fields
|
|
437
|
+
# Selector specifying which fields to include in a partial response.
|
|
438
|
+
# @param [String] quota_user
|
|
439
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
440
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
441
|
+
# @param [Google::Apis::RequestOptions] options
|
|
442
|
+
# Request-specific options
|
|
443
|
+
#
|
|
444
|
+
# @yield [result, err] Result & error if block supplied
|
|
445
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::GraphqlResponse] parsed result object
|
|
446
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
447
|
+
#
|
|
448
|
+
# @return [Google::Apis::FirebasedataconnectV1::GraphqlResponse]
|
|
449
|
+
#
|
|
450
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
451
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
452
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
453
|
+
def execute_project_location_service_graphql_read(name, graphql_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
454
|
+
command = make_simple_command(:post, 'v1/{+name}:executeGraphqlRead', options)
|
|
455
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::GraphqlRequest::Representation
|
|
456
|
+
command.request_object = graphql_request_object
|
|
457
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::GraphqlResponse::Representation
|
|
458
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::GraphqlResponse
|
|
459
|
+
command.params['name'] = name unless name.nil?
|
|
460
|
+
command.query['fields'] = fields unless fields.nil?
|
|
461
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
462
|
+
execute_or_queue_command(command, &block)
|
|
463
|
+
end
|
|
464
|
+
|
|
465
|
+
# Gets details of a single Service.
|
|
466
|
+
# @param [String] name
|
|
467
|
+
# Required. The name of the service to retrieve, in the format: ``` projects/`
|
|
468
|
+
# project`/locations/`location`/services/`service` ```
|
|
469
|
+
# @param [String] fields
|
|
470
|
+
# Selector specifying which fields to include in a partial response.
|
|
471
|
+
# @param [String] quota_user
|
|
472
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
473
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
474
|
+
# @param [Google::Apis::RequestOptions] options
|
|
475
|
+
# Request-specific options
|
|
476
|
+
#
|
|
477
|
+
# @yield [result, err] Result & error if block supplied
|
|
478
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Service] parsed result object
|
|
479
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
480
|
+
#
|
|
481
|
+
# @return [Google::Apis::FirebasedataconnectV1::Service]
|
|
482
|
+
#
|
|
483
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
484
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
485
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
486
|
+
def get_project_location_service(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
487
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
488
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Service::Representation
|
|
489
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Service
|
|
490
|
+
command.params['name'] = name unless name.nil?
|
|
491
|
+
command.query['fields'] = fields unless fields.nil?
|
|
492
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
493
|
+
execute_or_queue_command(command, &block)
|
|
494
|
+
end
|
|
495
|
+
|
|
496
|
+
# Lists Services in a given project and location.
|
|
497
|
+
# @param [String] parent
|
|
498
|
+
# Required. Value of parent.
|
|
499
|
+
# @param [String] filter
|
|
500
|
+
# Optional. Filtering results.
|
|
501
|
+
# @param [String] order_by
|
|
502
|
+
# Optional. Hint for how to order the results.
|
|
503
|
+
# @param [Fixnum] page_size
|
|
504
|
+
# Optional. Requested page size. Server may return fewer items than requested.
|
|
505
|
+
# If unspecified, server will pick an appropriate default.
|
|
506
|
+
# @param [String] page_token
|
|
507
|
+
# Optional. A page token, received from a previous `ListServices` call. Provide
|
|
508
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
|
509
|
+
# provided to `ListServices` must match the call that provided the page token.
|
|
510
|
+
# @param [String] fields
|
|
511
|
+
# Selector specifying which fields to include in a partial response.
|
|
512
|
+
# @param [String] quota_user
|
|
513
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
514
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
515
|
+
# @param [Google::Apis::RequestOptions] options
|
|
516
|
+
# Request-specific options
|
|
517
|
+
#
|
|
518
|
+
# @yield [result, err] Result & error if block supplied
|
|
519
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::ListServicesResponse] parsed result object
|
|
520
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
521
|
+
#
|
|
522
|
+
# @return [Google::Apis::FirebasedataconnectV1::ListServicesResponse]
|
|
523
|
+
#
|
|
524
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
525
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
526
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
527
|
+
def list_project_location_services(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
528
|
+
command = make_simple_command(:get, 'v1/{+parent}/services', options)
|
|
529
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::ListServicesResponse::Representation
|
|
530
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::ListServicesResponse
|
|
531
|
+
command.params['parent'] = parent unless parent.nil?
|
|
532
|
+
command.query['filter'] = filter unless filter.nil?
|
|
533
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
534
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
535
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
536
|
+
command.query['fields'] = fields unless fields.nil?
|
|
537
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
538
|
+
execute_or_queue_command(command, &block)
|
|
539
|
+
end
|
|
540
|
+
|
|
541
|
+
# Updates the parameters of a single Service.
|
|
542
|
+
# @param [String] name
|
|
543
|
+
# Identifier. The relative resource name of the Firebase Data Connect service,
|
|
544
|
+
# in the format: ``` projects/`project`/locations/`location`/services/`service` `
|
|
545
|
+
# `` Note that the service ID is specific to Firebase Data Connect and does not
|
|
546
|
+
# correspond to any of the instance IDs of the underlying data source
|
|
547
|
+
# connections.
|
|
548
|
+
# @param [Google::Apis::FirebasedataconnectV1::Service] service_object
|
|
549
|
+
# @param [Boolean] allow_missing
|
|
550
|
+
# Optional. If true and the Service is not found, a new Service will be created.
|
|
551
|
+
# In this case, `update_mask` is ignored.
|
|
552
|
+
# @param [String] request_id
|
|
553
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
554
|
+
# request ID so that if you must retry your request, the server will know to
|
|
555
|
+
# ignore the request if it has already been completed. The server will guarantee
|
|
556
|
+
# that for at least 60 minutes since the first request. For example, consider a
|
|
557
|
+
# situation where you make an initial request and the request times out. If you
|
|
558
|
+
# make the request again with the same request ID, the server can check if
|
|
559
|
+
# original operation with the same request ID was received, and if so, will
|
|
560
|
+
# ignore the second request. This prevents clients from accidentally creating
|
|
561
|
+
# duplicate commitments. The request ID must be a valid UUID with the exception
|
|
562
|
+
# that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
563
|
+
# @param [String] update_mask
|
|
564
|
+
# Optional. Field mask is used to specify the fields to be overwritten in the
|
|
565
|
+
# Service resource by the update. The fields specified in the update_mask are
|
|
566
|
+
# relative to the resource, not the full request. A field will be overwritten if
|
|
567
|
+
# it is in the mask. If the user does not provide a mask then all fields will be
|
|
568
|
+
# overwritten.
|
|
569
|
+
# @param [Boolean] validate_only
|
|
570
|
+
# Optional. If set, validate the request and preview the Service, but do not
|
|
571
|
+
# actually update it.
|
|
572
|
+
# @param [String] fields
|
|
573
|
+
# Selector specifying which fields to include in a partial response.
|
|
574
|
+
# @param [String] quota_user
|
|
575
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
576
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
577
|
+
# @param [Google::Apis::RequestOptions] options
|
|
578
|
+
# Request-specific options
|
|
579
|
+
#
|
|
580
|
+
# @yield [result, err] Result & error if block supplied
|
|
581
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Operation] parsed result object
|
|
582
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
583
|
+
#
|
|
584
|
+
# @return [Google::Apis::FirebasedataconnectV1::Operation]
|
|
585
|
+
#
|
|
586
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
587
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
588
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
589
|
+
def patch_project_location_service(name, service_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
590
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
591
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::Service::Representation
|
|
592
|
+
command.request_object = service_object
|
|
593
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Operation::Representation
|
|
594
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Operation
|
|
595
|
+
command.params['name'] = name unless name.nil?
|
|
596
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
|
597
|
+
command.query['requestId'] = request_id unless request_id.nil?
|
|
598
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
599
|
+
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
600
|
+
command.query['fields'] = fields unless fields.nil?
|
|
601
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
602
|
+
execute_or_queue_command(command, &block)
|
|
603
|
+
end
|
|
604
|
+
|
|
605
|
+
# Creates a new Connector in a given project and location. The operations are
|
|
606
|
+
# validated against and must be compatible with the active schema. If the
|
|
607
|
+
# operations and schema are not compatible or if the schema is not present, this
|
|
608
|
+
# will result in an error.
|
|
609
|
+
# @param [String] parent
|
|
610
|
+
# Required. Value for parent.
|
|
611
|
+
# @param [Google::Apis::FirebasedataconnectV1::Connector] connector_object
|
|
612
|
+
# @param [String] connector_id
|
|
613
|
+
# Required. The ID to use for the connector, which will become the final
|
|
614
|
+
# component of the connector's resource name.
|
|
615
|
+
# @param [String] request_id
|
|
616
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
617
|
+
# request ID so that if you must retry your request, the server will know to
|
|
618
|
+
# ignore the request if it has already been completed. The server will guarantee
|
|
619
|
+
# that for at least 60 minutes since the first request. For example, consider a
|
|
620
|
+
# situation where you make an initial request and the request times out. If you
|
|
621
|
+
# make the request again with the same request ID, the server can check if
|
|
622
|
+
# original operation with the same request ID was received, and if so, will
|
|
623
|
+
# ignore the second request. This prevents clients from accidentally creating
|
|
624
|
+
# duplicate commitments. The request ID must be a valid UUID with the exception
|
|
625
|
+
# that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
626
|
+
# @param [Boolean] validate_only
|
|
627
|
+
# Optional. If set, validate the request and preview the Connector, but do not
|
|
628
|
+
# actually create it.
|
|
629
|
+
# @param [String] fields
|
|
630
|
+
# Selector specifying which fields to include in a partial response.
|
|
631
|
+
# @param [String] quota_user
|
|
632
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
633
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
634
|
+
# @param [Google::Apis::RequestOptions] options
|
|
635
|
+
# Request-specific options
|
|
636
|
+
#
|
|
637
|
+
# @yield [result, err] Result & error if block supplied
|
|
638
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Operation] parsed result object
|
|
639
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
640
|
+
#
|
|
641
|
+
# @return [Google::Apis::FirebasedataconnectV1::Operation]
|
|
642
|
+
#
|
|
643
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
644
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
645
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
646
|
+
def create_project_location_service_connector(parent, connector_object = nil, connector_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
647
|
+
command = make_simple_command(:post, 'v1/{+parent}/connectors', options)
|
|
648
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::Connector::Representation
|
|
649
|
+
command.request_object = connector_object
|
|
650
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Operation::Representation
|
|
651
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Operation
|
|
652
|
+
command.params['parent'] = parent unless parent.nil?
|
|
653
|
+
command.query['connectorId'] = connector_id unless connector_id.nil?
|
|
654
|
+
command.query['requestId'] = request_id unless request_id.nil?
|
|
655
|
+
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
656
|
+
command.query['fields'] = fields unless fields.nil?
|
|
657
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
658
|
+
execute_or_queue_command(command, &block)
|
|
659
|
+
end
|
|
660
|
+
|
|
661
|
+
# Deletes a single Connector.
|
|
662
|
+
# @param [String] name
|
|
663
|
+
# Required. The name of the connector to delete, in the format: ``` projects/`
|
|
664
|
+
# project`/locations/`location`/services/`service`/connectors/`connector` ```
|
|
665
|
+
# @param [Boolean] allow_missing
|
|
666
|
+
# Optional. If true and the Connector is not found, the request will succeed but
|
|
667
|
+
# no action will be taken on the server.
|
|
668
|
+
# @param [String] etag
|
|
669
|
+
# Optional. The etag of the Connector. If this is provided, it must match the
|
|
670
|
+
# server's etag.
|
|
671
|
+
# @param [Boolean] force
|
|
672
|
+
# Optional. If set to true, any child resources (i.e. ConnectorRevisions) will
|
|
673
|
+
# also be deleted. Otherwise, the request will only work if the Connector has no
|
|
674
|
+
# child resources.
|
|
675
|
+
# @param [String] request_id
|
|
676
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
677
|
+
# request ID so that if you must retry your request, the server will know to
|
|
678
|
+
# ignore the request if it has already been completed. The server will guarantee
|
|
679
|
+
# that for at least 60 minutes after the first request. For example, consider a
|
|
680
|
+
# situation where you make an initial request and the request times out. If you
|
|
681
|
+
# make the request again with the same request ID, the server can check if
|
|
682
|
+
# original operation with the same request ID was received, and if so, will
|
|
683
|
+
# ignore the second request. This prevents clients from accidentally creating
|
|
684
|
+
# duplicate commitments. The request ID must be a valid UUID with the exception
|
|
685
|
+
# that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
686
|
+
# @param [Boolean] validate_only
|
|
687
|
+
# Optional. If set, validate the request and preview the Connector, but do not
|
|
688
|
+
# actually delete it.
|
|
689
|
+
# @param [String] fields
|
|
690
|
+
# Selector specifying which fields to include in a partial response.
|
|
691
|
+
# @param [String] quota_user
|
|
692
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
693
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
694
|
+
# @param [Google::Apis::RequestOptions] options
|
|
695
|
+
# Request-specific options
|
|
696
|
+
#
|
|
697
|
+
# @yield [result, err] Result & error if block supplied
|
|
698
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Operation] parsed result object
|
|
699
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
700
|
+
#
|
|
701
|
+
# @return [Google::Apis::FirebasedataconnectV1::Operation]
|
|
702
|
+
#
|
|
703
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
704
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
705
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
706
|
+
def delete_project_location_service_connector(name, allow_missing: nil, etag: nil, force: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
707
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
708
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Operation::Representation
|
|
709
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Operation
|
|
710
|
+
command.params['name'] = name unless name.nil?
|
|
711
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
|
712
|
+
command.query['etag'] = etag unless etag.nil?
|
|
713
|
+
command.query['force'] = force unless force.nil?
|
|
714
|
+
command.query['requestId'] = request_id unless request_id.nil?
|
|
715
|
+
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
716
|
+
command.query['fields'] = fields unless fields.nil?
|
|
717
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
718
|
+
execute_or_queue_command(command, &block)
|
|
719
|
+
end
|
|
720
|
+
|
|
721
|
+
# Execute a predefined mutation in a Connector.
|
|
722
|
+
# @param [String] name
|
|
723
|
+
# Required. The resource name of the connector to find the predefined mutation,
|
|
724
|
+
# in the format: ``` projects/`project`/locations/`location`/services/`service`/
|
|
725
|
+
# connectors/`connector` ```
|
|
726
|
+
# @param [Google::Apis::FirebasedataconnectV1::ExecuteMutationRequest] execute_mutation_request_object
|
|
727
|
+
# @param [String] fields
|
|
728
|
+
# Selector specifying which fields to include in a partial response.
|
|
729
|
+
# @param [String] quota_user
|
|
730
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
731
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
732
|
+
# @param [Google::Apis::RequestOptions] options
|
|
733
|
+
# Request-specific options
|
|
734
|
+
#
|
|
735
|
+
# @yield [result, err] Result & error if block supplied
|
|
736
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::ExecuteMutationResponse] parsed result object
|
|
737
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
738
|
+
#
|
|
739
|
+
# @return [Google::Apis::FirebasedataconnectV1::ExecuteMutationResponse]
|
|
740
|
+
#
|
|
741
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
742
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
743
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
744
|
+
def execute_connector_mutation(name, execute_mutation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
745
|
+
command = make_simple_command(:post, 'v1/{+name}:executeMutation', options)
|
|
746
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::ExecuteMutationRequest::Representation
|
|
747
|
+
command.request_object = execute_mutation_request_object
|
|
748
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::ExecuteMutationResponse::Representation
|
|
749
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::ExecuteMutationResponse
|
|
750
|
+
command.params['name'] = name unless name.nil?
|
|
751
|
+
command.query['fields'] = fields unless fields.nil?
|
|
752
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
753
|
+
execute_or_queue_command(command, &block)
|
|
754
|
+
end
|
|
755
|
+
|
|
756
|
+
# Execute a predefined query in a Connector.
|
|
757
|
+
# @param [String] name
|
|
758
|
+
# Required. The resource name of the connector to find the predefined query, in
|
|
759
|
+
# the format: ``` projects/`project`/locations/`location`/services/`service`/
|
|
760
|
+
# connectors/`connector` ```
|
|
761
|
+
# @param [Google::Apis::FirebasedataconnectV1::ExecuteQueryRequest] execute_query_request_object
|
|
762
|
+
# @param [String] fields
|
|
763
|
+
# Selector specifying which fields to include in a partial response.
|
|
764
|
+
# @param [String] quota_user
|
|
765
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
766
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
767
|
+
# @param [Google::Apis::RequestOptions] options
|
|
768
|
+
# Request-specific options
|
|
769
|
+
#
|
|
770
|
+
# @yield [result, err] Result & error if block supplied
|
|
771
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::ExecuteQueryResponse] parsed result object
|
|
772
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
773
|
+
#
|
|
774
|
+
# @return [Google::Apis::FirebasedataconnectV1::ExecuteQueryResponse]
|
|
775
|
+
#
|
|
776
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
777
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
778
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
779
|
+
def execute_connector_query(name, execute_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
780
|
+
command = make_simple_command(:post, 'v1/{+name}:executeQuery', options)
|
|
781
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::ExecuteQueryRequest::Representation
|
|
782
|
+
command.request_object = execute_query_request_object
|
|
783
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::ExecuteQueryResponse::Representation
|
|
784
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::ExecuteQueryResponse
|
|
785
|
+
command.params['name'] = name unless name.nil?
|
|
786
|
+
command.query['fields'] = fields unless fields.nil?
|
|
787
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
788
|
+
execute_or_queue_command(command, &block)
|
|
789
|
+
end
|
|
790
|
+
|
|
791
|
+
# Gets details of a single Connector.
|
|
792
|
+
# @param [String] name
|
|
793
|
+
# Required. The name of the connector to retrieve, in the format: ``` projects/`
|
|
794
|
+
# project`/locations/`location`/services/`service`/connectors/`connector` ```
|
|
795
|
+
# @param [String] fields
|
|
796
|
+
# Selector specifying which fields to include in a partial response.
|
|
797
|
+
# @param [String] quota_user
|
|
798
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
799
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
800
|
+
# @param [Google::Apis::RequestOptions] options
|
|
801
|
+
# Request-specific options
|
|
802
|
+
#
|
|
803
|
+
# @yield [result, err] Result & error if block supplied
|
|
804
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Connector] parsed result object
|
|
805
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
806
|
+
#
|
|
807
|
+
# @return [Google::Apis::FirebasedataconnectV1::Connector]
|
|
808
|
+
#
|
|
809
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
810
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
811
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
812
|
+
def get_project_location_service_connector(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
813
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
814
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Connector::Representation
|
|
815
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Connector
|
|
816
|
+
command.params['name'] = name unless name.nil?
|
|
817
|
+
command.query['fields'] = fields unless fields.nil?
|
|
818
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
819
|
+
execute_or_queue_command(command, &block)
|
|
820
|
+
end
|
|
821
|
+
|
|
822
|
+
# Lists Connectors in a given project and location.
|
|
823
|
+
# @param [String] parent
|
|
824
|
+
# Required. Value of parent.
|
|
825
|
+
# @param [String] filter
|
|
826
|
+
# Optional. Filtering results.
|
|
827
|
+
# @param [String] order_by
|
|
828
|
+
# Optional. Hint for how to order the results.
|
|
829
|
+
# @param [Fixnum] page_size
|
|
830
|
+
# Optional. Requested page size. Server may return fewer items than requested.
|
|
831
|
+
# If unspecified, server will pick an appropriate default.
|
|
832
|
+
# @param [String] page_token
|
|
833
|
+
# Optional. A page token, received from a previous `ListConnectors` call.
|
|
834
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
|
835
|
+
# parameters provided to `ListConnectors` must match the call that provided the
|
|
836
|
+
# page token.
|
|
837
|
+
# @param [String] fields
|
|
838
|
+
# Selector specifying which fields to include in a partial response.
|
|
839
|
+
# @param [String] quota_user
|
|
840
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
841
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
842
|
+
# @param [Google::Apis::RequestOptions] options
|
|
843
|
+
# Request-specific options
|
|
844
|
+
#
|
|
845
|
+
# @yield [result, err] Result & error if block supplied
|
|
846
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::ListConnectorsResponse] parsed result object
|
|
847
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
848
|
+
#
|
|
849
|
+
# @return [Google::Apis::FirebasedataconnectV1::ListConnectorsResponse]
|
|
850
|
+
#
|
|
851
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
852
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
853
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
854
|
+
def list_project_location_service_connectors(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
855
|
+
command = make_simple_command(:get, 'v1/{+parent}/connectors', options)
|
|
856
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::ListConnectorsResponse::Representation
|
|
857
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::ListConnectorsResponse
|
|
858
|
+
command.params['parent'] = parent unless parent.nil?
|
|
859
|
+
command.query['filter'] = filter unless filter.nil?
|
|
860
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
861
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
862
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
863
|
+
command.query['fields'] = fields unless fields.nil?
|
|
864
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
865
|
+
execute_or_queue_command(command, &block)
|
|
866
|
+
end
|
|
867
|
+
|
|
868
|
+
# Updates the parameters of a single Connector, and creates a new
|
|
869
|
+
# ConnectorRevision with the updated Connector. The operations are validated
|
|
870
|
+
# against and must be compatible with the live schema. If the operations and
|
|
871
|
+
# schema are not compatible or if the schema is not present, this will result in
|
|
872
|
+
# an error.
|
|
873
|
+
# @param [String] name
|
|
874
|
+
# Identifier. The relative resource name of the connector, in the format: ```
|
|
875
|
+
# projects/`project`/locations/`location`/services/`service`/connectors/`
|
|
876
|
+
# connector` ```
|
|
877
|
+
# @param [Google::Apis::FirebasedataconnectV1::Connector] connector_object
|
|
878
|
+
# @param [Boolean] allow_missing
|
|
879
|
+
# Optional. If true and the Connector is not found, a new Connector will be
|
|
880
|
+
# created. In this case, `update_mask` is ignored.
|
|
881
|
+
# @param [String] request_id
|
|
882
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
883
|
+
# request ID so that if you must retry your request, the server will know to
|
|
884
|
+
# ignore the request if it has already been completed. The server will guarantee
|
|
885
|
+
# that for at least 60 minutes since the first request. For example, consider a
|
|
886
|
+
# situation where you make an initial request and the request times out. If you
|
|
887
|
+
# make the request again with the same request ID, the server can check if
|
|
888
|
+
# original operation with the same request ID was received, and if so, will
|
|
889
|
+
# ignore the second request. This prevents clients from accidentally creating
|
|
890
|
+
# duplicate commitments. The request ID must be a valid UUID with the exception
|
|
891
|
+
# that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
892
|
+
# @param [String] update_mask
|
|
893
|
+
# Optional. Field mask is used to specify the fields to be overwritten in the
|
|
894
|
+
# Connector resource by the update. The fields specified in the update_mask are
|
|
895
|
+
# relative to the resource, not the full request. A field will be overwritten if
|
|
896
|
+
# it is in the mask. If the user does not provide a mask then all fields will be
|
|
897
|
+
# overwritten.
|
|
898
|
+
# @param [Boolean] validate_only
|
|
899
|
+
# Optional. If set, validate the request and preview the Connector, but do not
|
|
900
|
+
# actually update it.
|
|
901
|
+
# @param [String] fields
|
|
902
|
+
# Selector specifying which fields to include in a partial response.
|
|
903
|
+
# @param [String] quota_user
|
|
904
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
905
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
906
|
+
# @param [Google::Apis::RequestOptions] options
|
|
907
|
+
# Request-specific options
|
|
908
|
+
#
|
|
909
|
+
# @yield [result, err] Result & error if block supplied
|
|
910
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Operation] parsed result object
|
|
911
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
912
|
+
#
|
|
913
|
+
# @return [Google::Apis::FirebasedataconnectV1::Operation]
|
|
914
|
+
#
|
|
915
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
916
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
917
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
918
|
+
def patch_project_location_service_connector(name, connector_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
919
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
920
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::Connector::Representation
|
|
921
|
+
command.request_object = connector_object
|
|
922
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Operation::Representation
|
|
923
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Operation
|
|
924
|
+
command.params['name'] = name unless name.nil?
|
|
925
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
|
926
|
+
command.query['requestId'] = request_id unless request_id.nil?
|
|
927
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
928
|
+
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
929
|
+
command.query['fields'] = fields unless fields.nil?
|
|
930
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
931
|
+
execute_or_queue_command(command, &block)
|
|
932
|
+
end
|
|
933
|
+
|
|
934
|
+
# Creates a new Schema in a given project and location. Only creation of `
|
|
935
|
+
# schemas/main` is supported and calling create with any other schema ID will
|
|
936
|
+
# result in an error.
|
|
937
|
+
# @param [String] parent
|
|
938
|
+
# Required. Value for parent.
|
|
939
|
+
# @param [Google::Apis::FirebasedataconnectV1::Schema] schema_object
|
|
940
|
+
# @param [String] request_id
|
|
941
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
942
|
+
# request ID so that if you must retry your request, the server will know to
|
|
943
|
+
# ignore the request if it has already been completed. The server will guarantee
|
|
944
|
+
# that for at least 60 minutes since the first request. For example, consider a
|
|
945
|
+
# situation where you make an initial request and the request times out. If you
|
|
946
|
+
# make the request again with the same request ID, the server can check if
|
|
947
|
+
# original operation with the same request ID was received, and if so, will
|
|
948
|
+
# ignore the second request. This prevents clients from accidentally creating
|
|
949
|
+
# duplicate commitments. The request ID must be a valid UUID with the exception
|
|
950
|
+
# that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
951
|
+
# @param [String] schema_id
|
|
952
|
+
# Required. The ID to use for the schema, which will become the final component
|
|
953
|
+
# of the schema's resource name. Currently, only `main` is supported and any
|
|
954
|
+
# other schema ID will result in an error.
|
|
955
|
+
# @param [Boolean] validate_only
|
|
956
|
+
# Optional. If set, validate the request and preview the Schema, but do not
|
|
957
|
+
# actually update it.
|
|
958
|
+
# @param [String] fields
|
|
959
|
+
# Selector specifying which fields to include in a partial response.
|
|
960
|
+
# @param [String] quota_user
|
|
961
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
962
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
963
|
+
# @param [Google::Apis::RequestOptions] options
|
|
964
|
+
# Request-specific options
|
|
965
|
+
#
|
|
966
|
+
# @yield [result, err] Result & error if block supplied
|
|
967
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Operation] parsed result object
|
|
968
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
969
|
+
#
|
|
970
|
+
# @return [Google::Apis::FirebasedataconnectV1::Operation]
|
|
971
|
+
#
|
|
972
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
973
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
974
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
975
|
+
def create_project_location_service_schema(parent, schema_object = nil, request_id: nil, schema_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
976
|
+
command = make_simple_command(:post, 'v1/{+parent}/schemas', options)
|
|
977
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::Schema::Representation
|
|
978
|
+
command.request_object = schema_object
|
|
979
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Operation::Representation
|
|
980
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Operation
|
|
981
|
+
command.params['parent'] = parent unless parent.nil?
|
|
982
|
+
command.query['requestId'] = request_id unless request_id.nil?
|
|
983
|
+
command.query['schemaId'] = schema_id unless schema_id.nil?
|
|
984
|
+
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
985
|
+
command.query['fields'] = fields unless fields.nil?
|
|
986
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
987
|
+
execute_or_queue_command(command, &block)
|
|
988
|
+
end
|
|
989
|
+
|
|
990
|
+
# Deletes a single Schema. Because the schema and connectors must be compatible
|
|
991
|
+
# at all times, if this is called while any connectors are active, this will
|
|
992
|
+
# result in an error.
|
|
993
|
+
# @param [String] name
|
|
994
|
+
# Required. The name of the schema to delete, in the format: ``` projects/`
|
|
995
|
+
# project`/locations/`location`/services/`service`/schemas/`schema` ```
|
|
996
|
+
# @param [Boolean] allow_missing
|
|
997
|
+
# Optional. If true and the Schema is not found, the request will succeed but no
|
|
998
|
+
# action will be taken on the server.
|
|
999
|
+
# @param [String] etag
|
|
1000
|
+
# Optional. The etag of the Schema. If this is provided, it must match the
|
|
1001
|
+
# server's etag.
|
|
1002
|
+
# @param [Boolean] force
|
|
1003
|
+
# Optional. If set to true, any child resources (i.e. SchemaRevisions) will also
|
|
1004
|
+
# be deleted.
|
|
1005
|
+
# @param [String] request_id
|
|
1006
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
1007
|
+
# request ID so that if you must retry your request, the server will know to
|
|
1008
|
+
# ignore the request if it has already been completed. The server will guarantee
|
|
1009
|
+
# that for at least 60 minutes after the first request. For example, consider a
|
|
1010
|
+
# situation where you make an initial request and the request times out. If you
|
|
1011
|
+
# make the request again with the same request ID, the server can check if
|
|
1012
|
+
# original operation with the same request ID was received, and if so, will
|
|
1013
|
+
# ignore the second request. This prevents clients from accidentally creating
|
|
1014
|
+
# duplicate commitments. The request ID must be a valid UUID with the exception
|
|
1015
|
+
# that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
1016
|
+
# @param [Boolean] validate_only
|
|
1017
|
+
# Optional. If set, validate the request and preview the Schema, but do not
|
|
1018
|
+
# actually delete it.
|
|
1019
|
+
# @param [String] fields
|
|
1020
|
+
# Selector specifying which fields to include in a partial response.
|
|
1021
|
+
# @param [String] quota_user
|
|
1022
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1023
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1024
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1025
|
+
# Request-specific options
|
|
1026
|
+
#
|
|
1027
|
+
# @yield [result, err] Result & error if block supplied
|
|
1028
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Operation] parsed result object
|
|
1029
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1030
|
+
#
|
|
1031
|
+
# @return [Google::Apis::FirebasedataconnectV1::Operation]
|
|
1032
|
+
#
|
|
1033
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1034
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1035
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1036
|
+
def delete_project_location_service_schema(name, allow_missing: nil, etag: nil, force: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1037
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
1038
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Operation::Representation
|
|
1039
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Operation
|
|
1040
|
+
command.params['name'] = name unless name.nil?
|
|
1041
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
|
1042
|
+
command.query['etag'] = etag unless etag.nil?
|
|
1043
|
+
command.query['force'] = force unless force.nil?
|
|
1044
|
+
command.query['requestId'] = request_id unless request_id.nil?
|
|
1045
|
+
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
1046
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1047
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1048
|
+
execute_or_queue_command(command, &block)
|
|
1049
|
+
end
|
|
1050
|
+
|
|
1051
|
+
# Gets details of a single Schema.
|
|
1052
|
+
# @param [String] name
|
|
1053
|
+
# Required. The name of the schema to retrieve, in the format: ``` projects/`
|
|
1054
|
+
# project`/locations/`location`/services/`service`/schemas/`schema` ```
|
|
1055
|
+
# @param [String] fields
|
|
1056
|
+
# Selector specifying which fields to include in a partial response.
|
|
1057
|
+
# @param [String] quota_user
|
|
1058
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1059
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1060
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1061
|
+
# Request-specific options
|
|
1062
|
+
#
|
|
1063
|
+
# @yield [result, err] Result & error if block supplied
|
|
1064
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Schema] parsed result object
|
|
1065
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1066
|
+
#
|
|
1067
|
+
# @return [Google::Apis::FirebasedataconnectV1::Schema]
|
|
1068
|
+
#
|
|
1069
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1070
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1071
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1072
|
+
def get_project_location_service_schema(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1073
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
1074
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Schema::Representation
|
|
1075
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Schema
|
|
1076
|
+
command.params['name'] = name unless name.nil?
|
|
1077
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1078
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1079
|
+
execute_or_queue_command(command, &block)
|
|
1080
|
+
end
|
|
1081
|
+
|
|
1082
|
+
# Lists Schemas in a given project and location. Note that only `schemas/main`
|
|
1083
|
+
# is supported, so this will always return at most one Schema.
|
|
1084
|
+
# @param [String] parent
|
|
1085
|
+
# Required. Value of parent.
|
|
1086
|
+
# @param [String] filter
|
|
1087
|
+
# Optional. Filtering results.
|
|
1088
|
+
# @param [String] order_by
|
|
1089
|
+
# Optional. Hint for how to order the results.
|
|
1090
|
+
# @param [Fixnum] page_size
|
|
1091
|
+
# Optional. Requested page size. Server may return fewer items than requested.
|
|
1092
|
+
# If unspecified, server will pick an appropriate default.
|
|
1093
|
+
# @param [String] page_token
|
|
1094
|
+
# Optional. A page token, received from a previous `ListSchemas` call. Provide
|
|
1095
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
|
1096
|
+
# provided to `ListSchemas` must match the call that provided the page token.
|
|
1097
|
+
# @param [String] fields
|
|
1098
|
+
# Selector specifying which fields to include in a partial response.
|
|
1099
|
+
# @param [String] quota_user
|
|
1100
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1101
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1102
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1103
|
+
# Request-specific options
|
|
1104
|
+
#
|
|
1105
|
+
# @yield [result, err] Result & error if block supplied
|
|
1106
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::ListSchemasResponse] parsed result object
|
|
1107
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1108
|
+
#
|
|
1109
|
+
# @return [Google::Apis::FirebasedataconnectV1::ListSchemasResponse]
|
|
1110
|
+
#
|
|
1111
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1112
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1113
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1114
|
+
def list_project_location_service_schemas(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1115
|
+
command = make_simple_command(:get, 'v1/{+parent}/schemas', options)
|
|
1116
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::ListSchemasResponse::Representation
|
|
1117
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::ListSchemasResponse
|
|
1118
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1119
|
+
command.query['filter'] = filter unless filter.nil?
|
|
1120
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
1121
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
1122
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1123
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1124
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1125
|
+
execute_or_queue_command(command, &block)
|
|
1126
|
+
end
|
|
1127
|
+
|
|
1128
|
+
# Updates the parameters of a single Schema, and creates a new SchemaRevision
|
|
1129
|
+
# with the updated Schema.
|
|
1130
|
+
# @param [String] name
|
|
1131
|
+
# Identifier. The relative resource name of the schema, in the format: ```
|
|
1132
|
+
# projects/`project`/locations/`location`/services/`service`/schemas/`schema` ```
|
|
1133
|
+
# Right now, the only supported schema is "main".
|
|
1134
|
+
# @param [Google::Apis::FirebasedataconnectV1::Schema] schema_object
|
|
1135
|
+
# @param [Boolean] allow_missing
|
|
1136
|
+
# Optional. If true and the Schema is not found, a new Schema will be created.
|
|
1137
|
+
# In this case, `update_mask` is ignored.
|
|
1138
|
+
# @param [String] request_id
|
|
1139
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
1140
|
+
# request ID so that if you must retry your request, the server will know to
|
|
1141
|
+
# ignore the request if it has already been completed. The server will guarantee
|
|
1142
|
+
# that for at least 60 minutes since the first request. For example, consider a
|
|
1143
|
+
# situation where you make an initial request and the request times out. If you
|
|
1144
|
+
# make the request again with the same request ID, the server can check if
|
|
1145
|
+
# original operation with the same request ID was received, and if so, will
|
|
1146
|
+
# ignore the second request. This prevents clients from accidentally creating
|
|
1147
|
+
# duplicate commitments. The request ID must be a valid UUID with the exception
|
|
1148
|
+
# that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
1149
|
+
# @param [String] update_mask
|
|
1150
|
+
# Optional. Field mask is used to specify the fields to be overwritten in the
|
|
1151
|
+
# Schema resource by the update. The fields specified in the update_mask are
|
|
1152
|
+
# relative to the resource, not the full request. A field will be overwritten if
|
|
1153
|
+
# it is in the mask. If the user does not provide a mask then all fields will be
|
|
1154
|
+
# overwritten.
|
|
1155
|
+
# @param [Boolean] validate_only
|
|
1156
|
+
# Optional. If set, validate the request and preview the Schema, but do not
|
|
1157
|
+
# actually update it.
|
|
1158
|
+
# @param [String] fields
|
|
1159
|
+
# Selector specifying which fields to include in a partial response.
|
|
1160
|
+
# @param [String] quota_user
|
|
1161
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1162
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1163
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1164
|
+
# Request-specific options
|
|
1165
|
+
#
|
|
1166
|
+
# @yield [result, err] Result & error if block supplied
|
|
1167
|
+
# @yieldparam result [Google::Apis::FirebasedataconnectV1::Operation] parsed result object
|
|
1168
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1169
|
+
#
|
|
1170
|
+
# @return [Google::Apis::FirebasedataconnectV1::Operation]
|
|
1171
|
+
#
|
|
1172
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1173
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1174
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1175
|
+
def patch_project_location_service_schema(name, schema_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1176
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
1177
|
+
command.request_representation = Google::Apis::FirebasedataconnectV1::Schema::Representation
|
|
1178
|
+
command.request_object = schema_object
|
|
1179
|
+
command.response_representation = Google::Apis::FirebasedataconnectV1::Operation::Representation
|
|
1180
|
+
command.response_class = Google::Apis::FirebasedataconnectV1::Operation
|
|
1181
|
+
command.params['name'] = name unless name.nil?
|
|
1182
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
|
1183
|
+
command.query['requestId'] = request_id unless request_id.nil?
|
|
1184
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1185
|
+
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
1186
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1187
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1188
|
+
execute_or_queue_command(command, &block)
|
|
1189
|
+
end
|
|
1190
|
+
|
|
1191
|
+
protected
|
|
1192
|
+
|
|
1193
|
+
def apply_command_defaults(command)
|
|
1194
|
+
command.query['key'] = key unless key.nil?
|
|
1195
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1196
|
+
end
|
|
1197
|
+
end
|
|
1198
|
+
end
|
|
1199
|
+
end
|
|
1200
|
+
end
|