google-cloud-chronicle-v1 0.4.0 → 0.6.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 (71) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +6 -6
  4. data/lib/google/cloud/chronicle/v1/big_query_export_pb.rb +34 -0
  5. data/lib/google/cloud/chronicle/v1/big_query_export_service/client.rb +682 -0
  6. data/lib/google/cloud/chronicle/v1/big_query_export_service/credentials.rb +49 -0
  7. data/lib/google/cloud/chronicle/v1/big_query_export_service/paths.rb +71 -0
  8. data/lib/google/cloud/chronicle/v1/big_query_export_service/rest/client.rb +618 -0
  9. data/lib/google/cloud/chronicle/v1/big_query_export_service/rest/service_stub.rb +266 -0
  10. data/lib/google/cloud/chronicle/v1/big_query_export_service/rest.rb +52 -0
  11. data/lib/google/cloud/chronicle/v1/big_query_export_service.rb +55 -0
  12. data/lib/google/cloud/chronicle/v1/big_query_export_services_pb.rb +51 -0
  13. data/lib/google/cloud/chronicle/v1/dashboard_chart_pb.rb +83 -0
  14. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/client.rb +584 -0
  15. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/credentials.rb +49 -0
  16. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/paths.rb +73 -0
  17. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/rest/client.rb +527 -0
  18. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/rest/service_stub.rb +203 -0
  19. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/rest.rb +52 -0
  20. data/lib/google/cloud/chronicle/v1/dashboard_chart_service.rb +55 -0
  21. data/lib/google/cloud/chronicle/v1/dashboard_chart_services_pb.rb +47 -0
  22. data/lib/google/cloud/chronicle/v1/dashboard_query_pb.rb +58 -0
  23. data/lib/google/cloud/chronicle/v1/dashboard_query_service/client.rb +589 -0
  24. data/lib/google/cloud/chronicle/v1/dashboard_query_service/credentials.rb +49 -0
  25. data/lib/google/cloud/chronicle/v1/dashboard_query_service/paths.rb +94 -0
  26. data/lib/google/cloud/chronicle/v1/dashboard_query_service/rest/client.rb +532 -0
  27. data/lib/google/cloud/chronicle/v1/dashboard_query_service/rest/service_stub.rb +204 -0
  28. data/lib/google/cloud/chronicle/v1/dashboard_query_service/rest.rb +52 -0
  29. data/lib/google/cloud/chronicle/v1/dashboard_query_service.rb +55 -0
  30. data/lib/google/cloud/chronicle/v1/dashboard_query_services_pb.rb +47 -0
  31. data/lib/google/cloud/chronicle/v1/data_table_pb.rb +57 -0
  32. data/lib/google/cloud/chronicle/v1/data_table_service/client.rb +1915 -0
  33. data/lib/google/cloud/chronicle/v1/data_table_service/credentials.rb +49 -0
  34. data/lib/google/cloud/chronicle/v1/data_table_service/paths.rb +138 -0
  35. data/lib/google/cloud/chronicle/v1/data_table_service/rest/client.rb +1767 -0
  36. data/lib/google/cloud/chronicle/v1/data_table_service/rest/service_stub.rb +1004 -0
  37. data/lib/google/cloud/chronicle/v1/data_table_service/rest.rb +52 -0
  38. data/lib/google/cloud/chronicle/v1/data_table_service.rb +55 -0
  39. data/lib/google/cloud/chronicle/v1/data_table_services_pb.rb +73 -0
  40. data/lib/google/cloud/chronicle/v1/featured_content_metadata_pb.rb +25 -0
  41. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_pb.rb +33 -0
  42. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/client.rb +717 -0
  43. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/credentials.rb +49 -0
  44. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/paths.rb +136 -0
  45. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/rest/client.rb +653 -0
  46. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/rest/service_stub.rb +265 -0
  47. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/rest.rb +53 -0
  48. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service.rb +56 -0
  49. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_services_pb.rb +50 -0
  50. data/lib/google/cloud/chronicle/v1/native_dashboard_pb.rb +61 -0
  51. data/lib/google/cloud/chronicle/v1/native_dashboard_service/client.rb +1611 -0
  52. data/lib/google/cloud/chronicle/v1/native_dashboard_service/credentials.rb +49 -0
  53. data/lib/google/cloud/chronicle/v1/native_dashboard_service/paths.rb +115 -0
  54. data/lib/google/cloud/chronicle/v1/native_dashboard_service/rest/client.rb +1484 -0
  55. data/lib/google/cloud/chronicle/v1/native_dashboard_service/rest/service_stub.rb +822 -0
  56. data/lib/google/cloud/chronicle/v1/native_dashboard_service/rest.rb +52 -0
  57. data/lib/google/cloud/chronicle/v1/native_dashboard_service.rb +55 -0
  58. data/lib/google/cloud/chronicle/v1/native_dashboard_services_pb.rb +67 -0
  59. data/lib/google/cloud/chronicle/v1/rest.rb +7 -1
  60. data/lib/google/cloud/chronicle/v1/version.rb +1 -1
  61. data/lib/google/cloud/chronicle/v1.rb +8 -2
  62. data/proto_docs/google/api/client.rb +149 -29
  63. data/proto_docs/google/cloud/chronicle/v1/big_query_export.rb +142 -0
  64. data/proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb +923 -0
  65. data/proto_docs/google/cloud/chronicle/v1/dashboard_query.rb +653 -0
  66. data/proto_docs/google/cloud/chronicle/v1/data_table.rb +512 -0
  67. data/proto_docs/google/cloud/chronicle/v1/featured_content_metadata.rb +82 -0
  68. data/proto_docs/google/cloud/chronicle/v1/featured_content_native_dashboard.rb +141 -0
  69. data/proto_docs/google/cloud/chronicle/v1/native_dashboard.rb +502 -0
  70. data/proto_docs/google/type/date.rb +56 -0
  71. metadata +71 -9
