Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::QueryService::Client (v0.11.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::QueryService::Client.

Client for the QueryService service.

The QueryService API is used to manage time series data in Stackdriver Monitoring. Time series data is a collection of data points that describes the time-varying values of a metric.

Inherits

  • Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the QueryService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all QueryService clients
::Google::Cloud::Monitoring::V3::QueryService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the QueryService 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new QueryService client object.

Yields
  • (config) — Configure the QueryService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Monitoring::V3::QueryService::Client.new

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

#query_time_series

def query_time_series(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::TimeSeriesData>
def query_time_series(name: nil, query: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::TimeSeriesData>

Queries time series using Monitoring Query Language. This method does not require a Workspace.

Overloads 
def query_time_series(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::TimeSeriesData>
Pass arguments to query_time_series via a request object, either of type Google::Cloud::Monitoring::V3::QueryTimeSeriesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Monitoring::V3::QueryTimeSeriesRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def query_time_series(name: nil, query: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::TimeSeriesData>
Pass arguments to query_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) —

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

    projects/[PROJECT_ID_OR_NUMBER]
  • query (::String) — Required. The query in the Monitoring Query Language format. The default time zone is in UTC.
  • page_size (::Integer) — A positive number that is the maximum number of time_series_data to return.
  • page_token (::String) — 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.
Example

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::QueryService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::QueryTimeSeriesRequest.new

# Call the query_time_series method.
result = client.query_time_series 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::Monitoring::V3::TimeSeriesData.
  p item
end