google-cloud-chronicle-v1 0.a → 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.
Files changed (74) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +154 -8
  5. data/lib/google/cloud/chronicle/v1/data_access_control_pb.rb +67 -0
  6. data/lib/google/cloud/chronicle/v1/data_access_control_service/client.rb +1414 -0
  7. data/lib/google/cloud/chronicle/v1/data_access_control_service/credentials.rb +47 -0
  8. data/lib/google/cloud/chronicle/v1/data_access_control_service/paths.rb +94 -0
  9. data/lib/google/cloud/chronicle/v1/data_access_control_service/rest/client.rb +1318 -0
  10. data/lib/google/cloud/chronicle/v1/data_access_control_service/rest/service_stub.rb +695 -0
  11. data/lib/google/cloud/chronicle/v1/data_access_control_service/rest.rb +53 -0
  12. data/lib/google/cloud/chronicle/v1/data_access_control_service.rb +56 -0
  13. data/lib/google/cloud/chronicle/v1/data_access_control_services_pb.rb +76 -0
  14. data/lib/google/cloud/chronicle/v1/entity_pb.rb +62 -0
  15. data/lib/google/cloud/chronicle/v1/entity_service/client.rb +891 -0
  16. data/lib/google/cloud/chronicle/v1/entity_service/credentials.rb +47 -0
  17. data/lib/google/cloud/chronicle/v1/entity_service/paths.rb +73 -0
  18. data/lib/google/cloud/chronicle/v1/entity_service/rest/client.rb +830 -0
  19. data/lib/google/cloud/chronicle/v1/entity_service/rest/service_stub.rb +388 -0
  20. data/lib/google/cloud/chronicle/v1/entity_service/rest.rb +52 -0
  21. data/lib/google/cloud/chronicle/v1/entity_service.rb +55 -0
  22. data/lib/google/cloud/chronicle/v1/entity_services_pb.rb +54 -0
  23. data/lib/google/cloud/chronicle/v1/instance_pb.rb +48 -0
  24. data/lib/google/cloud/chronicle/v1/instance_service/client.rb +464 -0
  25. data/lib/google/cloud/chronicle/v1/instance_service/credentials.rb +47 -0
  26. data/lib/google/cloud/chronicle/v1/instance_service/paths.rb +52 -0
  27. data/lib/google/cloud/chronicle/v1/instance_service/rest/client.rb +431 -0
  28. data/lib/google/cloud/chronicle/v1/instance_service/rest/service_stub.rb +142 -0
  29. data/lib/google/cloud/chronicle/v1/instance_service/rest.rb +52 -0
  30. data/lib/google/cloud/chronicle/v1/instance_service.rb +55 -0
  31. data/lib/google/cloud/chronicle/v1/instance_services_pb.rb +45 -0
  32. data/lib/google/cloud/chronicle/v1/reference_list_pb.rb +61 -0
  33. data/lib/google/cloud/chronicle/v1/reference_list_service/client.rb +792 -0
  34. data/lib/google/cloud/chronicle/v1/reference_list_service/credentials.rb +47 -0
  35. data/lib/google/cloud/chronicle/v1/reference_list_service/paths.rb +73 -0
  36. data/lib/google/cloud/chronicle/v1/reference_list_service/rest/client.rb +738 -0
  37. data/lib/google/cloud/chronicle/v1/reference_list_service/rest/service_stub.rb +327 -0
  38. data/lib/google/cloud/chronicle/v1/reference_list_service/rest.rb +52 -0
  39. data/lib/google/cloud/chronicle/v1/reference_list_service.rb +55 -0
  40. data/lib/google/cloud/chronicle/v1/reference_list_services_pb.rb +51 -0
  41. data/lib/google/cloud/chronicle/v1/rest.rb +41 -0
  42. data/lib/google/cloud/chronicle/v1/rule_pb.rb +85 -0
  43. data/lib/google/cloud/chronicle/v1/rule_service/client.rb +1674 -0
  44. data/lib/google/cloud/chronicle/v1/rule_service/credentials.rb +47 -0
  45. data/lib/google/cloud/chronicle/v1/rule_service/operations.rb +813 -0
  46. data/lib/google/cloud/chronicle/v1/rule_service/paths.rb +159 -0
  47. data/lib/google/cloud/chronicle/v1/rule_service/rest/client.rb +1564 -0
  48. data/lib/google/cloud/chronicle/v1/rule_service/rest/operations.rb +914 -0
  49. data/lib/google/cloud/chronicle/v1/rule_service/rest/service_stub.rb +817 -0
  50. data/lib/google/cloud/chronicle/v1/rule_service/rest.rb +53 -0
  51. data/lib/google/cloud/chronicle/v1/rule_service.rb +56 -0
  52. data/lib/google/cloud/chronicle/v1/rule_services_pb.rb +70 -0
  53. data/lib/google/cloud/chronicle/v1/version.rb +7 -2
  54. data/lib/google/cloud/chronicle/v1.rb +49 -0
  55. data/lib/google-cloud-chronicle-v1.rb +21 -0
  56. data/proto_docs/README.md +4 -0
  57. data/proto_docs/google/api/client.rb +473 -0
  58. data/proto_docs/google/api/field_behavior.rb +85 -0
  59. data/proto_docs/google/api/launch_stage.rb +71 -0
  60. data/proto_docs/google/api/resource.rb +227 -0
  61. data/proto_docs/google/cloud/chronicle/v1/data_access_control.rb +364 -0
  62. data/proto_docs/google/cloud/chronicle/v1/entity.rb +210 -0
  63. data/proto_docs/google/cloud/chronicle/v1/instance.rb +47 -0
  64. data/proto_docs/google/cloud/chronicle/v1/reference_list.rb +232 -0
  65. data/proto_docs/google/cloud/chronicle/v1/rule.rb +701 -0
  66. data/proto_docs/google/longrunning/operations.rb +173 -0
  67. data/proto_docs/google/protobuf/any.rb +145 -0
  68. data/proto_docs/google/protobuf/duration.rb +98 -0
  69. data/proto_docs/google/protobuf/empty.rb +34 -0
  70. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  71. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  72. data/proto_docs/google/rpc/status.rb +48 -0
  73. data/proto_docs/google/type/interval.rb +45 -0
  74. metadata +110 -10
