Class: Google::Cloud::Monitoring::V3::MetricService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/monitoring/v3/metric_service/client.rb

Overview

Client for the MetricService service.

Manages metric descriptors, monitored resource descriptors, and time series data.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#folder_path, #metric_descriptor_path, #monitored_resource_descriptor_path, #organization_path, #project_path, #workspace_path

Constructor Details

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

Create a new MetricService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Monitoring::V3::MetricService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Monitoring::V3::MetricService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the MetricService client.

Yield Parameters:



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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 144

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/monitoring/v3/metric_service_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 == Client.configure.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

  @metric_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Monitoring::V3::MetricService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

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

Configure the MetricService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all MetricService clients
::Google::Cloud::Monitoring::V3::MetricService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 57

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Monitoring", "V3"]
    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_monitored_resource_descriptors.timeout = 30.0
    default_config.rpcs.list_monitored_resource_descriptors.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_monitored_resource_descriptor.timeout = 30.0
    default_config.rpcs.get_monitored_resource_descriptor.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_metric_descriptors.timeout = 30.0
    default_config.rpcs.list_metric_descriptors.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_metric_descriptor.timeout = 30.0
    default_config.rpcs.get_metric_descriptor.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_metric_descriptor.timeout = 12.0

    default_config.rpcs.delete_metric_descriptor.timeout = 30.0
    default_config.rpcs.delete_metric_descriptor.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_time_series.timeout = 90.0
    default_config.rpcs.list_time_series.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_time_series.timeout = 12.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the MetricService 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:



123
124
125
126
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 123

def configure
  yield @config if block_given?
  @config
end

#create_metric_descriptor(request, options = nil) ⇒ ::Google::Api::MetricDescriptor #create_metric_descriptor(name: nil, metric_descriptor: nil) ⇒ ::Google::Api::MetricDescriptor

Creates a new metric descriptor. User-created metric descriptors define custom metrics.

Overloads:

  • #create_metric_descriptor(request, options = nil) ⇒ ::Google::Api::MetricDescriptor

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::CreateMetricDescriptorRequest, ::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_metric_descriptor(name: nil, metric_descriptor: nil) ⇒ ::Google::Api::MetricDescriptor

    Pass arguments to create_metric_descriptor 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:

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

      Required. The project on which to execute the request. The format is: 4 projects/[PROJECT_ID_OR_NUMBER]

    • metric_descriptor (::Google::Api::MetricDescriptor, ::Hash) (defaults to: nil) —

      Required. The new custom metric descriptor.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



537
538
539
540
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 537

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::CreateMetricDescriptorRequest

  # 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_metric_descriptor.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Monitoring::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_metric_descriptor.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_metric_descriptor.retry_policy

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

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

#create_time_series(request, options = nil) ⇒ ::Google::Protobuf::Empty #create_time_series(name: nil, time_series: nil) ⇒ ::Google::Protobuf::Empty

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::CreateTimeSeriesRequest, ::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_time_series(name: nil, time_series: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to create_time_series 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:

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

      Required. The project on which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]
    • time_series (::Array<::Google::Cloud::Monitoring::V3::TimeSeries, ::Hash>) (defaults to: nil) —

      Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.

      The maximum number of TimeSeries objects per Create request is 200.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 804

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::CreateTimeSeriesRequest

  # 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_time_series.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Monitoring::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_time_series.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_time_series.retry_policy

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

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

#delete_metric_descriptor(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_metric_descriptor(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a metric descriptor. Only user-created custom metrics can be deleted.

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::DeleteMetricDescriptorRequest, ::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_metric_descriptor(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_metric_descriptor 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:

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

      Required. The metric descriptor on which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]

      An example of [METRIC_ID] is: "custom.googleapis.com/my_test_metric".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 612

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::DeleteMetricDescriptorRequest

  # 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_metric_descriptor.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Monitoring::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_metric_descriptor.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_metric_descriptor.retry_policy

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

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

#get_metric_descriptor(request, options = nil) ⇒ ::Google::Api::MetricDescriptor #get_metric_descriptor(name: nil) ⇒ ::Google::Api::MetricDescriptor

Gets a single metric descriptor. This method does not require a Workspace.

Overloads:

  • #get_metric_descriptor(request, options = nil) ⇒ ::Google::Api::MetricDescriptor

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::GetMetricDescriptorRequest, ::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_metric_descriptor(name: nil) ⇒ ::Google::Api::MetricDescriptor

    Pass arguments to get_metric_descriptor 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:

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

      Required. The metric descriptor on which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]

      An example value of [METRIC_ID] is "compute.googleapis.com/instance/disk/read_bytes_count".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 461

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::GetMetricDescriptorRequest

  # 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_metric_descriptor.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Monitoring::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_metric_descriptor.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_metric_descriptor.retry_policy

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

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