@@ -0,0 +1,682 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 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/big_query_export_pb"
21
+
22
+ module Google
23
+ module Cloud
24
+ module Chronicle
25
+ module V1
26
+ module BigQueryExportService
27
+ ##
28
+ # Client for the BigQueryExportService service.
29
+ #
30
+ # Service for managing BigQuery export configurations for Chronicle instances.
31
+ #
32
+ class Client
33
+ # @private
34
+ API_VERSION = ""
35
+
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "chronicle.$UNIVERSE_DOMAIN$"
38
+
39
+ include Paths
40
+
41
+ # @private
42
+ attr_reader :big_query_export_service_stub
43
+
44
+ ##
45
+ # Configure the BigQueryExportService Client class.
46
+ #
47
+ # See {::Google::Cloud::Chronicle::V1::BigQueryExportService::Client::Configuration}
48
+ # for a description of the configuration fields.
49
+ #
50
+ # @example
51
+ #
52
+ # # Modify the configuration for all BigQueryExportService clients
53
+ # ::Google::Cloud::Chronicle::V1::BigQueryExportService::Client.configure do |config|
54
+ # config.timeout = 10.0
55
+ # end
56
+ #
57
+ # @yield [config] Configure the Client client.
58
+ # @yieldparam config [Client::Configuration]
59
+ #
60
+ # @return [Client::Configuration]
61
+ #
62
+ def self.configure
63
+ @configure ||= begin
64
+ namespace = ["Google", "Cloud", "Chronicle", "V1"]
65
+ parent_config = while namespace.any?
66
+ parent_name = namespace.join "::"
67
+ parent_const = const_get parent_name
68
+ break parent_const.configure if parent_const.respond_to? :configure
69
+ namespace.pop
70
+ end
71
+ default_config = Client::Configuration.new parent_config
72
+
73
+ default_config.rpcs.get_big_query_export.timeout = 120.0
74
+ default_config.rpcs.get_big_query_export.retry_policy = {
75
+ initial_delay: 1.0, max_delay: 120.0, multiplier: 1.3, retry_codes: [14]
76
+ }
77
+
78
+ default_config.rpcs.update_big_query_export.timeout = 120.0
79
+ default_config.rpcs.update_big_query_export.retry_policy = {
80
+ initial_delay: 1.0, max_delay: 120.0, multiplier: 1.3, retry_codes: [14]
81
+ }
82
+
83
+ default_config.rpcs.provision_big_query_export.timeout = 120.0
84
+ default_config.rpcs.provision_big_query_export.retry_policy = {
85
+ initial_delay: 1.0, max_delay: 120.0, multiplier: 1.3, retry_codes: [14]
86
+ }
87
+
88
+ default_config
89
+ end
90
+ yield @configure if block_given?
91
+ @configure
92
+ end
93
+
94
+ ##
95
+ # Configure the BigQueryExportService Client instance.
96
+ #
97
+ # The configuration is set to the derived mode, meaning that values can be changed,
98
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
99
+ # should be made on {Client.configure}.
100
+ #
101
+ # See {::Google::Cloud::Chronicle::V1::BigQueryExportService::Client::Configuration}
102
+ # for a description of the configuration fields.
103
+ #
104
+ # @yield [config] Configure the Client client.
105
+ # @yieldparam config [Client::Configuration]
106
+ #
107
+ # @return [Client::Configuration]
108
+ #
109
+ def configure
110
+ yield @config if block_given?
111
+ @config
112
+ end
113
+
114
+ ##
115
+ # The effective universe domain
116
+ #
117
+ # @return [String]
118
+ #
119
+ def universe_domain
120
+ @big_query_export_service_stub.universe_domain
121
+ end
122
+
123
+ ##
124
+ # Create a new BigQueryExportService client object.
125
+ #
126
+ # @example
127
+ #
128
+ # # Create a client using the default configuration
129
+ # client = ::Google::Cloud::Chronicle::V1::BigQueryExportService::Client.new
130
+ #
131
+ # # Create a client using a custom configuration
132
+ # client = ::Google::Cloud::Chronicle::V1::BigQueryExportService::Client.new do |config|
133
+ # config.timeout = 10.0
134
+ # end
135
+ #
136
+ # @yield [config] Configure the BigQueryExportService client.
137
+ # @yieldparam config [Client::Configuration]
138
+ #
139
+ def initialize
140
+ # These require statements are intentionally placed here to initialize
141
+ # the gRPC module only when it's required.
142
+ # See https://github.com/googleapis/toolkit/issues/446
143
+ require "gapic/grpc"
144
+ require "google/cloud/chronicle/v1/big_query_export_services_pb"
145
+
146
+ # Create the configuration object
147
+ @config = Configuration.new Client.configure
148
+
149
+ # Yield the configuration if needed
150
+ yield @config if block_given?
151
+
152
+ # Create credentials
153
+ credentials = @config.credentials
154
+ # Use self-signed JWT if the endpoint is unchanged from default,
155
+ # but only if the default endpoint does not have a region prefix.
156
+ enable_self_signed_jwt = @config.endpoint.nil? ||
157
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
158
+ !@config.endpoint.split(".").first.include?("-"))
159
+ credentials ||= Credentials.default scope: @config.scope,
160
+ enable_self_signed_jwt: enable_self_signed_jwt
161
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
162
+ credentials = Credentials.new credentials, scope: @config.scope
163
+ end
164
+ @quota_project_id = @config.quota_project
165
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
166
+
167
+ @big_query_export_service_stub = ::Gapic::ServiceStub.new(
168
+ ::Google::Cloud::Chronicle::V1::BigQueryExportService::Stub,
169
+ credentials: credentials,
170
+ endpoint: @config.endpoint,
171
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
172
+ universe_domain: @config.universe_domain,
173
+ channel_args: @config.channel_args,
174
+ interceptors: @config.interceptors,
175
+ channel_pool_config: @config.channel_pool,
176
+ logger: @config.logger
177
+ )
178
+
179
+ @big_query_export_service_stub.stub_logger&.info do |entry|
180
+ entry.set_system_name
181
+ entry.set_service
182
+ entry.message = "Created client for #{entry.service}"
183
+ entry.set_credentials_fields credentials
184
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
185
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
186
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
187
+ end
188
+ end
189
+
190
+ ##
191
+ # The logger used for request/response debug logging.
192
+ #
193
+ # @return [Logger]
194
+ #
195
+ def logger
196
+ @big_query_export_service_stub.logger
197
+ end
198
+
199
+ # Service calls
200
+
201
+ ##
202
+ # Get the BigQuery export configuration for a Chronicle instance.
203
+ #
204
+ # @overload get_big_query_export(request, options = nil)
205
+ # Pass arguments to `get_big_query_export` via a request object, either of type
206
+ # {::Google::Cloud::Chronicle::V1::GetBigQueryExportRequest} or an equivalent Hash.
207
+ #
208
+ # @param request [::Google::Cloud::Chronicle::V1::GetBigQueryExportRequest, ::Hash]
209
+ # A request object representing the call parameters. Required. To specify no
210
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
211
+ # @param options [::Gapic::CallOptions, ::Hash]
212
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
213
+ #
214
+ # @overload get_big_query_export(name: nil)
215
+ # Pass arguments to `get_big_query_export` via keyword arguments. Note that at
216
+ # least one keyword argument is required. To specify no parameters, or to keep all
217
+ # the default parameter values, pass an empty Hash as a request object (see above).
218
+ #
219
+ # @param name [::String]
220
+ # Required. The resource name of the BigqueryExport to retrieve.
221
+ # Format:
222
+ # projects/\\{project}/locations/\\{location}/instances/\\{instance}/bigQueryExport
223
+ #
224
+ # @yield [response, operation] Access the result along with the RPC operation
225
+ # @yieldparam response [::Google::Cloud::Chronicle::V1::BigQueryExport]
226
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
227
+ #
228
+ # @return [::Google::Cloud::Chronicle::V1::BigQueryExport]
229
+ #
230
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
231
+ #
232
+ # @example Basic example
233
+ # require "google/cloud/chronicle/v1"
234
+ #
235
+ # # Create a client object. The client can be reused for multiple calls.
236
+ # client = Google::Cloud::Chronicle::V1::BigQueryExportService::Client.new
237
+ #
238
+ # # Create a request. To set request fields, pass in keyword arguments.
239
+ # request = Google::Cloud::Chronicle::V1::GetBigQueryExportRequest.new
240
+ #
241
+ # # Call the get_big_query_export method.
242
+ # result = client.get_big_query_export request
243
+ #
244
+ # # The returned object is of type Google::Cloud::Chronicle::V1::BigQueryExport.
245
+ # p result
246
+ #
247
+ def get_big_query_export request, options = nil
248
+ raise ::ArgumentError, "request must be provided" if request.nil?
249
+
250
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::GetBigQueryExportRequest
251
+
252
+ # Converts hash and nil to an options object
253
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
254
+
255
+ # Customize the options with defaults
256
+ metadata = @config.rpcs.get_big_query_export.metadata.to_h
257
+
258
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
259
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
260
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
261
+ gapic_version: ::Google::Cloud::Chronicle::V1::VERSION
262
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
263
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
264
+
265
+ header_params = {}
266
+ if request.name
267
+ header_params["name"] = request.name
268
+ end
269
+
270
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
271
+ metadata[:"x-goog-request-params"] ||= request_params_header
272
+
273
+ options.apply_defaults timeout: @config.rpcs.get_big_query_export.timeout,
274
+ metadata: metadata,
275
+ retry_policy: @config.rpcs.get_big_query_export.retry_policy
276
+
277
+ options.apply_defaults timeout: @config.timeout,
278
+ metadata: @config.metadata,
279
+ retry_policy: @config.retry_policy
280
+
281
+ @big_query_export_service_stub.call_rpc :get_big_query_export, request, options: options do |response, operation|
282
+ yield response, operation if block_given?
283
+ end
284
+ rescue ::GRPC::BadStatus => e
285
+ raise ::Google::Cloud::Error.from_error(e)
286
+ end
287
+
288
+ ##
289
+ # Update the BigQuery export configuration for a Chronicle instance.
290
+ #
291
+ # @overload update_big_query_export(request, options = nil)
292
+ # Pass arguments to `update_big_query_export` via a request object, either of type
293
+ # {::Google::Cloud::Chronicle::V1::UpdateBigQueryExportRequest} or an equivalent Hash.
294
+ #
295
+ # @param request [::Google::Cloud::Chronicle::V1::UpdateBigQueryExportRequest, ::Hash]
296
+ # A request object representing the call parameters. Required. To specify no
297
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
298
+ # @param options [::Gapic::CallOptions, ::Hash]
299
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
300
+ #
301
+ # @overload update_big_query_export(big_query_export: nil, update_mask: nil)
302
+ # Pass arguments to `update_big_query_export` via keyword arguments. Note that at
303
+ # least one keyword argument is required. To specify no parameters, or to keep all
304
+ # the default parameter values, pass an empty Hash as a request object (see above).
305
+ #
306
+ # @param big_query_export [::Google::Cloud::Chronicle::V1::BigQueryExport, ::Hash]
307
+ # Required. The BigQueryExport settings to update.
308
+ # Format:
309
+ # projects/\\{project}/locations/\\{location}/instances/\\{instance}/bigQueryExport
310
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
311
+ # Optional. The list of fields to update.
312
+ #
313
+ # @yield [response, operation] Access the result along with the RPC operation
314
+ # @yieldparam response [::Google::Cloud::Chronicle::V1::BigQueryExport]
315
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
316
+ #
317
+ # @return [::Google::Cloud::Chronicle::V1::BigQueryExport]
318
+ #
319
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
320
+ #
321
+ # @example Basic example
322
+ # require "google/cloud/chronicle/v1"
323
+ #
324
+ # # Create a client object. The client can be reused for multiple calls.
325
+ # client = Google::Cloud::Chronicle::V1::BigQueryExportService::Client.new
326
+ #
327
+ # # Create a request. To set request fields, pass in keyword arguments.
328
+ # request = Google::Cloud::Chronicle::V1::UpdateBigQueryExportRequest.new
329
+ #
330
+ # # Call the update_big_query_export method.
331
+ # result = client.update_big_query_export request
332
+ #
333
+ # # The returned object is of type Google::Cloud::Chronicle::V1::BigQueryExport.
334
+ # p result
335
+ #
336
+ def update_big_query_export request, options = nil
337
+ raise ::ArgumentError, "request must be provided" if request.nil?
338
+
339
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::UpdateBigQueryExportRequest
340
+
341
+ # Converts hash and nil to an options object
342
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
343
+
344
+ # Customize the options with defaults
345
+ metadata = @config.rpcs.update_big_query_export.metadata.to_h
346
+
347
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
348
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
349
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
350
+ gapic_version: ::Google::Cloud::Chronicle::V1::VERSION
351
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
352
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
353
+
354
+ header_params = {}
355
+ if request.big_query_export&.name
356
+ header_params["big_query_export.name"] = request.big_query_export.name
357
+ end
358
+
359
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
360
+ metadata[:"x-goog-request-params"] ||= request_params_header
361
+
362
+ options.apply_defaults timeout: @config.rpcs.update_big_query_export.timeout,
363
+ metadata: metadata,
364
+ retry_policy: @config.rpcs.update_big_query_export.retry_policy
365
+
366
+ options.apply_defaults timeout: @config.timeout,
367
+ metadata: @config.metadata,
368
+ retry_policy: @config.retry_policy
369
+
370
+ @big_query_export_service_stub.call_rpc :update_big_query_export, request, options: options do |response, operation|
371
+ yield response, operation if block_given?
372
+ end
373
+ rescue ::GRPC::BadStatus => e
374
+ raise ::Google::Cloud::Error.from_error(e)
375
+ end
376
+
377
+ ##
378
+ # Provision the BigQuery export for a Chronicle instance. This will create
379
+ # \\{\\{gcp_name}} resources like \\{\\{storage_name}} buckets, BigQuery datasets
380
+ # and set default export settings for each data source.
381
+ #
382
+ # @overload provision_big_query_export(request, options = nil)
383
+ # Pass arguments to `provision_big_query_export` via a request object, either of type
384
+ # {::Google::Cloud::Chronicle::V1::ProvisionBigQueryExportRequest} or an equivalent Hash.
385
+ #
386
+ # @param request [::Google::Cloud::Chronicle::V1::ProvisionBigQueryExportRequest, ::Hash]
387
+ # A request object representing the call parameters. Required. To specify no
388
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
389
+ # @param options [::Gapic::CallOptions, ::Hash]
390
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
391
+ #
392
+ # @overload provision_big_query_export(parent: nil)
393
+ # Pass arguments to `provision_big_query_export` via keyword arguments. Note that at
394
+ # least one keyword argument is required. To specify no parameters, or to keep all
395
+ # the default parameter values, pass an empty Hash as a request object (see above).
396
+ #
397
+ # @param parent [::String]
398
+ # Required. The instance for which BigQuery export is being provisioned.
399
+ # Format: projects/\\{project}/locations/\\{location}/instances/\\{instance}
400
+ #
401
+ # @yield [response, operation] Access the result along with the RPC operation
402
+ # @yieldparam response [::Google::Cloud::Chronicle::V1::BigQueryExport]
403
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
404
+ #
405
+ # @return [::Google::Cloud::Chronicle::V1::BigQueryExport]
406
+ #
407
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
408
+ #
409
+ # @example Basic example
410
+ # require "google/cloud/chronicle/v1"
411
+ #
412
+ # # Create a client object. The client can be reused for multiple calls.
413
+ # client = Google::Cloud::Chronicle::V1::BigQueryExportService::Client.new
414
+ #
415
+ # # Create a request. To set request fields, pass in keyword arguments.
416
+ # request = Google::Cloud::Chronicle::V1::ProvisionBigQueryExportRequest.new
417
+ #
418
+ # # Call the provision_big_query_export method.
419
+ # result = client.provision_big_query_export request
420
+ #
421
+ # # The returned object is of type Google::Cloud::Chronicle::V1::BigQueryExport.
422
+ # p result
423
+ #
424
+ def provision_big_query_export request, options = nil
425
+ raise ::ArgumentError, "request must be provided" if request.nil?
426
+
427
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::ProvisionBigQueryExportRequest
428
+
429
+ # Converts hash and nil to an options object
430
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
431
+
432
+ # Customize the options with defaults
433
+ metadata = @config.rpcs.provision_big_query_export.metadata.to_h
434
+
435
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
436
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
437
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
438
+ gapic_version: ::Google::Cloud::Chronicle::V1::VERSION
439
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
440
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
441
+
442
+ header_params = {}
443
+ if request.parent
444
+ header_params["parent"] = request.parent
445
+ end
446
+
447
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
448
+ metadata[:"x-goog-request-params"] ||= request_params_header
449
+
450
+ options.apply_defaults timeout: @config.rpcs.provision_big_query_export.timeout,
451
+ metadata: metadata,
452
+ retry_policy: @config.rpcs.provision_big_query_export.retry_policy
453
+
454
+ options.apply_defaults timeout: @config.timeout,
455
+ metadata: @config.metadata,
456
+ retry_policy: @config.retry_policy
457
+
458
+ @big_query_export_service_stub.call_rpc :provision_big_query_export, request, options: options do |response, operation|
459
+ yield response, operation if block_given?
460
+ end
461
+ rescue ::GRPC::BadStatus => e
462
+ raise ::Google::Cloud::Error.from_error(e)
463
+ end
464
+
465
+ ##
466
+ # Configuration class for the BigQueryExportService API.
467
+ #
468
+ # This class represents the configuration for BigQueryExportService,
469
+ # providing control over timeouts, retry behavior, logging, transport
470
+ # parameters, and other low-level controls. Certain parameters can also be
471
+ # applied individually to specific RPCs. See
472
+ # {::Google::Cloud::Chronicle::V1::BigQueryExportService::Client::Configuration::Rpcs}
473
+ # for a list of RPCs that can be configured independently.
474
+ #
475
+ # Configuration can be applied globally to all clients, or to a single client
476
+ # on construction.
477
+ #
478
+ # @example
479
+ #
480
+ # # Modify the global config, setting the timeout for
481
+ # # get_big_query_export to 20 seconds,
482
+ # # and all remaining timeouts to 10 seconds.
483
+ # ::Google::Cloud::Chronicle::V1::BigQueryExportService::Client.configure do |config|
484
+ # config.timeout = 10.0
485
+ # config.rpcs.get_big_query_export.timeout = 20.0
486
+ # end
487
+ #
488
+ # # Apply the above configuration only to a new client.
489
+ # client = ::Google::Cloud::Chronicle::V1::BigQueryExportService::Client.new do |config|
490
+ # config.timeout = 10.0
491
+ # config.rpcs.get_big_query_export.timeout = 20.0
492
+ # end
493
+ #
494
+ # @!attribute [rw] endpoint
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
498
+ # @!attribute [rw] credentials
499
+ # Credentials to send with calls. You may provide any of the following types:
500
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
501
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
502
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
503
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
504
+ # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
505
+ # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
506
+ # * (`nil`) indicating no credentials
507
+ #
508
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
509
+ # is deprecated. Providing an unvalidated credential configuration to
510
+ # Google APIs can compromise the security of your systems and data.
511
+ #
512
+ # @example
513
+ #
514
+ # # The recommended way to provide credentials is to use the `make_creds` method
515
+ # # on the appropriate credentials class for your environment.
516
+ #
517
+ # require "googleauth"
518
+ #
519
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
520
+ # json_key_io: ::File.open("/path/to/keyfile.json")
521
+ # )
522
+ #
523
+ # client = ::Google::Cloud::Chronicle::V1::BigQueryExportService::Client.new do |config|
524
+ # config.credentials = credentials
525
+ # end
526
+ #
527
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
528
+ # external source for authentication to Google Cloud, you must validate it before
529
+ # providing it to a Google API client library. Providing an unvalidated credential
530
+ # configuration to Google APIs can compromise the security of your systems and data.
531
+ # For more information, refer to [Validate credential configurations from external
532
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
533
+ # @return [::Object]
534
+ # @!attribute [rw] scope
535
+ # The OAuth scopes
536
+ # @return [::Array<::String>]
537
+ # @!attribute [rw] lib_name
538
+ # The library name as recorded in instrumentation and logging
539
+ # @return [::String]
540
+ # @!attribute [rw] lib_version
541
+ # The library version as recorded in instrumentation and logging
542
+ # @return [::String]
543
+ # @!attribute [rw] channel_args
544
+ # Extra parameters passed to the gRPC channel. Note: this is ignored if a
545
+ # `GRPC::Core::Channel` object is provided as the credential.
546
+ # @return [::Hash]
547
+ # @!attribute [rw] interceptors
548
+ # An array of interceptors that are run before calls are executed.
549
+ # @return [::Array<::GRPC::ClientInterceptor>]
550
+ # @!attribute [rw] timeout
551
+ # The call timeout in seconds.
552
+ # @return [::Numeric]
553
+ # @!attribute [rw] metadata
554
+ # Additional gRPC headers to be sent with the call.
555
+ # @return [::Hash{::Symbol=>::String}]
556
+ # @!attribute [rw] retry_policy
557
+ # The retry policy. The value is a hash with the following keys:
558
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
559
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
560
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
561
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
562
+ # trigger a retry.
563
+ # @return [::Hash]
564
+ # @!attribute [rw] quota_project
565
+ # A separate project against which to charge quota.
566
+ # @return [::String]
567
+ # @!attribute [rw] universe_domain
568
+ # The universe domain within which to make requests. This determines the
569
+ # default endpoint URL. The default value of nil uses the environment
570
+ # universe (usually the default "googleapis.com" universe).
571
+ # @return [::String,nil]
572
+ # @!attribute [rw] logger
573
+ # A custom logger to use for request/response debug logging, or the value
574
+ # `:default` (the default) to construct a default logger, or `nil` to
575
+ # explicitly disable logging.
576
+ # @return [::Logger,:default,nil]
577
+ #
578
+ class Configuration
579
+ extend ::Gapic::Config
580
+
581
+ # @private
582
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
583
+ DEFAULT_ENDPOINT = "chronicle.googleapis.com"
584
+
585
+ config_attr :endpoint, nil, ::String, nil
586
+ config_attr :credentials, nil do |value|
587
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
588
+ allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
589
+ allowed.any? { |klass| klass === value }
590
+ end
591
+ config_attr :scope, nil, ::String, ::Array, nil
592
+ config_attr :lib_name, nil, ::String, nil
593
+ config_attr :lib_version, nil, ::String, nil
594
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
595
+ config_attr :interceptors, nil, ::Array, nil
596
+ config_attr :timeout, nil, ::Numeric, nil
597
+ config_attr :metadata, nil, ::Hash, nil
598
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
599
+ config_attr :quota_project, nil, ::String, nil
600
+ config_attr :universe_domain, nil, ::String, nil
601
+ config_attr :logger, :default, ::Logger, nil, :default
602
+
603
+ # @private
604
+ def initialize parent_config = nil
605
+ @parent_config = parent_config unless parent_config.nil?
606
+
607
+ yield self if block_given?
608
+ end
609
+
610
+ ##
611
+ # Configurations for individual RPCs
612
+ # @return [Rpcs]
613
+ #
614
+ def rpcs
615
+ @rpcs ||= begin
616
+ parent_rpcs = nil
617
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
618
+ Rpcs.new parent_rpcs
619
+ end
620
+ end
621
+
622
+ ##
623
+ # Configuration for the channel pool
624
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
625
+ #
626
+ def channel_pool
627
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
628
+ end
629
+
630
+ ##
631
+ # Configuration RPC class for the BigQueryExportService API.
632
+ #
633
+ # Includes fields providing the configuration for each RPC in this service.
634
+ # Each configuration object is of type `Gapic::Config::Method` and includes
635
+ # the following configuration fields:
636
+ #
637
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
638
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
639
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
640
+ # include the following keys:
641
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
642
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
643
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
644
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
645
+ # trigger a retry.
646
+ #
647
+ class Rpcs
648
+ ##
649
+ # RPC-specific configuration for `get_big_query_export`
650
+ # @return [::Gapic::Config::Method]
651
+ #
652
+ attr_reader :get_big_query_export
653
+ ##
654
+ # RPC-specific configuration for `update_big_query_export`
655
+ # @return [::Gapic::Config::Method]
656
+ #
657
+ attr_reader :update_big_query_export
658
+ ##
659
+ # RPC-specific configuration for `provision_big_query_export`
660
+ # @return [::Gapic::Config::Method]
661
+ #
662
+ attr_reader :provision_big_query_export
663
+
664
+ # @private
665
+ def initialize parent_rpcs = nil
666
+ get_big_query_export_config = parent_rpcs.get_big_query_export if parent_rpcs.respond_to? :get_big_query_export
667
+ @get_big_query_export = ::Gapic::Config::Method.new get_big_query_export_config
668
+ update_big_query_export_config = parent_rpcs.update_big_query_export if parent_rpcs.respond_to? :update_big_query_export
669
+ @update_big_query_export = ::Gapic::Config::Method.new update_big_query_export_config
670
+ provision_big_query_export_config = parent_rpcs.provision_big_query_export if parent_rpcs.respond_to? :provision_big_query_export
671
+ @provision_big_query_export = ::Gapic::Config::Method.new provision_big_query_export_config
672
+
673
+ yield self if block_given?
674
+ end
675
+ end
676
+ end
677
+ end
678
+ end
679
+ end
680
+ end
681
+ end
682
+ end