@@ -0,0 +1,431 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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/chronicle/v1/instance_pb"
21
+ require "google/cloud/chronicle/v1/instance_service/rest/service_stub"
22
+
23
+ module Google
24
+ module Cloud
25
+ module Chronicle
26
+ module V1
27
+ module InstanceService
28
+ module Rest
29
+ ##
30
+ # REST client for the InstanceService service.
31
+ #
32
+ # InstanceService provides the entry interface for the Chronicle API.
33
+ #
34
+ class Client
35
+ # @private
36
+ API_VERSION = ""
37
+
38
+ # @private
39
+ DEFAULT_ENDPOINT_TEMPLATE = "chronicle.$UNIVERSE_DOMAIN$"
40
+
41
+ include Paths
42
+
43
+ # @private
44
+ attr_reader :instance_service_stub
45
+
46
+ ##
47
+ # Configure the InstanceService Client class.
48
+ #
49
+ # See {::Google::Cloud::Chronicle::V1::InstanceService::Rest::Client::Configuration}
50
+ # for a description of the configuration fields.
51
+ #
52
+ # @example
53
+ #
54
+ # # Modify the configuration for all InstanceService clients
55
+ # ::Google::Cloud::Chronicle::V1::InstanceService::Rest::Client.configure do |config|
56
+ # config.timeout = 10.0
57
+ # end
58
+ #
59
+ # @yield [config] Configure the Client client.
60
+ # @yieldparam config [Client::Configuration]
61
+ #
62
+ # @return [Client::Configuration]
63
+ #
64
+ def self.configure
65
+ @configure ||= begin
66
+ namespace = ["Google", "Cloud", "Chronicle", "V1"]
67
+ parent_config = while namespace.any?
68
+ parent_name = namespace.join "::"
69
+ parent_const = const_get parent_name
70
+ break parent_const.configure if parent_const.respond_to? :configure
71
+ namespace.pop
72
+ end
73
+ default_config = Client::Configuration.new parent_config
74
+
75
+ default_config.rpcs.get_instance.timeout = 60.0
76
+ default_config.rpcs.get_instance.retry_policy = {
77
+ initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
78
+ }
79
+
80
+ default_config
81
+ end
82
+ yield @configure if block_given?
83
+ @configure
84
+ end
85
+
86
+ ##
87
+ # Configure the InstanceService Client instance.
88
+ #
89
+ # The configuration is set to the derived mode, meaning that values can be changed,
90
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
91
+ # should be made on {Client.configure}.
92
+ #
93
+ # See {::Google::Cloud::Chronicle::V1::InstanceService::Rest::Client::Configuration}
94
+ # for a description of the configuration fields.
95
+ #
96
+ # @yield [config] Configure the Client client.
97
+ # @yieldparam config [Client::Configuration]
98
+ #
99
+ # @return [Client::Configuration]
100
+ #
101
+ def configure
102
+ yield @config if block_given?
103
+ @config
104
+ end
105
+
106
+ ##
107
+ # The effective universe domain
108
+ #
109
+ # @return [String]
110
+ #
111
+ def universe_domain
112
+ @instance_service_stub.universe_domain
113
+ end
114
+
115
+ ##
116
+ # Create a new InstanceService REST client object.
117
+ #
118
+ # @example
119
+ #
120
+ # # Create a client using the default configuration
121
+ # client = ::Google::Cloud::Chronicle::V1::InstanceService::Rest::Client.new
122
+ #
123
+ # # Create a client using a custom configuration
124
+ # client = ::Google::Cloud::Chronicle::V1::InstanceService::Rest::Client.new do |config|
125
+ # config.timeout = 10.0
126
+ # end
127
+ #
128
+ # @yield [config] Configure the InstanceService client.
129
+ # @yieldparam config [Client::Configuration]
130
+ #
131
+ def initialize
132
+ # Create the configuration object
133
+ @config = Configuration.new Client.configure
134
+
135
+ # Yield the configuration if needed
136
+ yield @config if block_given?
137
+
138
+ # Create credentials
139
+ credentials = @config.credentials
140
+ # Use self-signed JWT if the endpoint is unchanged from default,
141
+ # but only if the default endpoint does not have a region prefix.
142
+ enable_self_signed_jwt = @config.endpoint.nil? ||
143
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
144
+ !@config.endpoint.split(".").first.include?("-"))
145
+ credentials ||= Credentials.default scope: @config.scope,
146
+ enable_self_signed_jwt: enable_self_signed_jwt
147
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
148
+ credentials = Credentials.new credentials, scope: @config.scope
149
+ end
150
+
151
+ @quota_project_id = @config.quota_project
152
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
153
+
154
+ @instance_service_stub = ::Google::Cloud::Chronicle::V1::InstanceService::Rest::ServiceStub.new(
155
+ endpoint: @config.endpoint,
156
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
157
+ universe_domain: @config.universe_domain,
158
+ credentials: credentials,
159
+ logger: @config.logger
160
+ )
161
+
162
+ @instance_service_stub.logger(stub: true)&.info do |entry|
163
+ entry.set_system_name
164
+ entry.set_service
165
+ entry.message = "Created client for #{entry.service}"
166
+ entry.set_credentials_fields credentials
167
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
168
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
169
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
170
+ end
171
+ end
172
+
173
+ ##
174
+ # The logger used for request/response debug logging.
175
+ #
176
+ # @return [Logger]
177
+ #
178
+ def logger
179
+ @instance_service_stub.logger
180
+ end
181
+
182
+ # Service calls
183
+
184
+ ##
185
+ # Gets a Instance.
186
+ #
187
+ # @overload get_instance(request, options = nil)
188
+ # Pass arguments to `get_instance` via a request object, either of type
189
+ # {::Google::Cloud::Chronicle::V1::GetInstanceRequest} or an equivalent Hash.
190
+ #
191
+ # @param request [::Google::Cloud::Chronicle::V1::GetInstanceRequest, ::Hash]
192
+ # A request object representing the call parameters. Required. To specify no
193
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
194
+ # @param options [::Gapic::CallOptions, ::Hash]
195
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
196
+ #
197
+ # @overload get_instance(name: nil)
198
+ # Pass arguments to `get_instance` via keyword arguments. Note that at
199
+ # least one keyword argument is required. To specify no parameters, or to keep all
200
+ # the default parameter values, pass an empty Hash as a request object (see above).
201
+ #
202
+ # @param name [::String]
203
+ # Required. The name of the instance to retrieve.
204
+ # Format:
205
+ # `projects/{project_id}/locations/{location}/instances/{instance}`
206
+ # @yield [result, operation] Access the result along with the TransportOperation object
207
+ # @yieldparam result [::Google::Cloud::Chronicle::V1::Instance]
208
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
209
+ #
210
+ # @return [::Google::Cloud::Chronicle::V1::Instance]
211
+ #
212
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
213
+ #
214
+ # @example Basic example
215
+ # require "google/cloud/chronicle/v1"
216
+ #
217
+ # # Create a client object. The client can be reused for multiple calls.
218
+ # client = Google::Cloud::Chronicle::V1::InstanceService::Rest::Client.new
219
+ #
220
+ # # Create a request. To set request fields, pass in keyword arguments.
221
+ # request = Google::Cloud::Chronicle::V1::GetInstanceRequest.new
222
+ #
223
+ # # Call the get_instance method.
224
+ # result = client.get_instance request
225
+ #
226
+ # # The returned object is of type Google::Cloud::Chronicle::V1::Instance.
227
+ # p result
228
+ #
229
+ def get_instance request, options = nil
230
+ raise ::ArgumentError, "request must be provided" if request.nil?
231
+
232
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::GetInstanceRequest
233
+
234
+ # Converts hash and nil to an options object
235
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
236
+
237
+ # Customize the options with defaults
238
+ call_metadata = @config.rpcs.get_instance.metadata.to_h
239
+
240
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
241
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
242
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
243
+ gapic_version: ::Google::Cloud::Chronicle::V1::VERSION,
244
+ transports_version_send: [:rest]
245
+
246
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
247
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
248
+
249
+ options.apply_defaults timeout: @config.rpcs.get_instance.timeout,
250
+ metadata: call_metadata,
251
+ retry_policy: @config.rpcs.get_instance.retry_policy
252
+
253
+ options.apply_defaults timeout: @config.timeout,
254
+ metadata: @config.metadata,
255
+ retry_policy: @config.retry_policy
256
+
257
+ @instance_service_stub.get_instance request, options do |result, operation|
258
+ yield result, operation if block_given?
259
+ end
260
+ rescue ::Gapic::Rest::Error => e
261
+ raise ::Google::Cloud::Error.from_error(e)
262
+ end
263
+
264
+ ##
265
+ # Configuration class for the InstanceService REST API.
266
+ #
267
+ # This class represents the configuration for InstanceService REST,
268
+ # providing control over timeouts, retry behavior, logging, transport
269
+ # parameters, and other low-level controls. Certain parameters can also be
270
+ # applied individually to specific RPCs. See
271
+ # {::Google::Cloud::Chronicle::V1::InstanceService::Rest::Client::Configuration::Rpcs}
272
+ # for a list of RPCs that can be configured independently.
273
+ #
274
+ # Configuration can be applied globally to all clients, or to a single client
275
+ # on construction.
276
+ #
277
+ # @example
278
+ #
279
+ # # Modify the global config, setting the timeout for
280
+ # # get_instance to 20 seconds,
281
+ # # and all remaining timeouts to 10 seconds.
282
+ # ::Google::Cloud::Chronicle::V1::InstanceService::Rest::Client.configure do |config|
283
+ # config.timeout = 10.0
284
+ # config.rpcs.get_instance.timeout = 20.0
285
+ # end
286
+ #
287
+ # # Apply the above configuration only to a new client.
288
+ # client = ::Google::Cloud::Chronicle::V1::InstanceService::Rest::Client.new do |config|
289
+ # config.timeout = 10.0
290
+ # config.rpcs.get_instance.timeout = 20.0
291
+ # end
292
+ #
293
+ # @!attribute [rw] endpoint
294
+ # A custom service endpoint, as a hostname or hostname:port. The default is
295
+ # nil, indicating to use the default endpoint in the current universe domain.
296
+ # @return [::String,nil]
297
+ # @!attribute [rw] credentials
298
+ # Credentials to send with calls. You may provide any of the following types:
299
+ # * (`String`) The path to a service account key file in JSON format
300
+ # * (`Hash`) A service account key as a Hash
301
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
302
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
303
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
304
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
305
+ # * (`nil`) indicating no credentials
306
+ #
307
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
308
+ # external source for authentication to Google Cloud, you must validate it before
309
+ # providing it to a Google API client library. Providing an unvalidated credential
310
+ # configuration to Google APIs can compromise the security of your systems and data.
311
+ # For more information, refer to [Validate credential configurations from external
312
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
313
+ # @return [::Object]
314
+ # @!attribute [rw] scope
315
+ # The OAuth scopes
316
+ # @return [::Array<::String>]
317
+ # @!attribute [rw] lib_name
318
+ # The library name as recorded in instrumentation and logging
319
+ # @return [::String]
320
+ # @!attribute [rw] lib_version
321
+ # The library version as recorded in instrumentation and logging
322
+ # @return [::String]
323
+ # @!attribute [rw] timeout
324
+ # The call timeout in seconds.
325
+ # @return [::Numeric]
326
+ # @!attribute [rw] metadata
327
+ # Additional headers to be sent with the call.
328
+ # @return [::Hash{::Symbol=>::String}]
329
+ # @!attribute [rw] retry_policy
330
+ # The retry policy. The value is a hash with the following keys:
331
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
332
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
333
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
334
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
335
+ # trigger a retry.
336
+ # @return [::Hash]
337
+ # @!attribute [rw] quota_project
338
+ # A separate project against which to charge quota.
339
+ # @return [::String]
340
+ # @!attribute [rw] universe_domain
341
+ # The universe domain within which to make requests. This determines the
342
+ # default endpoint URL. The default value of nil uses the environment
343
+ # universe (usually the default "googleapis.com" universe).
344
+ # @return [::String,nil]
345
+ # @!attribute [rw] logger
346
+ # A custom logger to use for request/response debug logging, or the value
347
+ # `:default` (the default) to construct a default logger, or `nil` to
348
+ # explicitly disable logging.
349
+ # @return [::Logger,:default,nil]
350
+ #
351
+ class Configuration
352
+ extend ::Gapic::Config
353
+
354
+ # @private
355
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
356
+ DEFAULT_ENDPOINT = "chronicle.googleapis.com"
357
+
358
+ config_attr :endpoint, nil, ::String, nil
359
+ config_attr :credentials, nil do |value|
360
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
361
+ allowed.any? { |klass| klass === value }
362
+ end
363
+ config_attr :scope, nil, ::String, ::Array, nil
364
+ config_attr :lib_name, nil, ::String, nil
365
+ config_attr :lib_version, nil, ::String, nil
366
+ config_attr :timeout, nil, ::Numeric, nil
367
+ config_attr :metadata, nil, ::Hash, nil
368
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
369
+ config_attr :quota_project, nil, ::String, nil
370
+ config_attr :universe_domain, nil, ::String, nil
371
+ config_attr :logger, :default, ::Logger, nil, :default
372
+
373
+ # @private
374
+ def initialize parent_config = nil
375
+ @parent_config = parent_config unless parent_config.nil?
376
+
377
+ yield self if block_given?
378
+ end
379
+
380
+ ##
381
+ # Configurations for individual RPCs
382
+ # @return [Rpcs]
383
+ #
384
+ def rpcs
385
+ @rpcs ||= begin
386
+ parent_rpcs = nil
387
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
388
+ Rpcs.new parent_rpcs
389
+ end
390
+ end
391
+
392
+ ##
393
+ # Configuration RPC class for the InstanceService API.
394
+ #
395
+ # Includes fields providing the configuration for each RPC in this service.
396
+ # Each configuration object is of type `Gapic::Config::Method` and includes
397
+ # the following configuration fields:
398
+ #
399
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
400
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
401
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
402
+ # include the following keys:
403
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
404
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
405
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
406
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
407
+ # trigger a retry.
408
+ #
409
+ class Rpcs
410
+ ##
411
+ # RPC-specific configuration for `get_instance`
412
+ # @return [::Gapic::Config::Method]
413
+ #
414
+ attr_reader :get_instance
415
+
416
+ # @private
417
+ def initialize parent_rpcs = nil
418
+ get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
419
+ @get_instance = ::Gapic::Config::Method.new get_instance_config
420
+
421
+ yield self if block_given?
422
+ end
423
+ end
424
+ end
425
+ end
426
+ end
427
+ end
428
+ end
429
+ end
430
+ end
431
+ end
@@ -0,0 +1,142 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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/chronicle/v1/instance_pb"
20
+
21
+ module Google
22
+ module Cloud
23
+ module Chronicle
24
+ module V1
25
+ module InstanceService
26
+ module Rest
27
+ ##
28
+ # REST service stub for the InstanceService service.
29
+ # Service stub contains baseline method implementations
30
+ # including transcoding, making the REST call, and deserialing the response.
31
+ #
32
+ class ServiceStub
33
+ # @private
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
35
+ # These require statements are intentionally placed here to initialize
36
+ # the REST modules only when it's required.
37
+ require "gapic/rest"
38
+
39
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
40
+ endpoint_template: endpoint_template,
41
+ universe_domain: universe_domain,
42
+ credentials: credentials,
43
+ numeric_enums: true,
44
+ service_name: self.class,
45
+ raise_faraday_errors: false,
46
+ logger: logger
47
+ end
48
+
49
+ ##
50
+ # The effective universe domain
51
+ #
52
+ # @return [String]
53
+ #
54
+ def universe_domain
55
+ @client_stub.universe_domain
56
+ end
57
+
58
+ ##
59
+ # The effective endpoint
60
+ #
61
+ # @return [String]
62
+ #
63
+ def endpoint
64
+ @client_stub.endpoint
65
+ end
66
+
67
+ ##
68
+ # The logger used for request/response debug logging.
69
+ #
70
+ # @return [Logger]
71
+ #
72
+ def logger stub: false
73
+ stub ? @client_stub.stub_logger : @client_stub.logger
74
+ end
75
+
76
+ ##
77
+ # Baseline implementation for the get_instance REST call
78
+ #
79
+ # @param request_pb [::Google::Cloud::Chronicle::V1::GetInstanceRequest]
80
+ # A request object representing the call parameters. Required.
81
+ # @param options [::Gapic::CallOptions]
82
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
83
+ #
84
+ # @yield [result, operation] Access the result along with the TransportOperation object
85
+ # @yieldparam result [::Google::Cloud::Chronicle::V1::Instance]
86
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
87
+ #
88
+ # @return [::Google::Cloud::Chronicle::V1::Instance]
89
+ # A result object deserialized from the server's reply
90
+ def get_instance request_pb, options = nil
91
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
92
+
93
+ verb, uri, query_string_params, body = ServiceStub.transcode_get_instance_request request_pb
94
+ query_string_params = if query_string_params.any?
95
+ query_string_params.to_h { |p| p.split "=", 2 }
96
+ else
97
+ {}
98
+ end
99
+
100
+ response = @client_stub.make_http_request(
101
+ verb,
102
+ uri: uri,
103
+ body: body || "",
104
+ params: query_string_params,
105
+ method_name: "get_instance",
106
+ options: options
107
+ )
108
+ operation = ::Gapic::Rest::TransportOperation.new response
109
+ result = ::Google::Cloud::Chronicle::V1::Instance.decode_json response.body, ignore_unknown_fields: true
110
+ catch :response do
111
+ yield result, operation if block_given?
112
+ result
113
+ end
114
+ end
115
+
116
+ ##
117
+ # @private
118
+ #
119
+ # GRPC transcoding helper method for the get_instance REST call
120
+ #
121
+ # @param request_pb [::Google::Cloud::Chronicle::V1::GetInstanceRequest]
122
+ # A request object representing the call parameters. Required.
123
+ # @return [Array(String, [String, nil], Hash{String => String})]
124
+ # Uri, Body, Query string parameters
125
+ def self.transcode_get_instance_request request_pb
126
+ transcoder = Gapic::Rest::GrpcTranscoder.new
127
+ .with_bindings(
128
+ uri_method: :get,
129
+ uri_template: "/v1/{name}",
130
+ matches: [
131
+ ["name", %r{^projects/[^/]+/locations/[^/]+/instances/[^/]+/?$}, false]
132
+ ]
133
+ )
134
+ transcoder.transcode request_pb
135
+ end
136
+ end
137
+ end
138
+ end
139
+ end
140
+ end
141
+ end
142
+ end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 "gapic/rest"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/chronicle/v1/version"
24
+
25
+ require "google/cloud/chronicle/v1/instance_service/credentials"
26
+ require "google/cloud/chronicle/v1/instance_service/paths"
27
+ require "google/cloud/chronicle/v1/instance_service/rest/client"
28
+
29
+ module Google
30
+ module Cloud
31
+ module Chronicle
32
+ module V1
33
+ ##
34
+ # InstanceService provides the entry interface for the Chronicle API.
35
+ #
36
+ # To load this service and instantiate a REST client:
37
+ #
38
+ # require "google/cloud/chronicle/v1/instance_service/rest"
39
+ # client = ::Google::Cloud::Chronicle::V1::InstanceService::Rest::Client.new
40
+ #
41
+ module InstanceService
42
+ # Client for the REST transport
43
+ module Rest
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
50
+
51
+ helper_path = ::File.join __dir__, "rest", "helpers.rb"
52
+ require "google/cloud/chronicle/v1/instance_service/rest/helpers" if ::File.file? helper_path
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/chronicle/v1/version"
24
+
25
+ require "google/cloud/chronicle/v1/instance_service/credentials"
26
+ require "google/cloud/chronicle/v1/instance_service/paths"
27
+ require "google/cloud/chronicle/v1/instance_service/client"
28
+ require "google/cloud/chronicle/v1/instance_service/rest"
29
+
30
+ module Google
31
+ module Cloud
32
+ module Chronicle
33
+ module V1
34
+ ##
35
+ # InstanceService provides the entry interface for the Chronicle API.
36
+ #
37
+ # @example Load this service and instantiate a gRPC client
38
+ #
39
+ # require "google/cloud/chronicle/v1/instance_service"
40
+ # client = ::Google::Cloud::Chronicle::V1::InstanceService::Client.new
41
+ #
42
+ # @example Load this service and instantiate a REST client
43
+ #
44
+ # require "google/cloud/chronicle/v1/instance_service/rest"
45
+ # client = ::Google::Cloud::Chronicle::V1::InstanceService::Rest::Client.new
46
+ #
47
+ module InstanceService
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
53
+
54
+ helper_path = ::File.join __dir__, "instance_service", "helpers.rb"
55
+ require "google/cloud/chronicle/v1/instance_service/helpers" if ::File.file? helper_path