#get_monitored_resource_descriptor(request, options = nil) ⇒ ::Google::Api::MonitoredResourceDescriptor #get_monitored_resource_descriptor(name: nil) ⇒ ::Google::Api::MonitoredResourceDescriptor

Gets a single monitored resource descriptor. This method does not require a Workspace.

Overloads:

  • #get_monitored_resource_descriptor(request, options = nil) ⇒ ::Google::Api::MonitoredResourceDescriptor

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::GetMonitoredResourceDescriptorRequest, ::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_monitored_resource_descriptor(name: nil) ⇒ ::Google::Api::MonitoredResourceDescriptor

    Pass arguments to get_monitored_resource_descriptor 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:

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

      Required. The monitored resource descriptor to get. The format is:

      projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE]

      The [RESOURCE_TYPE] is a predefined type, such as cloudsql_database.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 301

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::GetMonitoredResourceDescriptorRequest

  # 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_monitored_resource_descriptor.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Monitoring::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_monitored_resource_descriptor.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_monitored_resource_descriptor.retry_policy

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

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

#list_metric_descriptors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MetricDescriptor> #list_metric_descriptors(name: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MetricDescriptor>

Lists metric descriptors that match a filter. This method does not require a Workspace.

Overloads:

  • #list_metric_descriptors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MetricDescriptor>

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::ListMetricDescriptorsRequest, ::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_metric_descriptors(name: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MetricDescriptor>

    Pass arguments to list_metric_descriptors 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:

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

      Required. The project on which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]
    • filter (::String) (defaults to: nil) —

      If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:

      metric.type = starts_with("custom.googleapis.com/")
    • page_size (::Integer) (defaults to: nil) —

      A positive number that is the maximum number of results to return.

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

      If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 387

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::ListMetricDescriptorsRequest

  # 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_metric_descriptors.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Monitoring::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_metric_descriptors.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_metric_descriptors.retry_policy

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

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

#list_monitored_resource_descriptors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResourceDescriptor> #list_monitored_resource_descriptors(name: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResourceDescriptor>

Lists monitored resource descriptors that match a filter. This method does not require a Workspace.

Overloads:

  • #list_monitored_resource_descriptors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResourceDescriptor>

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::ListMonitoredResourceDescriptorsRequest, ::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_monitored_resource_descriptors(name: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResourceDescriptor>

    Pass arguments to list_monitored_resource_descriptors 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:

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

      Required. The project on which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]
    • filter (::String) (defaults to: nil) —

      An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:

      resource.type = starts_with("gce_") AND resource.label:id
    • page_size (::Integer) (defaults to: nil) —

      A positive number that is the maximum number of results to return.

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

      If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 227

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::ListMonitoredResourceDescriptorsRequest

  # 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_monitored_resource_descriptors.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Monitoring::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_monitored_resource_descriptors.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_monitored_resource_descriptors.retry_policy

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

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

#list_time_series(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::TimeSeries> #list_time_series(name: nil, filter: nil, interval: nil, aggregation: nil, secondary_aggregation: nil, order_by: nil, view: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::TimeSeries>

Lists time series that match a filter. This method does not require a Workspace.

Overloads:

  • #list_time_series(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::TimeSeries>

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest, ::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_time_series(name: nil, filter: nil, interval: nil, aggregation: nil, secondary_aggregation: nil, order_by: nil, view: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::TimeSeries>

    Pass arguments to list_time_series 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:

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

      Required. The project, organization or folder on which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]
organizations/[ORGANIZATION_ID]
folders/[FOLDER_ID]
    • filter (::String) (defaults to: nil) —

      Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:

      metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
    metric.labels.instance_name = "my-instance-name"
    • interval (::Google::Cloud::Monitoring::V3::TimeInterval, ::Hash) (defaults to: nil) —

      Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.

    • aggregation (::Google::Cloud::Monitoring::V3::Aggregation, ::Hash) (defaults to: nil) —

      Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.

      By default (if no aggregation is explicitly specified), the raw time series data is returned.

    • secondary_aggregation (::Google::Cloud::Monitoring::V3::Aggregation, ::Hash) (defaults to: nil) —

      Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.

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

      Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

    • view (::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView) (defaults to: nil) —

      Required. Specifies which information is returned about the time series.

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

      A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.

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

      If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 721

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest

  # 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_time_series.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Monitoring::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_time_series.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_time_series.retry_policy

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

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