Class: Google::Cloud::Logging::V2::ConfigServiceV2Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/logging/v2/config_service_v2_client.rb

Overview

Service for configuring sinks used to export log entries outside of Stackdriver Logging.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"logging.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/cloud-platform.read-only",
  "https://www.googleapis.com/auth/logging.admin",
  "https://www.googleapis.com/auth/logging.read",
  "https://www.googleapis.com/auth/logging.write"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ ConfigServiceV2Client

Returns a new instance of ConfigServiceV2Client

Parameters:

  • service_path (String) —

    The domain name of the API remote host.

  • port (Integer) —

    The port on which to connect to the remote host.

  • channel (Channel) —

    A Channel object through which to make calls.

  • chan_creds (Grpc::ChannelCredentials) —

    A ChannelCredentials for the setting up the RPC client.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 138

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    app_name: nil,
    app_version: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/logging/v2/logging_config_services_pb"


  if app_name || app_version
    warn "`app_name` and `app_version` are no longer being used in the request headers."
  end

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  client_config_file = Pathname.new(__dir__).join(
    "config_service_v2_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.logging.v2.ConfigServiceV2",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end
  @config_service_v2_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    scopes: scopes,
    &Google::Logging::V2::ConfigServiceV2::Stub.method(:new)
  )

  @list_sinks = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:list_sinks),
    defaults["list_sinks"]
  )
  @get_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:get_sink),
    defaults["get_sink"]
  )
  @create_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:create_sink),
    defaults["create_sink"]
  )
  @update_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:update_sink),
    defaults["update_sink"]
  )
  @delete_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:delete_sink),
    defaults["delete_sink"]
  )
end

Instance Attribute Details

#config_service_v2_stub ⇒ Google::Logging::V2::ConfigServiceV2::Stub (readonly)

Returns:

  • (Google::Logging::V2::ConfigServiceV2::Stub) 


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 40

