google-cloud-memorystore-v1beta 0.a → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +154 -8
- data/lib/google/cloud/memorystore/v1beta/bindings_override.rb +102 -0
- data/lib/google/cloud/memorystore/v1beta/memorystore/credentials.rb +47 -0
- data/lib/google/cloud/memorystore/v1beta/memorystore/paths.rb +124 -0
- data/lib/google/cloud/memorystore/v1beta/memorystore/rest/client.rb +1006 -0
- data/lib/google/cloud/memorystore/v1beta/memorystore/rest/operations.rb +906 -0
- data/lib/google/cloud/memorystore/v1beta/memorystore/rest/service_stub.rb +449 -0
- data/lib/google/cloud/memorystore/v1beta/memorystore/rest.rb +54 -0
- data/lib/google/cloud/memorystore/v1beta/memorystore.rb +48 -0
- data/lib/google/cloud/memorystore/v1beta/memorystore_pb.rb +88 -0
- data/lib/google/cloud/memorystore/v1beta/memorystore_services_pb.rb +55 -0
- data/lib/google/cloud/memorystore/v1beta/rest.rb +38 -0
- data/lib/google/cloud/memorystore/v1beta/version.rb +7 -2
- data/lib/google/cloud/memorystore/v1beta.rb +40 -0
- data/lib/google-cloud-memorystore-v1beta.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +459 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/field_info.rb +88 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/cloud/memorystore/v1beta/memorystore.rb +714 -0
- data/proto_docs/google/longrunning/operations.rb +169 -0
- data/proto_docs/google/protobuf/any.rb +145 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- metadata +92 -10
@@ -0,0 +1,1006 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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
|
+
require "google/cloud/errors"
|
20
|
+
require "google/cloud/memorystore/v1beta/memorystore_pb"
|
21
|
+
require "google/cloud/memorystore/v1beta/memorystore/rest/service_stub"
|
22
|
+
require "google/cloud/location/rest"
|
23
|
+
|
24
|
+
module Google
|
25
|
+
module Cloud
|
26
|
+
module Memorystore
|
27
|
+
module V1beta
|
28
|
+
module Memorystore
|
29
|
+
module Rest
|
30
|
+
##
|
31
|
+
# REST client for the Memorystore service.
|
32
|
+
#
|
33
|
+
# Service describing handlers for resources
|
34
|
+
#
|
35
|
+
class Client
|
36
|
+
# @private
|
37
|
+
API_VERSION = ""
|
38
|
+
|
39
|
+
# @private
|
40
|
+
DEFAULT_ENDPOINT_TEMPLATE = "memorystore.$UNIVERSE_DOMAIN$"
|
41
|
+
|
42
|
+
include Paths
|
43
|
+
|
44
|
+
# @private
|
45
|
+
attr_reader :memorystore_stub
|
46
|
+
|
47
|
+
##
|
48
|
+
# Configure the Memorystore Client class.
|
49
|
+
#
|
50
|
+
# See {::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client::Configuration}
|
51
|
+
# for a description of the configuration fields.
|
52
|
+
#
|
53
|
+
# @example
|
54
|
+
#
|
55
|
+
# # Modify the configuration for all Memorystore clients
|
56
|
+
# ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.configure do |config|
|
57
|
+
# config.timeout = 10.0
|
58
|
+
# end
|
59
|
+
#
|
60
|
+
# @yield [config] Configure the Client client.
|
61
|
+
# @yieldparam config [Client::Configuration]
|
62
|
+
#
|
63
|
+
# @return [Client::Configuration]
|
64
|
+
#
|
65
|
+
def self.configure
|
66
|
+
@configure ||= begin
|
67
|
+
namespace = ["Google", "Cloud", "Memorystore", "V1beta"]
|
68
|
+
parent_config = while namespace.any?
|
69
|
+
parent_name = namespace.join "::"
|
70
|
+
parent_const = const_get parent_name
|
71
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
72
|
+
namespace.pop
|
73
|
+
end
|
74
|
+
default_config = Client::Configuration.new parent_config
|
75
|
+
|
76
|
+
default_config.rpcs.list_instances.timeout = 60.0
|
77
|
+
default_config.rpcs.list_instances.retry_policy = {
|
78
|
+
initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
|
79
|
+
}
|
80
|
+
|
81
|
+
default_config.rpcs.get_instance.timeout = 60.0
|
82
|
+
default_config.rpcs.get_instance.retry_policy = {
|
83
|
+
initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
|
84
|
+
}
|
85
|
+
|
86
|
+
default_config.rpcs.create_instance.timeout = 600.0
|
87
|
+
|
88
|
+
default_config.rpcs.update_instance.timeout = 600.0
|
89
|
+
|
90
|
+
default_config.rpcs.delete_instance.timeout = 600.0
|
91
|
+
|
92
|
+
default_config.rpcs.get_certificate_authority.timeout = 60.0
|
93
|
+
default_config.rpcs.get_certificate_authority.retry_policy = {
|
94
|
+
initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
|
95
|
+
}
|
96
|
+
|
97
|
+
default_config
|
98
|
+
end
|
99
|
+
yield @configure if block_given?
|
100
|
+
@configure
|
101
|
+
end
|
102
|
+
|
103
|
+
##
|
104
|
+
# Configure the Memorystore Client instance.
|
105
|
+
#
|
106
|
+
# The configuration is set to the derived mode, meaning that values can be changed,
|
107
|
+
# but structural changes (adding new fields, etc.) are not allowed. Structural changes
|
108
|
+
# should be made on {Client.configure}.
|
109
|
+
#
|
110
|
+
# See {::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client::Configuration}
|
111
|
+
# for a description of the configuration fields.
|
112
|
+
#
|
113
|
+
# @yield [config] Configure the Client client.
|
114
|
+
# @yieldparam config [Client::Configuration]
|
115
|
+
#
|
116
|
+
# @return [Client::Configuration]
|
117
|
+
#
|
118
|
+
def configure
|
119
|
+
yield @config if block_given?
|
120
|
+
@config
|
121
|
+
end
|
122
|
+
|
123
|
+
##
|
124
|
+
# The effective universe domain
|
125
|
+
#
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
def universe_domain
|
129
|
+
@memorystore_stub.universe_domain
|
130
|
+
end
|
131
|
+
|
132
|
+
##
|
133
|
+
# Create a new Memorystore REST client object.
|
134
|
+
#
|
135
|
+
# @example
|
136
|
+
#
|
137
|
+
# # Create a client using the default configuration
|
138
|
+
# client = ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new
|
139
|
+
#
|
140
|
+
# # Create a client using a custom configuration
|
141
|
+
# client = ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new do |config|
|
142
|
+
# config.timeout = 10.0
|
143
|
+
# end
|
144
|
+
#
|
145
|
+
# @yield [config] Configure the Memorystore client.
|
146
|
+
# @yieldparam config [Client::Configuration]
|
147
|
+
#
|
148
|
+
def initialize
|
149
|
+
# Create the configuration object
|
150
|
+
@config = Configuration.new Client.configure
|
151
|
+
|
152
|
+
# Yield the configuration if needed
|
153
|
+
yield @config if block_given?
|
154
|
+
|
155
|
+
# Create credentials
|
156
|
+
credentials = @config.credentials
|
157
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
158
|
+
# but only if the default endpoint does not have a region prefix.
|
159
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
160
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
161
|
+
!@config.endpoint.split(".").first.include?("-"))
|
162
|
+
credentials ||= Credentials.default scope: @config.scope,
|
163
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
164
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
165
|
+
credentials = Credentials.new credentials, scope: @config.scope
|
166
|
+
end
|
167
|
+
|
168
|
+
@quota_project_id = @config.quota_project
|
169
|
+
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
170
|
+
|
171
|
+
@operations_client = ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Operations.new do |config|
|
172
|
+
config.credentials = credentials
|
173
|
+
config.quota_project = @quota_project_id
|
174
|
+
config.endpoint = @config.endpoint
|
175
|
+
config.universe_domain = @config.universe_domain
|
176
|
+
end
|
177
|
+
|
178
|
+
@memorystore_stub = ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::ServiceStub.new(
|
179
|
+
endpoint: @config.endpoint,
|
180
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
181
|
+
universe_domain: @config.universe_domain,
|
182
|
+
credentials: credentials,
|
183
|
+
logger: @config.logger
|
184
|
+
)
|
185
|
+
|
186
|
+
@memorystore_stub.logger(stub: true)&.info do |entry|
|
187
|
+
entry.set_system_name
|
188
|
+
entry.set_service
|
189
|
+
entry.message = "Created client for #{entry.service}"
|
190
|
+
entry.set_credentials_fields credentials
|
191
|
+
entry.set "customEndpoint", @config.endpoint if @config.endpoint
|
192
|
+
entry.set "defaultTimeout", @config.timeout if @config.timeout
|
193
|
+
entry.set "quotaProject", @quota_project_id if @quota_project_id
|
194
|
+
end
|
195
|
+
|
196
|
+
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
197
|
+
config.credentials = credentials
|
198
|
+
config.quota_project = @quota_project_id
|
199
|
+
config.endpoint = @memorystore_stub.endpoint
|
200
|
+
config.universe_domain = @memorystore_stub.universe_domain
|
201
|
+
config.bindings_override = @config.bindings_override
|
202
|
+
config.logger = @memorystore_stub.logger if config.respond_to? :logger=
|
203
|
+
end
|
204
|
+
end
|
205
|
+
|
206
|
+
##
|
207
|
+
# Get the associated client for long-running operations.
|
208
|
+
#
|
209
|
+
# @return [::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Operations]
|
210
|
+
#
|
211
|
+
attr_reader :operations_client
|
212
|
+
|
213
|
+
##
|
214
|
+
# Get the associated client for mix-in of the Locations.
|
215
|
+
#
|
216
|
+
# @return [Google::Cloud::Location::Locations::Rest::Client]
|
217
|
+
#
|
218
|
+
attr_reader :location_client
|
219
|
+
|
220
|
+
##
|
221
|
+
# The logger used for request/response debug logging.
|
222
|
+
#
|
223
|
+
# @return [Logger]
|
224
|
+
#
|
225
|
+
def logger
|
226
|
+
@memorystore_stub.logger
|
227
|
+
end
|
228
|
+
|
229
|
+
# Service calls
|
230
|
+
|
231
|
+
##
|
232
|
+
# Lists Instances in a given project and location.
|
233
|
+
#
|
234
|
+
# @overload list_instances(request, options = nil)
|
235
|
+
# Pass arguments to `list_instances` via a request object, either of type
|
236
|
+
# {::Google::Cloud::Memorystore::V1beta::ListInstancesRequest} or an equivalent Hash.
|
237
|
+
#
|
238
|
+
# @param request [::Google::Cloud::Memorystore::V1beta::ListInstancesRequest, ::Hash]
|
239
|
+
# A request object representing the call parameters. Required. To specify no
|
240
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
241
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
242
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
243
|
+
#
|
244
|
+
# @overload list_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
|
245
|
+
# Pass arguments to `list_instances` via keyword arguments. Note that at
|
246
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
247
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
248
|
+
#
|
249
|
+
# @param parent [::String]
|
250
|
+
# Required. The parent to list instances from.
|
251
|
+
# Format: projects/\\{project}/locations/\\{location}
|
252
|
+
# @param page_size [::Integer]
|
253
|
+
# Optional. Requested page size. Server may return fewer items than
|
254
|
+
# requested. If unspecified, server will pick an appropriate default.
|
255
|
+
# @param page_token [::String]
|
256
|
+
# Optional. A token identifying a page of results the server should return.
|
257
|
+
# @param filter [::String]
|
258
|
+
# Optional. Expression for filtering results.
|
259
|
+
# @param order_by [::String]
|
260
|
+
# Optional. Sort results by a defined order. Supported values: "name",
|
261
|
+
# "create_time".
|
262
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
263
|
+
# @yieldparam result [::Google::Cloud::Memorystore::V1beta::ListInstancesResponse]
|
264
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
265
|
+
#
|
266
|
+
# @return [::Google::Cloud::Memorystore::V1beta::ListInstancesResponse]
|
267
|
+
#
|
268
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
269
|
+
#
|
270
|
+
# @example Basic example
|
271
|
+
# require "google/cloud/memorystore/v1beta"
|
272
|
+
#
|
273
|
+
# # Create a client object. The client can be reused for multiple calls.
|
274
|
+
# client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new
|
275
|
+
#
|
276
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
277
|
+
# request = Google::Cloud::Memorystore::V1beta::ListInstancesRequest.new
|
278
|
+
#
|
279
|
+
# # Call the list_instances method.
|
280
|
+
# result = client.list_instances request
|
281
|
+
#
|
282
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
283
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
284
|
+
# result.each do |item|
|
285
|
+
# # Each element is of type ::Google::Cloud::Memorystore::V1beta::Instance.
|
286
|
+
# p item
|
287
|
+
# end
|
288
|
+
#
|
289
|
+
def list_instances request, options = nil
|
290
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
291
|
+
|
292
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Memorystore::V1beta::ListInstancesRequest
|
293
|
+
|
294
|
+
# Converts hash and nil to an options object
|
295
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
296
|
+
|
297
|
+
# Customize the options with defaults
|
298
|
+
call_metadata = @config.rpcs.list_instances.metadata.to_h
|
299
|
+
|
300
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
301
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
302
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
303
|
+
gapic_version: ::Google::Cloud::Memorystore::V1beta::VERSION,
|
304
|
+
transports_version_send: [:rest]
|
305
|
+
|
306
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
307
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
308
|
+
|
309
|
+
options.apply_defaults timeout: @config.rpcs.list_instances.timeout,
|
310
|
+
metadata: call_metadata,
|
311
|
+
retry_policy: @config.rpcs.list_instances.retry_policy
|
312
|
+
|
313
|
+
options.apply_defaults timeout: @config.timeout,
|
314
|
+
metadata: @config.metadata,
|
315
|
+
retry_policy: @config.retry_policy
|
316
|
+
|
317
|
+
@memorystore_stub.list_instances request, options do |result, operation|
|
318
|
+
yield result, operation if block_given?
|
319
|
+
end
|
320
|
+
rescue ::Gapic::Rest::Error => e
|
321
|
+
raise ::Google::Cloud::Error.from_error(e)
|
322
|
+
end
|
323
|
+
|
324
|
+
##
|
325
|
+
# Gets details of a single Instance.
|
326
|
+
#
|
327
|
+
# @overload get_instance(request, options = nil)
|
328
|
+
# Pass arguments to `get_instance` via a request object, either of type
|
329
|
+
# {::Google::Cloud::Memorystore::V1beta::GetInstanceRequest} or an equivalent Hash.
|
330
|
+
#
|
331
|
+
# @param request [::Google::Cloud::Memorystore::V1beta::GetInstanceRequest, ::Hash]
|
332
|
+
# A request object representing the call parameters. Required. To specify no
|
333
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
334
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
335
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
336
|
+
#
|
337
|
+
# @overload get_instance(name: nil)
|
338
|
+
# Pass arguments to `get_instance` via keyword arguments. Note that at
|
339
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
340
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
341
|
+
#
|
342
|
+
# @param name [::String]
|
343
|
+
# Required. The name of the instance to retrieve.
|
344
|
+
# Format: projects/\\{project}/locations/\\{location}/instances/\\{instance}
|
345
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
346
|
+
# @yieldparam result [::Google::Cloud::Memorystore::V1beta::Instance]
|
347
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
348
|
+
#
|
349
|
+
# @return [::Google::Cloud::Memorystore::V1beta::Instance]
|
350
|
+
#
|
351
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
352
|
+
#
|
353
|
+
# @example Basic example
|
354
|
+
# require "google/cloud/memorystore/v1beta"
|
355
|
+
#
|
356
|
+
# # Create a client object. The client can be reused for multiple calls.
|
357
|
+
# client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new
|
358
|
+
#
|
359
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
360
|
+
# request = Google::Cloud::Memorystore::V1beta::GetInstanceRequest.new
|
361
|
+
#
|
362
|
+
# # Call the get_instance method.
|
363
|
+
# result = client.get_instance request
|
364
|
+
#
|
365
|
+
# # The returned object is of type Google::Cloud::Memorystore::V1beta::Instance.
|
366
|
+
# p result
|
367
|
+
#
|
368
|
+
def get_instance request, options = nil
|
369
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
370
|
+
|
371
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Memorystore::V1beta::GetInstanceRequest
|
372
|
+
|
373
|
+
# Converts hash and nil to an options object
|
374
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
375
|
+
|
376
|
+
# Customize the options with defaults
|
377
|
+
call_metadata = @config.rpcs.get_instance.metadata.to_h
|
378
|
+
|
379
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
380
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
381
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
382
|
+
gapic_version: ::Google::Cloud::Memorystore::V1beta::VERSION,
|
383
|
+
transports_version_send: [:rest]
|
384
|
+
|
385
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
386
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
387
|
+
|
388
|
+
options.apply_defaults timeout: @config.rpcs.get_instance.timeout,
|
389
|
+
metadata: call_metadata,
|
390
|
+
retry_policy: @config.rpcs.get_instance.retry_policy
|
391
|
+
|
392
|
+
options.apply_defaults timeout: @config.timeout,
|
393
|
+
metadata: @config.metadata,
|
394
|
+
retry_policy: @config.retry_policy
|
395
|
+
|
396
|
+
@memorystore_stub.get_instance request, options do |result, operation|
|
397
|
+
yield result, operation if block_given?
|
398
|
+
end
|
399
|
+
rescue ::Gapic::Rest::Error => e
|
400
|
+
raise ::Google::Cloud::Error.from_error(e)
|
401
|
+
end
|
402
|
+
|
403
|
+
##
|
404
|
+
# Creates a new Instance in a given project and location.
|
405
|
+
#
|
406
|
+
# @overload create_instance(request, options = nil)
|
407
|
+
# Pass arguments to `create_instance` via a request object, either of type
|
408
|
+
# {::Google::Cloud::Memorystore::V1beta::CreateInstanceRequest} or an equivalent Hash.
|
409
|
+
#
|
410
|
+
# @param request [::Google::Cloud::Memorystore::V1beta::CreateInstanceRequest, ::Hash]
|
411
|
+
# A request object representing the call parameters. Required. To specify no
|
412
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
413
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
414
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
415
|
+
#
|
416
|
+
# @overload create_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil)
|
417
|
+
# Pass arguments to `create_instance` via keyword arguments. Note that at
|
418
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
419
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
420
|
+
#
|
421
|
+
# @param parent [::String]
|
422
|
+
# Required. The parent resource where this instance will be created.
|
423
|
+
# Format: projects/\\{project}/locations/\\{location}
|
424
|
+
# @param instance_id [::String]
|
425
|
+
# Required. The ID to use for the instance, which will become the final
|
426
|
+
# component of the instance's resource name.
|
427
|
+
#
|
428
|
+
# This value is subject to the following restrictions:
|
429
|
+
#
|
430
|
+
# * Must be 4-63 characters in length
|
431
|
+
# * Must begin with a letter or digit
|
432
|
+
# * Must contain only lowercase letters, digits, and hyphens
|
433
|
+
# * Must not end with a hyphen
|
434
|
+
# * Must be unique within a location
|
435
|
+
# @param instance [::Google::Cloud::Memorystore::V1beta::Instance, ::Hash]
|
436
|
+
# Required. The instance to create.
|
437
|
+
# @param request_id [::String]
|
438
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
439
|
+
# request ID so that if you must retry your request, the server will know to
|
440
|
+
# ignore the request if it has already been completed. The server will
|
441
|
+
# guarantee that for at least 60 minutes since the first request.
|
442
|
+
#
|
443
|
+
# For example, consider a situation where you make an initial request and the
|
444
|
+
# request times out. If you make the request again with the same request
|
445
|
+
# ID, the server can check if original operation with the same request ID
|
446
|
+
# was received, and if so, will ignore the second request. This prevents
|
447
|
+
# clients from accidentally creating duplicate commitments.
|
448
|
+
#
|
449
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
450
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
451
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
452
|
+
# @yieldparam result [::Gapic::Operation]
|
453
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
454
|
+
#
|
455
|
+
# @return [::Gapic::Operation]
|
456
|
+
#
|
457
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
458
|
+
#
|
459
|
+
# @example Basic example
|
460
|
+
# require "google/cloud/memorystore/v1beta"
|
461
|
+
#
|
462
|
+
# # Create a client object. The client can be reused for multiple calls.
|
463
|
+
# client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new
|
464
|
+
#
|
465
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
466
|
+
# request = Google::Cloud::Memorystore::V1beta::CreateInstanceRequest.new
|
467
|
+
#
|
468
|
+
# # Call the create_instance method.
|
469
|
+
# result = client.create_instance request
|
470
|
+
#
|
471
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
472
|
+
# # check the status of an operation, cancel it, or wait for results.
|
473
|
+
# # Here is how to wait for a response.
|
474
|
+
# result.wait_until_done! timeout: 60
|
475
|
+
# if result.response?
|
476
|
+
# p result.response
|
477
|
+
# else
|
478
|
+
# puts "No response received."
|
479
|
+
# end
|
480
|
+
#
|
481
|
+
def create_instance request, options = nil
|
482
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
483
|
+
|
484
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Memorystore::V1beta::CreateInstanceRequest
|
485
|
+
|
486
|
+
# Converts hash and nil to an options object
|
487
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
488
|
+
|
489
|
+
# Customize the options with defaults
|
490
|
+
call_metadata = @config.rpcs.create_instance.metadata.to_h
|
491
|
+
|
492
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
493
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
494
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
495
|
+
gapic_version: ::Google::Cloud::Memorystore::V1beta::VERSION,
|
496
|
+
transports_version_send: [:rest]
|
497
|
+
|
498
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
499
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
500
|
+
|
501
|
+
options.apply_defaults timeout: @config.rpcs.create_instance.timeout,
|
502
|
+
metadata: call_metadata,
|
503
|
+
retry_policy: @config.rpcs.create_instance.retry_policy
|
504
|
+
|
505
|
+
options.apply_defaults timeout: @config.timeout,
|
506
|
+
metadata: @config.metadata,
|
507
|
+
retry_policy: @config.retry_policy
|
508
|
+
|
509
|
+
@memorystore_stub.create_instance request, options do |result, operation|
|
510
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
511
|
+
yield result, operation if block_given?
|
512
|
+
throw :response, result
|
513
|
+
end
|
514
|
+
rescue ::Gapic::Rest::Error => e
|
515
|
+
raise ::Google::Cloud::Error.from_error(e)
|
516
|
+
end
|
517
|
+
|
518
|
+
##
|
519
|
+
# Updates the parameters of a single Instance.
|
520
|
+
#
|
521
|
+
# @overload update_instance(request, options = nil)
|
522
|
+
# Pass arguments to `update_instance` via a request object, either of type
|
523
|
+
# {::Google::Cloud::Memorystore::V1beta::UpdateInstanceRequest} or an equivalent Hash.
|
524
|
+
#
|
525
|
+
# @param request [::Google::Cloud::Memorystore::V1beta::UpdateInstanceRequest, ::Hash]
|
526
|
+
# A request object representing the call parameters. Required. To specify no
|
527
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
528
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
529
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
530
|
+
#
|
531
|
+
# @overload update_instance(update_mask: nil, instance: nil, request_id: nil)
|
532
|
+
# Pass arguments to `update_instance` via keyword arguments. Note that at
|
533
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
534
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
535
|
+
#
|
536
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
537
|
+
# Optional. The list of fields to be updated on the instance. At least one
|
538
|
+
# field must be specified.
|
539
|
+
# @param instance [::Google::Cloud::Memorystore::V1beta::Instance, ::Hash]
|
540
|
+
# Required. The instance to update.
|
541
|
+
# @param request_id [::String]
|
542
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
543
|
+
# request ID so that if you must retry your request, the server will know to
|
544
|
+
# ignore the request if it has already been completed. The server will
|
545
|
+
# guarantee that for at least 60 minutes since the first request.
|
546
|
+
#
|
547
|
+
# For example, consider a situation where you make an initial request and the
|
548
|
+
# request times out. If you make the request again with the same request
|
549
|
+
# ID, the server can check if original operation with the same request ID
|
550
|
+
# was received, and if so, will ignore the second request. This prevents
|
551
|
+
# clients from accidentally creating duplicate commitments.
|
552
|
+
#
|
553
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
554
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
555
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
556
|
+
# @yieldparam result [::Gapic::Operation]
|
557
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
558
|
+
#
|
559
|
+
# @return [::Gapic::Operation]
|
560
|
+
#
|
561
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
562
|
+
#
|
563
|
+
# @example Basic example
|
564
|
+
# require "google/cloud/memorystore/v1beta"
|
565
|
+
#
|
566
|
+
# # Create a client object. The client can be reused for multiple calls.
|
567
|
+
# client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new
|
568
|
+
#
|
569
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
570
|
+
# request = Google::Cloud::Memorystore::V1beta::UpdateInstanceRequest.new
|
571
|
+
#
|
572
|
+
# # Call the update_instance method.
|
573
|
+
# result = client.update_instance request
|
574
|
+
#
|
575
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
576
|
+
# # check the status of an operation, cancel it, or wait for results.
|
577
|
+
# # Here is how to wait for a response.
|
578
|
+
# result.wait_until_done! timeout: 60
|
579
|
+
# if result.response?
|
580
|
+
# p result.response
|
581
|
+
# else
|
582
|
+
# puts "No response received."
|
583
|
+
# end
|
584
|
+
#
|
585
|
+
def update_instance request, options = nil
|
586
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
587
|
+
|
588
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Memorystore::V1beta::UpdateInstanceRequest
|
589
|
+
|
590
|
+
# Converts hash and nil to an options object
|
591
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
592
|
+
|
593
|
+
# Customize the options with defaults
|
594
|
+
call_metadata = @config.rpcs.update_instance.metadata.to_h
|
595
|
+
|
596
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
597
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
598
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
599
|
+
gapic_version: ::Google::Cloud::Memorystore::V1beta::VERSION,
|
600
|
+
transports_version_send: [:rest]
|
601
|
+
|
602
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
603
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
604
|
+
|
605
|
+
options.apply_defaults timeout: @config.rpcs.update_instance.timeout,
|
606
|
+
metadata: call_metadata,
|
607
|
+
retry_policy: @config.rpcs.update_instance.retry_policy
|
608
|
+
|
609
|
+
options.apply_defaults timeout: @config.timeout,
|
610
|
+
metadata: @config.metadata,
|
611
|
+
retry_policy: @config.retry_policy
|
612
|
+
|
613
|
+
@memorystore_stub.update_instance request, options do |result, operation|
|
614
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
615
|
+
yield result, operation if block_given?
|
616
|
+
throw :response, result
|
617
|
+
end
|
618
|
+
rescue ::Gapic::Rest::Error => e
|
619
|
+
raise ::Google::Cloud::Error.from_error(e)
|
620
|
+
end
|
621
|
+
|
622
|
+
##
|
623
|
+
# Deletes a single Instance.
|
624
|
+
#
|
625
|
+
# @overload delete_instance(request, options = nil)
|
626
|
+
# Pass arguments to `delete_instance` via a request object, either of type
|
627
|
+
# {::Google::Cloud::Memorystore::V1beta::DeleteInstanceRequest} or an equivalent Hash.
|
628
|
+
#
|
629
|
+
# @param request [::Google::Cloud::Memorystore::V1beta::DeleteInstanceRequest, ::Hash]
|
630
|
+
# A request object representing the call parameters. Required. To specify no
|
631
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
632
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
633
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
634
|
+
#
|
635
|
+
# @overload delete_instance(name: nil, request_id: nil)
|
636
|
+
# Pass arguments to `delete_instance` via keyword arguments. Note that at
|
637
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
638
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
639
|
+
#
|
640
|
+
# @param name [::String]
|
641
|
+
# Required. The name of the instance to delete.
|
642
|
+
# Format: projects/\\{project}/locations/\\{location}/instances/\\{instance}
|
643
|
+
# @param request_id [::String]
|
644
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
645
|
+
# request ID so that if you must retry your request, the server will know to
|
646
|
+
# ignore the request if it has already been completed. The server will
|
647
|
+
# guarantee that for at least 60 minutes after the first request.
|
648
|
+
#
|
649
|
+
# For example, consider a situation where you make an initial request and the
|
650
|
+
# request times out. If you make the request again with the same request
|
651
|
+
# ID, the server can check if original operation with the same request ID
|
652
|
+
# was received, and if so, will ignore the second request. This prevents
|
653
|
+
# clients from accidentally creating duplicate commitments.
|
654
|
+
#
|
655
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
656
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
657
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
658
|
+
# @yieldparam result [::Gapic::Operation]
|
659
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
660
|
+
#
|
661
|
+
# @return [::Gapic::Operation]
|
662
|
+
#
|
663
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
664
|
+
#
|
665
|
+
# @example Basic example
|
666
|
+
# require "google/cloud/memorystore/v1beta"
|
667
|
+
#
|
668
|
+
# # Create a client object. The client can be reused for multiple calls.
|
669
|
+
# client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new
|
670
|
+
#
|
671
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
672
|
+
# request = Google::Cloud::Memorystore::V1beta::DeleteInstanceRequest.new
|
673
|
+
#
|
674
|
+
# # Call the delete_instance method.
|
675
|
+
# result = client.delete_instance request
|
676
|
+
#
|
677
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
678
|
+
# # check the status of an operation, cancel it, or wait for results.
|
679
|
+
# # Here is how to wait for a response.
|
680
|
+
# result.wait_until_done! timeout: 60
|
681
|
+
# if result.response?
|
682
|
+
# p result.response
|
683
|
+
# else
|
684
|
+
# puts "No response received."
|
685
|
+
# end
|
686
|
+
#
|
687
|
+
def delete_instance request, options = nil
|
688
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
689
|
+
|
690
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Memorystore::V1beta::DeleteInstanceRequest
|
691
|
+
|
692
|
+
# Converts hash and nil to an options object
|
693
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
694
|
+
|
695
|
+
# Customize the options with defaults
|
696
|
+
call_metadata = @config.rpcs.delete_instance.metadata.to_h
|
697
|
+
|
698
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
699
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
700
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
701
|
+
gapic_version: ::Google::Cloud::Memorystore::V1beta::VERSION,
|
702
|
+
transports_version_send: [:rest]
|
703
|
+
|
704
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
705
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
706
|
+
|
707
|
+
options.apply_defaults timeout: @config.rpcs.delete_instance.timeout,
|
708
|
+
metadata: call_metadata,
|
709
|
+
retry_policy: @config.rpcs.delete_instance.retry_policy
|
710
|
+
|
711
|
+
options.apply_defaults timeout: @config.timeout,
|
712
|
+
metadata: @config.metadata,
|
713
|
+
retry_policy: @config.retry_policy
|
714
|
+
|
715
|
+
@memorystore_stub.delete_instance request, options do |result, operation|
|
716
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
717
|
+
yield result, operation if block_given?
|
718
|
+
throw :response, result
|
719
|
+
end
|
720
|
+
rescue ::Gapic::Rest::Error => e
|
721
|
+
raise ::Google::Cloud::Error.from_error(e)
|
722
|
+
end
|
723
|
+
|
724
|
+
##
|
725
|
+
# Gets details about the certificate authority for an Instance.
|
726
|
+
#
|
727
|
+
# @overload get_certificate_authority(request, options = nil)
|
728
|
+
# Pass arguments to `get_certificate_authority` via a request object, either of type
|
729
|
+
# {::Google::Cloud::Memorystore::V1beta::GetCertificateAuthorityRequest} or an equivalent Hash.
|
730
|
+
#
|
731
|
+
# @param request [::Google::Cloud::Memorystore::V1beta::GetCertificateAuthorityRequest, ::Hash]
|
732
|
+
# A request object representing the call parameters. Required. To specify no
|
733
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
734
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
735
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
736
|
+
#
|
737
|
+
# @overload get_certificate_authority(name: nil)
|
738
|
+
# Pass arguments to `get_certificate_authority` via keyword arguments. Note that at
|
739
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
740
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
741
|
+
#
|
742
|
+
# @param name [::String]
|
743
|
+
# Required. The name of the certificate authority.
|
744
|
+
# Format:
|
745
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/certificateAuthority
|
746
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
747
|
+
# @yieldparam result [::Google::Cloud::Memorystore::V1beta::CertificateAuthority]
|
748
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
749
|
+
#
|
750
|
+
# @return [::Google::Cloud::Memorystore::V1beta::CertificateAuthority]
|
751
|
+
#
|
752
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
753
|
+
#
|
754
|
+
# @example Basic example
|
755
|
+
# require "google/cloud/memorystore/v1beta"
|
756
|
+
#
|
757
|
+
# # Create a client object. The client can be reused for multiple calls.
|
758
|
+
# client = Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new
|
759
|
+
#
|
760
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
761
|
+
# request = Google::Cloud::Memorystore::V1beta::GetCertificateAuthorityRequest.new
|
762
|
+
#
|
763
|
+
# # Call the get_certificate_authority method.
|
764
|
+
# result = client.get_certificate_authority request
|
765
|
+
#
|
766
|
+
# # The returned object is of type Google::Cloud::Memorystore::V1beta::CertificateAuthority.
|
767
|
+
# p result
|
768
|
+
#
|
769
|
+
def get_certificate_authority request, options = nil
|
770
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
771
|
+
|
772
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Memorystore::V1beta::GetCertificateAuthorityRequest
|
773
|
+
|
774
|
+
# Converts hash and nil to an options object
|
775
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
776
|
+
|
777
|
+
# Customize the options with defaults
|
778
|
+
call_metadata = @config.rpcs.get_certificate_authority.metadata.to_h
|
779
|
+
|
780
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
781
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
782
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
783
|
+
gapic_version: ::Google::Cloud::Memorystore::V1beta::VERSION,
|
784
|
+
transports_version_send: [:rest]
|
785
|
+
|
786
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
787
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
788
|
+
|
789
|
+
options.apply_defaults timeout: @config.rpcs.get_certificate_authority.timeout,
|
790
|
+
metadata: call_metadata,
|
791
|
+
retry_policy: @config.rpcs.get_certificate_authority.retry_policy
|
792
|
+
|
793
|
+
options.apply_defaults timeout: @config.timeout,
|
794
|
+
metadata: @config.metadata,
|
795
|
+
retry_policy: @config.retry_policy
|
796
|
+
|
797
|
+
@memorystore_stub.get_certificate_authority request, options do |result, operation|
|
798
|
+
yield result, operation if block_given?
|
799
|
+
end
|
800
|
+
rescue ::Gapic::Rest::Error => e
|
801
|
+
raise ::Google::Cloud::Error.from_error(e)
|
802
|
+
end
|
803
|
+
|
804
|
+
##
|
805
|
+
# Configuration class for the Memorystore REST API.
|
806
|
+
#
|
807
|
+
# This class represents the configuration for Memorystore REST,
|
808
|
+
# providing control over timeouts, retry behavior, logging, transport
|
809
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
810
|
+
# applied individually to specific RPCs. See
|
811
|
+
# {::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client::Configuration::Rpcs}
|
812
|
+
# for a list of RPCs that can be configured independently.
|
813
|
+
#
|
814
|
+
# Configuration can be applied globally to all clients, or to a single client
|
815
|
+
# on construction.
|
816
|
+
#
|
817
|
+
# @example
|
818
|
+
#
|
819
|
+
# # Modify the global config, setting the timeout for
|
820
|
+
# # list_instances to 20 seconds,
|
821
|
+
# # and all remaining timeouts to 10 seconds.
|
822
|
+
# ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.configure do |config|
|
823
|
+
# config.timeout = 10.0
|
824
|
+
# config.rpcs.list_instances.timeout = 20.0
|
825
|
+
# end
|
826
|
+
#
|
827
|
+
# # Apply the above configuration only to a new client.
|
828
|
+
# client = ::Google::Cloud::Memorystore::V1beta::Memorystore::Rest::Client.new do |config|
|
829
|
+
# config.timeout = 10.0
|
830
|
+
# config.rpcs.list_instances.timeout = 20.0
|
831
|
+
# end
|
832
|
+
#
|
833
|
+
# @!attribute [rw] endpoint
|
834
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
835
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
836
|
+
# @return [::String,nil]
|
837
|
+
# @!attribute [rw] credentials
|
838
|
+
# Credentials to send with calls. You may provide any of the following types:
|
839
|
+
# * (`String`) The path to a service account key file in JSON format
|
840
|
+
# * (`Hash`) A service account key as a Hash
|
841
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
842
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
843
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
844
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
845
|
+
# * (`nil`) indicating no credentials
|
846
|
+
# @return [::Object]
|
847
|
+
# @!attribute [rw] scope
|
848
|
+
# The OAuth scopes
|
849
|
+
# @return [::Array<::String>]
|
850
|
+
# @!attribute [rw] lib_name
|
851
|
+
# The library name as recorded in instrumentation and logging
|
852
|
+
# @return [::String]
|
853
|
+
# @!attribute [rw] lib_version
|
854
|
+
# The library version as recorded in instrumentation and logging
|
855
|
+
# @return [::String]
|
856
|
+
# @!attribute [rw] timeout
|
857
|
+
# The call timeout in seconds.
|
858
|
+
# @return [::Numeric]
|
859
|
+
# @!attribute [rw] metadata
|
860
|
+
# Additional headers to be sent with the call.
|
861
|
+
# @return [::Hash{::Symbol=>::String}]
|
862
|
+
# @!attribute [rw] retry_policy
|
863
|
+
# The retry policy. The value is a hash with the following keys:
|
864
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
865
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
866
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
867
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
868
|
+
# trigger a retry.
|
869
|
+
# @return [::Hash]
|
870
|
+
# @!attribute [rw] quota_project
|
871
|
+
# A separate project against which to charge quota.
|
872
|
+
# @return [::String]
|
873
|
+
# @!attribute [rw] universe_domain
|
874
|
+
# The universe domain within which to make requests. This determines the
|
875
|
+
# default endpoint URL. The default value of nil uses the environment
|
876
|
+
# universe (usually the default "googleapis.com" universe).
|
877
|
+
# @return [::String,nil]
|
878
|
+
# @!attribute [rw] logger
|
879
|
+
# A custom logger to use for request/response debug logging, or the value
|
880
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
881
|
+
# explicitly disable logging.
|
882
|
+
# @return [::Logger,:default,nil]
|
883
|
+
#
|
884
|
+
class Configuration
|
885
|
+
extend ::Gapic::Config
|
886
|
+
|
887
|
+
# @private
|
888
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
889
|
+
DEFAULT_ENDPOINT = "memorystore.googleapis.com"
|
890
|
+
|
891
|
+
config_attr :endpoint, nil, ::String, nil
|
892
|
+
config_attr :credentials, nil do |value|
|
893
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
894
|
+
allowed.any? { |klass| klass === value }
|
895
|
+
end
|
896
|
+
config_attr :scope, nil, ::String, ::Array, nil
|
897
|
+
config_attr :lib_name, nil, ::String, nil
|
898
|
+
config_attr :lib_version, nil, ::String, nil
|
899
|
+
config_attr :timeout, nil, ::Numeric, nil
|
900
|
+
config_attr :metadata, nil, ::Hash, nil
|
901
|
+
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
902
|
+
config_attr :quota_project, nil, ::String, nil
|
903
|
+
config_attr :universe_domain, nil, ::String, nil
|
904
|
+
|
905
|
+
# @private
|
906
|
+
# Overrides for http bindings for the RPCs of this service
|
907
|
+
# are only used when this service is used as mixin, and only
|
908
|
+
# by the host service.
|
909
|
+
# @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
|
910
|
+
config_attr :bindings_override, {}, ::Hash, nil
|
911
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
912
|
+
|
913
|
+
# @private
|
914
|
+
def initialize parent_config = nil
|
915
|
+
@parent_config = parent_config unless parent_config.nil?
|
916
|
+
|
917
|
+
yield self if block_given?
|
918
|
+
end
|
919
|
+
|
920
|
+
##
|
921
|
+
# Configurations for individual RPCs
|
922
|
+
# @return [Rpcs]
|
923
|
+
#
|
924
|
+
def rpcs
|
925
|
+
@rpcs ||= begin
|
926
|
+
parent_rpcs = nil
|
927
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
928
|
+
Rpcs.new parent_rpcs
|
929
|
+
end
|
930
|
+
end
|
931
|
+
|
932
|
+
##
|
933
|
+
# Configuration RPC class for the Memorystore API.
|
934
|
+
#
|
935
|
+
# Includes fields providing the configuration for each RPC in this service.
|
936
|
+
# Each configuration object is of type `Gapic::Config::Method` and includes
|
937
|
+
# the following configuration fields:
|
938
|
+
#
|
939
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
940
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
|
941
|
+
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
942
|
+
# include the following keys:
|
943
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
944
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
945
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
946
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
947
|
+
# trigger a retry.
|
948
|
+
#
|
949
|
+
class Rpcs
|
950
|
+
##
|
951
|
+
# RPC-specific configuration for `list_instances`
|
952
|
+
# @return [::Gapic::Config::Method]
|
953
|
+
#
|
954
|
+
attr_reader :list_instances
|
955
|
+
##
|
956
|
+
# RPC-specific configuration for `get_instance`
|
957
|
+
# @return [::Gapic::Config::Method]
|
958
|
+
#
|
959
|
+
attr_reader :get_instance
|
960
|
+
##
|
961
|
+
# RPC-specific configuration for `create_instance`
|
962
|
+
# @return [::Gapic::Config::Method]
|
963
|
+
#
|
964
|
+
attr_reader :create_instance
|
965
|
+
##
|
966
|
+
# RPC-specific configuration for `update_instance`
|
967
|
+
# @return [::Gapic::Config::Method]
|
968
|
+
#
|
969
|
+
attr_reader :update_instance
|
970
|
+
##
|
971
|
+
# RPC-specific configuration for `delete_instance`
|
972
|
+
# @return [::Gapic::Config::Method]
|
973
|
+
#
|
974
|
+
attr_reader :delete_instance
|
975
|
+
##
|
976
|
+
# RPC-specific configuration for `get_certificate_authority`
|
977
|
+
# @return [::Gapic::Config::Method]
|
978
|
+
#
|
979
|
+
attr_reader :get_certificate_authority
|
980
|
+
|
981
|
+
# @private
|
982
|
+
def initialize parent_rpcs = nil
|
983
|
+
list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
|
984
|
+
@list_instances = ::Gapic::Config::Method.new list_instances_config
|
985
|
+
get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
|
986
|
+
@get_instance = ::Gapic::Config::Method.new get_instance_config
|
987
|
+
create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
|
988
|
+
@create_instance = ::Gapic::Config::Method.new create_instance_config
|
989
|
+
update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
|
990
|
+
@update_instance = ::Gapic::Config::Method.new update_instance_config
|
991
|
+
delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
|
992
|
+
@delete_instance = ::Gapic::Config::Method.new delete_instance_config
|
993
|
+
get_certificate_authority_config = parent_rpcs.get_certificate_authority if parent_rpcs.respond_to? :get_certificate_authority
|
994
|
+
@get_certificate_authority = ::Gapic::Config::Method.new get_certificate_authority_config
|
995
|
+
|
996
|
+
yield self if block_given?
|
997
|
+
end
|
998
|
+
end
|
999
|
+
end
|
1000
|
+
end
|
1001
|
+
end
|
1002
|
+
end
|
1003
|
+
end
|
1004
|
+
end
|
1005
|
+
end
|
1006
|
+
end
|