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
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ ConfigServiceV2Client

Returns a new instance of ConfigServiceV2Client

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • 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.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



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
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 156

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: 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"

  credentials ||= Google::Cloud::Logging::V2::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Logging::V2::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-logging'].version.version

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

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  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,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @config_service_v2_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Logging::V2::ConfigServiceV2::Stub.method(:new)
  )

  @list_sinks = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:list_sinks),
    defaults["list_sinks"],
    exception_transformer: exception_transformer
  )
  @get_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:get_sink),
    defaults["get_sink"],
    exception_transformer: exception_transformer
  )
  @create_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:create_sink),
    defaults["create_sink"],
    exception_transformer: exception_transformer
  )
  @update_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:update_sink),
    defaults["update_sink"],
    exception_transformer: exception_transformer
  )
  @delete_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:delete_sink),
    defaults["delete_sink"],
    exception_transformer: exception_transformer
  )
  @list_exclusions = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:list_exclusions),
    defaults["list_exclusions"],
    exception_transformer: exception_transformer
  )
  @get_exclusion = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:get_exclusion),
    defaults["get_exclusion"],
    exception_transformer: exception_transformer
  )
  @create_exclusion = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:create_exclusion),
    defaults["create_exclusion"],
    exception_transformer: exception_transformer
  )
  @update_exclusion = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:update_exclusion),
    defaults["update_exclusion"],
    exception_transformer: exception_transformer
  )
  @delete_exclusion = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:delete_exclusion),
    defaults["delete_exclusion"],
    exception_transformer: exception_transformer
  )
end

Class Method Details

.exclusion_path(project, exclusion) ⇒ String

Returns a fully-qualified exclusion resource name string.

Parameters:

  • project (String)
  • exclusion (String)

Returns:

  • (String) 


120
121
122
123
124
125
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 120

def self.exclusion_path project, exclusion
  EXCLUSION_PATH_TEMPLATE.render(
    :"project" => project,
    :"exclusion" => exclusion
  )
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


99
100
101
102
103
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 99

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) 


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

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

Instance Method Details

#create_exclusion(parent, exclusion, options: nil) {|result, operation| ... } ⇒ Google::Logging::V2::LogExclusion

Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")

# TODO: Initialize +exclusion+:
exclusion = {}
response = config_service_v2_client.create_exclusion(formatted_parent, exclusion)

Parameters:

  • parent (String) —

    Required. The parent resource in which to create the exclusion:

    "projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"

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

  • exclusion (Google::Logging::V2::LogExclusion | Hash) —

    Required. The new exclusion, whose +name+ parameter is an exclusion name that is not already used in the parent resource. A hash of the same form as Google::Logging::V2::LogExclusion can also be provided.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 700

def create_exclusion \
    parent,
    exclusion,
    options: nil,
    &block
  req = {
    parent: parent,
    exclusion: exclusion
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::CreateExclusionRequest)
  @create_exclusion.call(req, options, &block)
end

#create_sink(parent, sink, unique_writer_identity: nil, options: nil) {|result, operation| ... } ⇒ 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 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 = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")

# TODO: Initialize +sink+:
sink = {}
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]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"

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

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

    Required. The new sink, whose +name+ parameter is a sink identifier that is not already in use. A hash of the same form as Google::Logging::V2::LogSink can also be provided.

  • 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 the same group or service account used by Stackdriver Logging 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.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 429

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

#delete_exclusion(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes an exclusion.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
formatted_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.exclusion_path("[PROJECT]", "[EXCLUSION]")
config_service_v2_client.delete_exclusion(formatted_name)

Parameters:

  • name (String) —

    Required. The resource name of an existing exclusion to delete:

    "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

    Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 800

def delete_exclusion \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::DeleteExclusionRequest)
  @delete_exclusion.call(req, options, &block)
  nil
end