class ConfigServiceV2Client
  attr_reader :config_service_v2_stub

  # The default address of the service.
  SERVICE_ADDRESS = "logging.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_sinks" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "sinks")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/cloud-platform.read-only",
    "https://www.googleapis.com/auth/logging.admin",
    "https://www.googleapis.com/auth/logging.read",
    "https://www.googleapis.com/auth/logging.write"
  ].freeze

  PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}"
  )

  private_constant :PROJECT_PATH_TEMPLATE

  SINK_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/sinks/{sink}"
  )

  private_constant :SINK_PATH_TEMPLATE

  # Returns a fully-qualified project resource name string.
  # @param project [String]
  # @return [String]
  def self.project_path project
    PROJECT_PATH_TEMPLATE.render(
      :"project" => project
    )
  end

  # Returns a fully-qualified sink resource name string.
  # @param project [String]
  # @param sink [String]
  # @return [String]
  def self.sink_path project, sink
    SINK_PATH_TEMPLATE.render(
      :"project" => project,
      :"sink" => sink
    )
  end

  # Parses the project from a project resource.
  # @param project_name [String]
  # @return [String]
  def self.match_project_from_project_name project_name
    PROJECT_PATH_TEMPLATE.match(project_name)["project"]
  end

  # Parses the project from a sink resource.
  # @param sink_name [String]
  # @return [String]
  def self.match_project_from_sink_name sink_name
    SINK_PATH_TEMPLATE.match(sink_name)["project"]
  end

  # Parses the sink from a sink resource.
  # @param sink_name [String]
  # @return [String]
  def self.match_sink_from_sink_name sink_name
    SINK_PATH_TEMPLATE.match(sink_name)["sink"]
  end

  # @param service_path [String]
  #   The domain name of the API remote host.
  # @param port [Integer]
  #   The port on which to connect to the remote host.
  # @param channel [Channel]
  #   A Channel object through which to make calls.
  # @param chan_creds [Grpc::ChannelCredentials]
  #   A ChannelCredentials for the setting up the RPC client.
  # @param client_config[Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      app_name: nil,
      app_version: nil,
      lib_name: nil,
      lib_version: ""
    # These require statements are intentionally placed here to initialize
    # the gRPC module only when it's required.
    # See https://github.com/googleapis/toolkit/issues/446
    require "google/gax/grpc"
    require "google/logging/v2/logging_config_services_pb"


    if app_name || app_version
      warn "`app_name` and `app_version` are no longer being used in the request headers."
    end

    google_api_client = "gl-ruby/#{RUBY_VERSION}"
    google_api_client << " #{lib_name}/#{lib_version}" if lib_name
    google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
    google_api_client << " grpc/#{GRPC::VERSION}"
    google_api_client.freeze

    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "config_service_v2_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.logging.v2.ConfigServiceV2",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @config_service_v2_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      scopes: scopes,
      &Google::Logging::V2::ConfigServiceV2::Stub.method(:new)
    )

    @list_sinks = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:list_sinks),
      defaults["list_sinks"]
    )
    @get_sink = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:get_sink),
      defaults["get_sink"]
    )
    @create_sink = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:create_sink),
      defaults["create_sink"]
    )
    @update_sink = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:update_sink),
      defaults["update_sink"]
    )
    @delete_sink = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:delete_sink),
      defaults["delete_sink"]
    )
  end

  # Service calls

  # Lists sinks.
  #
  # @param parent [String]
  #   Required. The parent resource whose sinks are to be listed.
  #   Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>]
  #   An enumerable of Google::Logging::V2::LogSink instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2/config_service_v2_client"
  #
  #   ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
  #
  #   config_service_v2_client = ConfigServiceV2Client.new
  #   formatted_parent = ConfigServiceV2Client.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   config_service_v2_client.list_sinks(formatted_parent).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   config_service_v2_client.list_sinks(formatted_parent).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_sinks \
      parent,
      page_size: nil,
      options: nil
    req = Google::Logging::V2::ListSinksRequest.new({
      parent: parent,
      page_size: page_size
    }.delete_if { |_, v| v.nil? })
    @list_sinks.call(req, options)
  end

  # Gets a sink.
  #
  # @param sink_name [String]
  #   Required. The parent resource name of the sink:
  #
  #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
  #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
  #
  #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogSink]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2/config_service_v2_client"
  #
  #   ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
  #
  #   config_service_v2_client = ConfigServiceV2Client.new
  #   formatted_sink_name = ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
  #   response = config_service_v2_client.get_sink(formatted_sink_name)

  def get_sink \
      sink_name,
      options: nil
    req = Google::Logging::V2::GetSinkRequest.new({
      sink_name: sink_name
    }.delete_if { |_, v| v.nil? })
    @get_sink.call(req, options)
  end

  # Creates a sink that exports specified log entries to a destination.  The
  # export of newly-ingested log entries begins immediately, unless the current
  # time is outside the sink's start and end times or the sink's
  # +writer_identity+ is not permitted to write to the destination.  A sink can
  # export log entries only from the resource owning the sink.
  #
  # @param parent [String]
  #   Required. The resource in which to create the sink:
  #
  #       "projects/[PROJECT_ID]"
  #       "organizations/[ORGANIZATION_ID]"
  #
  #   Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
  # @param sink [Google::Logging::V2::LogSink]
  #   Required. The new sink, whose +name+ parameter is a sink identifier that
  #   is not already in use.
  # @param unique_writer_identity [true, false]
  #   Optional. Determines the kind of IAM identity returned as +writer_identity+
  #   in the new sink.  If this value is omitted or set to false, and if the
  #   sink's parent is a project, then the value returned as +writer_identity+ is
  #   +cloud-logs@google.com+, the same identity used before the addition of
  #   writer identities to this API. The sink's destination must be in the same
  #   project as the sink itself.
  #
  #   If this field is set to true, or if the sink is owned by a non-project
  #   resource such as an organization, then the value of +writer_identity+ will
  #   be a unique service account used only for exports from the new sink.  For
  #   more information, see +writer_identity+ in LogSink.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogSink]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2/config_service_v2_client"
  #
  #   ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
  #   LogSink = Google::Logging::V2::LogSink
  #
  #   config_service_v2_client = ConfigServiceV2Client.new
  #   formatted_parent = ConfigServiceV2Client.project_path("[PROJECT]")
  #   sink = LogSink.new
  #   response = config_service_v2_client.create_sink(formatted_parent, sink)

  def create_sink \
      parent,
      sink,
      unique_writer_identity: nil,
      options: nil
    req = Google::Logging::V2::CreateSinkRequest.new({
      parent: parent,
      sink: sink,
      unique_writer_identity: unique_writer_identity
    }.delete_if { |_, v| v.nil? })
    @create_sink.call(req, options)
  end

  # Updates a sink. If the named sink doesn't exist, then this method is
  # identical to
  # {sinks.create}[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create].
  # If the named sink does exist, then this method replaces the following
  # fields in the existing sink with values from the new sink: +destination+,
  # +filter+, +output_version_format+, +start_time+, and +end_time+.
  # The updated filter might also have a new +writer_identity+; see the
  # +unique_writer_identity+ field.
  #
  # @param sink_name [String]
  #   Required. The full resource name of the sink to update, including the
  #   parent resource and the sink identifier:
  #
  #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
  #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
  #
  #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
  # @param sink [Google::Logging::V2::LogSink]
  #   Required. The updated sink, whose name is the same identifier that appears
  #   as part of +sink_name+.  If +sink_name+ does not exist, then
  #   this method creates a new sink.
  # @param unique_writer_identity [true, false]
  #   Optional. See
  #   {sinks.create}[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create]
  #   for a description of this field.  When updating a sink, the effect of this
  #   field on the value of +writer_identity+ in the updated sink depends on both
  #   the old and new values of this field:
  #
  #   +   If the old and new values of this field are both false or both true,
  #       then there is no change to the sink's +writer_identity+.
  #   +   If the old value was false and the new value is true, then
  #       +writer_identity+ is changed to a unique service account.
  #   +   It is an error if the old value was true and the new value is false.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogSink]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2/config_service_v2_client"
  #
  #   ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
  #   LogSink = Google::Logging::V2::LogSink
  #
  #   config_service_v2_client = ConfigServiceV2Client.new
  #   formatted_sink_name = ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
  #   sink = LogSink.new
  #   response = config_service_v2_client.update_sink(formatted_sink_name, sink)

  def update_sink \
      sink_name,
      sink,
      unique_writer_identity: nil,
      options: nil
    req = Google::Logging::V2::UpdateSinkRequest.new({
      sink_name: sink_name,
      sink: sink,
      unique_writer_identity: unique_writer_identity
    }.delete_if { |_, v| v.nil? })
    @update_sink.call(req, options)
  end

  # Deletes a sink. If the sink has a unique +writer_identity+, then that
  # service account is also deleted.
  #
  # @param sink_name [String]
  #   Required. The full resource name of the sink to delete, including the
  #   parent resource and the sink identifier:
  #
  #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
  #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
  #
  #   It is an error if the sink does not exist.  Example:
  #   +"projects/my-project-id/sinks/my-sink-id"+.  It is an error if
  #   the sink does not exist.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2/config_service_v2_client"
  #
  #   ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
  #
  #   config_service_v2_client = ConfigServiceV2Client.new
  #   formatted_sink_name = ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
  #   config_service_v2_client.delete_sink(formatted_sink_name)

  def delete_sink \
      sink_name,
      options: nil
    req = Google::Logging::V2::DeleteSinkRequest.new({
      sink_name: sink_name
    }.delete_if { |_, v| v.nil? })
    @delete_sink.call(req, options)
    nil
  end
