Class: Google::Cloud::Logging::V2::MetricsService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/logging/v2/metrics_service/client.rb

Overview

Client for the MetricsService service.

Service for configuring logs-based metrics.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#log_metric_path, #project_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new MetricsService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Logging::V2::MetricsService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Logging::V2::MetricsService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the MetricsService client.

Yield Parameters:



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

def initialize
  # 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 "gapic/grpc"
  require "google/logging/v2/logging_metrics_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @metrics_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Logging::V2::MetricsServiceV2::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @metrics_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the MetricsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all MetricsService clients
::Google::Cloud::Logging::V2::MetricsService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Logging", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.list_log_metrics.timeout = 60.0
    default_config.rpcs.list_log_metrics.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
    }

    default_config.rpcs.get_log_metric.timeout = 60.0
    default_config.rpcs.get_log_metric.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
    }

    default_config.rpcs.create_log_metric.timeout = 60.0

    default_config.rpcs.update_log_metric.timeout = 60.0
    default_config.rpcs.update_log_metric.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
    }

    default_config.rpcs.delete_log_metric.timeout = 60.0
    default_config.rpcs.delete_log_metric.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the MetricsService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



116
117
118
119
 
# File 'lib/google/cloud/logging/v2/metrics_service/client.rb', line 116

def configure
  yield @config if block_given?
  @config
end

#create_log_metric(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric #create_log_metric(parent: nil, metric: nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric

Creates a logs-based metric.

Examples:

Basic example

require "google/cloud/logging/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Logging::V2::MetricsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Logging::V2::CreateLogMetricRequest.new

# Call the create_log_metric method.
result = client.create_log_metric request

# The returned object is of type Google::Cloud::Logging::V2::LogMetric.
p result

Overloads:

  • #create_log_metric(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric

    Pass arguments to create_log_metric via a request object, either of type CreateLogMetricRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::CreateLogMetricRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #create_log_metric(parent: nil, metric: nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric

    Pass arguments to create_log_metric via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The resource name of the project in which to create the metric:

      "projects/[PROJECT_ID]"

      The new metric must be provided in the request.

    • metric (::Google::Cloud::Logging::V2::LogMetric, ::Hash) (defaults to: nil) —

      Required. The new logs-based metric, which must not have an identifier that already exists.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/google/cloud/logging/v2/metrics_service/client.rb', line 448

def create_log_metric request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::CreateLogMetricRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_log_metric.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_log_metric.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_log_metric.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @metrics_service_stub.call_rpc :create_log_metric, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_log_metric(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_log_metric(metric_name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a logs-based metric.

Examples:

Basic example

require "google/cloud/logging/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Logging::V2::MetricsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Logging::V2::DeleteLogMetricRequest.new

# Call the delete_log_metric method.
result = client.delete_log_metric request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_log_metric(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_log_metric via a request object, either of type DeleteLogMetricRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::DeleteLogMetricRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #delete_log_metric(metric_name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_log_metric via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • metric_name (::String) (defaults to: nil) —

      Required. The resource name of the metric to delete:

      "projects/[PROJECT_ID]/metrics/[METRIC_ID]"

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/google/cloud/logging/v2/metrics_service/client.rb', line 628

def delete_log_metric request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::DeleteLogMetricRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_log_metric.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.metric_name
    header_params["metric_name"] = request.metric_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_log_metric.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_log_metric.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @metrics_service_stub.call_rpc :delete_log_metric, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_log_metric(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric #get_log_metric(metric_name: nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric

Gets a logs-based metric.

Examples:

Basic example

require "google/cloud/logging/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Logging::V2::MetricsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Logging::V2::GetLogMetricRequest.new

# Call the get_log_metric method.
result = client.get_log_metric request

# The returned object is of type Google::Cloud::Logging::V2::LogMetric.
p result

Overloads:

  • #get_log_metric(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric

    Pass arguments to get_log_metric via a request object, either of type GetLogMetricRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::GetLogMetricRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #get_log_metric(metric_name: nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric

    Pass arguments to get_log_metric via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • metric_name (::String) (defaults to: nil) —

      Required. The resource name of the desired metric:

      "projects/[PROJECT_ID]/metrics/[METRIC_ID]"

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



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

def get_log_metric request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::GetLogMetricRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_log_metric.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.metric_name
    header_params["metric_name"] = request.metric_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_log_metric.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_log_metric.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @metrics_service_stub.call_rpc :get_log_metric, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_log_metrics(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogMetric> #list_log_metrics(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogMetric>

Lists logs-based metrics.

Examples:

Basic example

require "google/cloud/logging/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Logging::V2::MetricsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Logging::V2::ListLogMetricsRequest.new

# Call the list_log_metrics method.
result = client.list_log_metrics request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Logging::V2::LogMetric.
  p item
end

Overloads:

  • #list_log_metrics(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogMetric>

    Pass arguments to list_log_metrics via a request object, either of type ListLogMetricsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::ListLogMetricsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #list_log_metrics(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogMetric>

    Pass arguments to list_log_metrics via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The name of the project containing the metrics:

      "projects/[PROJECT_ID]"
    • page_token (::String) (defaults to: nil) —

      Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



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

def list_log_metrics request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::ListLogMetricsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_log_metrics.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_log_metrics.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_log_metrics.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @metrics_service_stub.call_rpc :list_log_metrics, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @metrics_service_stub, :list_log_metrics, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


202
203
204
 
# File 'lib/google/cloud/logging/v2/metrics_service/client.rb', line 202

def logger
  @metrics_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


126
127
128
 
# File 'lib/google/cloud/logging/v2/metrics_service/client.rb', line 126

def universe_domain
  @metrics_service_stub.universe_domain
end

#update_log_metric(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric #update_log_metric(metric_name: nil, metric: nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric

Creates or updates a logs-based metric.

Examples:

Basic example

require "google/cloud/logging/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Logging::V2::MetricsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Logging::V2::UpdateLogMetricRequest.new

# Call the update_log_metric method.
result = client.update_log_metric request

# The returned object is of type Google::Cloud::Logging::V2::LogMetric.
p result

Overloads:

  • #update_log_metric(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric

    Pass arguments to update_log_metric via a request object, either of type UpdateLogMetricRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::UpdateLogMetricRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #update_log_metric(metric_name: nil, metric: nil) ⇒ ::Google::Cloud::Logging::V2::LogMetric

    Pass arguments to update_log_metric via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • metric_name (::String) (defaults to: nil) —

      Required. The resource name of the metric to update:

      "projects/[PROJECT_ID]/metrics/[METRIC_ID]"

      The updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.

    • metric (::Google::Cloud::Logging::V2::LogMetric, ::Hash) (defaults to: nil) —

      Required. The updated metric.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/google/cloud/logging/v2/metrics_service/client.rb', line 541

def update_log_metric request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::UpdateLogMetricRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_log_metric.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.metric_name
    header_params["metric_name"] = request.metric_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_log_metric.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_log_metric.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @metrics_service_stub.call_rpc :update_log_metric, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end