#delete_sink(sink_name, options: nil) {|result, operation| ... } ⇒ 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 = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
formatted_sink_name = Google::Cloud::Logging::V2::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]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_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.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 556

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

#get_exclusion(name, options: nil) {|result, operation| ... } ⇒ Google::Logging::V2::LogExclusion

Gets the description of an exclusion.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
formatted_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.exclusion_path("[PROJECT]", "[EXCLUSION]")
response = config_service_v2_client.get_exclusion(formatted_name)

Parameters:

  • name (String) —

    Required. The resource name of an existing exclusion:

    "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

    Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



653
654
655
656
657
658
659
660
661
662
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 653

def get_exclusion \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::GetExclusionRequest)
  @get_exclusion.call(req, options, &block)
end

#get_sink(sink_name, options: nil) {|result, operation| ... } ⇒ Google::Logging::V2::LogSink

Gets a sink.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
formatted_sink_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
response = config_service_v2_client.get_sink(formatted_sink_name)

Parameters:

  • sink_name (String) —

    Required. The resource name of the sink:

    "projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_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.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



369
370
371
372
373
374
375
376
377
378
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 369

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

#list_exclusions(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogExclusion>

Lists all the exclusions in a parent resource.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")

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

# Or iterate over results one page at a time.
config_service_v2_client.list_exclusions(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 exclusions are to be listed.

    "projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
  • 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.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

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

    An enumerable of Google::Logging::V2::LogExclusion 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.



614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 614

def list_exclusions \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::ListExclusionsRequest)
  @list_exclusions.call(req, options, &block)
end

#list_sinks(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>

Lists sinks.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
formatted_parent = Google::Cloud::Logging::V2::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:

    "projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
  • 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.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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.



330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 330

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

#update_exclusion(name, exclusion, update_mask, options: nil) {|result, operation| ... } ⇒ Google::Logging::V2::LogExclusion

Changes one or more properties of an existing exclusion.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
formatted_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.exclusion_path("[PROJECT]", "[EXCLUSION]")

# TODO: Initialize +exclusion+:
exclusion = {}

# TODO: Initialize +update_mask+:
update_mask = {}
response = config_service_v2_client.update_exclusion(formatted_name, exclusion, update_mask)

Parameters:

  • name (String) —

    Required. The resource name of the exclusion to update:

    "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

    Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.

  • exclusion (Google::Logging::V2::LogExclusion | Hash) —

    Required. New values for the existing exclusion. Only the fields specified in +update_mask+ are relevant. A hash of the same form as Google::Logging::V2::LogExclusion can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) —

    Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in +update_mask+ are not changed and are ignored in the request.

    For example, to change the filter and description of an exclusion, specify an +update_mask+ of +"filter,description"+. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



760
761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 760

def update_exclusion \
    name,
    exclusion,
    update_mask,
    options: nil,
    &block
  req = {
    name: name,
    exclusion: exclusion,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::UpdateExclusionRequest)
  @update_exclusion.call(req, options, &block)
end

#update_sink(sink_name, sink, unique_writer_identity: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Logging::V2::LogSink

Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: +destination+, and +filter+. The updated sink might also have a new +writer_identity+; see the +unique_writer_identity+ field.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
formatted_sink_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")

# TODO: Initialize +sink+:
sink = {}
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]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"

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

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

    Required. The updated sink, whose name is the same identifier that appears as part of +sink_name+. A hash of the same form as Google::Logging::V2::LogSink can also be provided.

  • unique_writer_identity (true, false) —

    Optional. See 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 is 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 is true and the new value is set to false or defaulted to false.
  • update_mask (Google::Protobuf::FieldMask | Hash) —

    Optional. Field mask that specifies the fields in +sink+ that need an update. A sink field will be overwritten if, and only if, it is in the update mask. +name+ and output only fields cannot be updated.

    An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.

    For a detailed +FieldMask+ definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

    Example: +updateMask=filter+. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 512

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