end

Class Method Details

.match_project_from_project_name(project_name) ⇒ String

Parses the project from a project resource.

Parameters:

  • project_name (String)

Returns:

  • (String) 


105
106
107
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 105

def self.match_project_from_project_name project_name
  PROJECT_PATH_TEMPLATE.match(project_name)["project"]
end

.match_project_from_sink_name(sink_name) ⇒ String

Parses the project from a sink resource.

Parameters:

  • sink_name (String)

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 112

def self.match_project_from_sink_name sink_name
  SINK_PATH_TEMPLATE.match(sink_name)["project"]
end

.match_sink_from_sink_name(sink_name) ⇒ String

Parses the sink from a sink resource.

Parameters:

  • sink_name (String)

Returns:

  • (String) 


119
120
121
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 119

def self.match_sink_from_sink_name sink_name
  SINK_PATH_TEMPLATE.match(sink_name)["sink"]
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


85
86
87
88
89
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 85

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

.sink_path(project, sink) ⇒ String

Returns a fully-qualified sink resource name string.

Parameters:

  • project (String)
  • sink (String)

Returns:

  • (String) 


95
96
97
98
99
100
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 95

def self.sink_path project, sink
  SINK_PATH_TEMPLATE.render(
    :"project" => project,
    :"sink" => sink
  )
end

Instance Method Details

#create_sink(parent, sink, unique_writer_identity: nil, options: nil) ⇒ Google::Logging::V2::LogSink

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or the sink's +writer_identity+ is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

Examples:

require "google/cloud/logging/v2/config_service_v2_client"

ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
LogSink = Google::Logging::V2::LogSink

config_service_v2_client = ConfigServiceV2Client.new
formatted_parent = ConfigServiceV2Client.project_path("[PROJECT]")
sink = LogSink.new
response = config_service_v2_client.create_sink(formatted_parent, sink)

Parameters:

  • parent (String) —

    Required. The resource in which to create the sink:

    "projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"

    Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.

  • sink (Google::Logging::V2::LogSink) —

    Required. The new sink, whose +name+ parameter is a sink identifier that is not already in use.

  • unique_writer_identity (true, false) —

    Optional. Determines the kind of IAM identity returned as +writer_identity+ in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as +writer_identity+ is +cloud-logs@google.com+, the same identity used before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.

    If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of +writer_identity+ will be a unique service account used only for exports from the new sink. For more information, see +writer_identity+ in LogSink.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 344

def create_sink \
    parent,
    sink,
    unique_writer_identity: nil,
    options: nil
  req = Google::Logging::V2::CreateSinkRequest.new({
    parent: parent,
    sink: sink,
    unique_writer_identity: unique_writer_identity
  }.delete_if { |_, v| v.nil? })
  @create_sink.call(req, options)
end

#delete_sink(sink_name, options: nil) ⇒ Object

Deletes a sink. If the sink has a unique +writer_identity+, then that service account is also deleted.

Examples:

require "google/cloud/logging/v2/config_service_v2_client"

ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client

config_service_v2_client = ConfigServiceV2Client.new
formatted_sink_name = ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
config_service_v2_client.delete_sink(formatted_sink_name)

Parameters:

  • sink_name (String) —

    Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:

    "projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"

    It is an error if the sink does not exist. Example: +"projects/my-project-id/sinks/my-sink-id"+. It is an error if the sink does not exist.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



445
446
447
448
449
450
451
452
453
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 445

def delete_sink \
    sink_name,
    options: nil
  req = Google::Logging::V2::DeleteSinkRequest.new({
    sink_name: sink_name
  }.delete_if { |_, v| v.nil? })
  @delete_sink.call(req, options)
  nil
end

#get_sink(sink_name, options: nil) ⇒ Google::Logging::V2::LogSink

Gets a sink.

Examples:

require "google/cloud/logging/v2/config_service_v2_client"

ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client

config_service_v2_client = ConfigServiceV2Client.new
formatted_sink_name = ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
response = config_service_v2_client.get_sink(formatted_sink_name)

Parameters:

  • sink_name (String) —

    Required. The parent resource name of the sink:

    "projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"

    Example: +"projects/my-project-id/sinks/my-sink-id"+.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



291
292
293
294
295
296
297
298
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 291

def get_sink \
    sink_name,
    options: nil
  req = Google::Logging::V2::GetSinkRequest.new({
    sink_name: sink_name
  }.delete_if { |_, v| v.nil? })
  @get_sink.call(req, options)
end

#list_sinks(parent, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>

Lists sinks.

Examples:

require "google/cloud/logging/v2/config_service_v2_client"

ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client

config_service_v2_client = ConfigServiceV2Client.new
formatted_parent = ConfigServiceV2Client.project_path("[PROJECT]")

# Iterate over all results.
config_service_v2_client.list_sinks(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
config_service_v2_client.list_sinks(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Required. The parent resource whose sinks are to be listed. Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>) —

    An enumerable of Google::Logging::V2::LogSink instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



257
258
259
260
261
262
263
264
265
266
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 257

def list_sinks \
    parent,
    page_size: nil,
    options: nil
  req = Google::Logging::V2::ListSinksRequest.new({
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? })
  @list_sinks.call(req, options)
end

#update_sink(sink_name, sink, unique_writer_identity: nil, options: nil) ⇒ Google::Logging::V2::LogSink

Updates a sink. If the named sink doesn't exist, then this method is identical to Google::Cloud::Logging::V2::ConfigServiceV2Client.sinkssinks.create[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create]. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: +destination+, +filter+, +output_version_format+, +start_time+, and +end_time+. The updated filter might also have a new +writer_identity+; see the +unique_writer_identity+ field.

Examples:

require "google/cloud/logging/v2/config_service_v2_client"

ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
LogSink = Google::Logging::V2::LogSink

config_service_v2_client = ConfigServiceV2Client.new
formatted_sink_name = ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
sink = LogSink.new
response = config_service_v2_client.update_sink(formatted_sink_name, sink)

Parameters:

  • sink_name (String) —

    Required. The full resource name of the sink to update, including the parent resource and the sink identifier:

    "projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"

    Example: +"projects/my-project-id/sinks/my-sink-id"+.

  • sink (Google::Logging::V2::LogSink) —

    Required. The updated sink, whose name is the same identifier that appears as part of +sink_name+. If +sink_name+ does not exist, then this method creates a new sink.

  • unique_writer_identity (true, false) —

    Optional. See Google::Cloud::Logging::V2::ConfigServiceV2Client.sinkssinks.create[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create] for a description of this field. When updating a sink, the effect of this field on the value of +writer_identity+ in the updated sink depends on both the old and new values of this field:

    • If the old and new values of this field are both false or both true, then there is no change to the sink's +writer_identity+.
    • If the old value was false and the new value is true, then +writer_identity+ is changed to a unique service account.
    • It is an error if the old value was true and the new value is false.
  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 406

def update_sink \
    sink_name,
    sink,
    unique_writer_identity: nil,
    options: nil
  req = Google::Logging::V2::UpdateSinkRequest.new({
    sink_name: sink_name,
    sink: sink,
    unique_writer_identity: unique_writer_identity
  }.delete_if { |_, v| v.nil? })
  @update_sink.call(req, options)
end