Class: Google::Apis::MonitoringV3::MonitoringService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/monitoring_v3/service.rb

Overview

Stackdriver Monitoring API

Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.

Examples:

require 'google/apis/monitoring_v3'

Monitoring = Google::Apis::MonitoringV3 # Alias the module
service = Monitoring::MonitoringService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ MonitoringService

Returns a new instance of MonitoringService



47
48
49
50
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 47

def initialize
  super('https://monitoring.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#create_collectd_time_series(name, create_collectd_time_series_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::Empty

Stackdriver Monitoring Agent only: Creates a new time series.

Parameters:

  • name (String) —

    The project in which to create the time series. The format is "projects/ PROJECT_ID_OR_NUMBER".

  • create_collectd_time_series_request_object (Google::Apis::MonitoringV3::CreateCollectdTimeSeriesRequest) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



548
549
550
551
552
553
554
555
556
557
558
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 548

def create_collectd_time_series(name, create_collectd_time_series_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v3/{+name}/collectdTimeSeries', options)
  command.request_representation = Google::Apis::MonitoringV3::CreateCollectdTimeSeriesRequest::Representation
  command.request_object = create_collectd_time_series_request_object
  command.response_representation = Google::Apis::MonitoringV3::Empty::Representation
  command.response_class = Google::Apis::MonitoringV3::Empty
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_project_group(name, group_object = nil, validate_only: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::Group

Creates a new group.

Parameters:

  • name (String) —

    The project in which to create the group. The format is "projects/ project_id_or_number".

  • group_object (Google::Apis::MonitoringV3::Group) (defaults to: nil)
  • validate_only (Boolean) —

    If true, validate this request but do not create the group.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 458

def create_project_group(name, group_object = nil, validate_only: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v3/{+name}/groups', options)
  command.request_representation = Google::Apis::MonitoringV3::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::MonitoringV3::Group::Representation
  command.response_class = Google::Apis::MonitoringV3::Group
  command.params['name'] = name unless name.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_project_metric_descriptor(name, metric_descriptor_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::MetricDescriptor

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

Parameters:

  • name (String) —

    The project on which to execute the request. The format is "projects/ project_id_or_number".

  • metric_descriptor_object (Google::Apis::MonitoringV3::MetricDescriptor) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



154
155
156
157
158
159
160
161
162
163
164
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 154

def create_project_metric_descriptor(name, metric_descriptor_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v3/{+name}/metricDescriptors', options)
  command.request_representation = Google::Apis::MonitoringV3::MetricDescriptor::Representation
  command.request_object = metric_descriptor_object
  command.response_representation = Google::Apis::MonitoringV3::MetricDescriptor::Representation
  command.response_class = Google::Apis::MonitoringV3::MetricDescriptor
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_time_series(name, create_time_series_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::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.

Parameters:

  • name (String) —

    The project on which to execute the request. The format is "projects/ project_id_or_number".

  • create_time_series_request_object (Google::Apis::MonitoringV3::CreateTimeSeriesRequest) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



686
687
688
689
690
691
692
693
694
695
696
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 686

def create_time_series(name, create_time_series_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v3/{+name}/timeSeries', options)
  command.request_representation = Google::Apis::MonitoringV3::CreateTimeSeriesRequest::Representation
  command.request_object = create_time_series_request_object
  command.response_representation = Google::Apis::MonitoringV3::Empty::Representation
  command.response_class = Google::Apis::MonitoringV3::Empty
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_group(name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::Empty

Deletes an existing group.

Parameters:

  • name (String) —

    The group to delete. The format is "projects/project_id_or_number/groups/ group_id".

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



298
299
300
301
302
303
304
305
306
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 298

def delete_project_group(name, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::MonitoringV3::Empty::Representation
  command.response_class = Google::Apis::MonitoringV3::Empty
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_metric_descriptor(name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::Empty

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

Parameters:

  • name (String) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



188
189
190
191
192
193
194
195
196
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 188

def delete_project_metric_descriptor(name, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::MonitoringV3::Empty::Representation
  command.response_class = Google::Apis::MonitoringV3::Empty
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_project_group(name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::Group

Gets a single group.

Parameters:

  • name (String) —

    The group to retrieve. The format is "projects/project_id_or_number/groups/ group_id".

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



385
386
387
388
389
390
391
392
393
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 385

def get_project_group(name, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::MonitoringV3::Group::Representation
  command.response_class = Google::Apis::MonitoringV3::Group
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_project_metric_descriptor(name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::MetricDescriptor

Gets a single metric descriptor. This method does not require a Stackdriver account.

Parameters:

  • name (String) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



121
122
123
124
125
126
127
128
129
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 121

def get_project_metric_descriptor(name, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::MonitoringV3::MetricDescriptor::Representation
  command.response_class = Google::Apis::MonitoringV3::MetricDescriptor
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_project_monitored_resource_descriptor(name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::MonitoredResourceDescriptor

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

Parameters:

  • name (String) —

    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.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



267
268
269
270
271
272
273
274
275
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 267

def get_project_monitored_resource_descriptor(name, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::MonitoringV3::MonitoredResourceDescriptor::Representation
  command.response_class = Google::Apis::MonitoringV3::MonitoredResourceDescriptor
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_project_group_members(name, interval_end_time: nil, filter: nil, page_token: nil, interval_start_time: nil, page_size: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::ListGroupMembersResponse

Lists the monitored resources that are members of a group.

Parameters:

  • name (String) —

    The group whose members are listed. The format is "projects/ project_id_or_number/groups/group_id".

  • interval_end_time (String) —

    Required. The end of the time interval.

  • filter (String) —

    An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: resource.type = "gce_instance"

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

  • interval_start_time (String) —

    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

  • page_size (Fixnum) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 509

def list_project_group_members(name, interval_end_time: nil, filter: nil, page_token: nil, interval_start_time: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v3/{+name}/members', options)
  command.response_representation = Google::Apis::MonitoringV3::ListGroupMembersResponse::Representation
  command.response_class = Google::Apis::MonitoringV3::ListGroupMembersResponse
  command.params['name'] = name unless name.nil?
  command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['interval.startTime'] = interval_start_time unless interval_start_time.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_project_groups(name, children_of_group: nil, descendants_of_group: nil, page_token: nil, page_size: nil, ancestors_of_group: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::ListGroupsResponse

Lists the existing groups.

Parameters:

  • name (String) —

    The project whose groups are to be listed. The format is "projects/ project_id_or_number".

  • children_of_group (String) —

    A group name: "projects/project_id_or_number/groups/group_id". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.

  • descendants_of_group (String) —

    A group name: "projects/project_id_or_number/groups/group_id". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.

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

  • page_size (Fixnum) —

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

  • ancestors_of_group (String) —

    A group name: "projects/project_id_or_number/groups/group_id". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 349

def list_project_groups(name, children_of_group: nil, descendants_of_group: nil, page_token: nil, page_size: nil, ancestors_of_group: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v3/{+name}/groups', options)
  command.response_representation = Google::Apis::MonitoringV3::ListGroupsResponse::Representation
  command.response_class = Google::Apis::MonitoringV3::ListGroupsResponse
  command.params['name'] = name unless name.nil?
  command.query['childrenOfGroup'] = children_of_group unless children_of_group.nil?
  command.query['descendantsOfGroup'] = descendants_of_group unless descendants_of_group.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['ancestorsOfGroup'] = ancestors_of_group unless ancestors_of_group.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_project_metric_descriptors(name, filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::ListMetricDescriptorsResponse

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

Parameters:

  • name (String) —

    The project on which to execute the request. The format is "projects/ project_id_or_number".

  • filter (String) —

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

  • page_size (Fixnum) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 85

def list_project_metric_descriptors(name, filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v3/{+name}/metricDescriptors', options)
  command.response_representation = Google::Apis::MonitoringV3::ListMetricDescriptorsResponse::Representation
  command.response_class = Google::Apis::MonitoringV3::ListMetricDescriptorsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_project_monitored_resource_descriptors(name, filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse

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

Parameters:

  • name (String) —

    The project on which to execute the request. The format is "projects/ project_id_or_number".

  • filter (String) —

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

  • page_size (Fixnum) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 231

def list_project_monitored_resource_descriptors(name, filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v3/{+name}/monitoredResourceDescriptors', options)
  command.response_representation = Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse::Representation
  command.response_class = Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_project_time_series(name, aggregation_group_by_fields: nil, interval_end_time: nil, aggregation_alignment_period: nil, page_size: nil, order_by: nil, aggregation_cross_series_reducer: nil, filter: nil, aggregation_per_series_aligner: nil, page_token: nil, interval_start_time: nil, view: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::ListTimeSeriesResponse

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

Parameters:

  • name (String) —

    The project on which to execute the request. The format is "projects/ project_id_or_number".

  • aggregation_group_by_fields (Array<String>, String) —

    The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.

  • interval_end_time (String) —

    Required. The end of the time interval.

  • aggregation_alignment_period (String) —

    The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.

  • page_size (Fixnum) —

    A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.

  • order_by (String) —

    Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.

  • aggregation_cross_series_reducer (String) —

    The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.

  • filter (String) —

    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.label.instance_name = "my-instance-name"

  • aggregation_per_series_aligner (String) —

    The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.

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

  • interval_start_time (String) —

    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

  • view (String) —

    Specifies which information is returned about the time series.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 641

def list_project_time_series(name, aggregation_group_by_fields: nil, interval_end_time: nil, aggregation_alignment_period: nil, page_size: nil, order_by: nil, aggregation_cross_series_reducer: nil, filter: nil, aggregation_per_series_aligner: nil, page_token: nil, interval_start_time: nil, view: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v3/{+name}/timeSeries', options)
  command.response_representation = Google::Apis::MonitoringV3::ListTimeSeriesResponse::Representation
  command.response_class = Google::Apis::MonitoringV3::ListTimeSeriesResponse
  command.params['name'] = name unless name.nil?
  command.query['aggregation.groupByFields'] = aggregation_group_by_fields unless aggregation_group_by_fields.nil?
  command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil?
  command.query['aggregation.alignmentPeriod'] = aggregation_alignment_period unless aggregation_alignment_period.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['aggregation.crossSeriesReducer'] = aggregation_cross_series_reducer unless aggregation_cross_series_reducer.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['aggregation.perSeriesAligner'] = aggregation_per_series_aligner unless aggregation_per_series_aligner.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['interval.startTime'] = interval_start_time unless interval_start_time.nil?
  command.query['view'] = view unless view.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_project_group(name, group_object = nil, validate_only: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MonitoringV3::Group

Updates an existing group. You can change any group attributes except name.

Parameters:

  • name (String) —

    Output only. The name of this group. The format is "projects/ project_id_or_number/groups/group_id". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique group_id that is generated automatically.

  • group_object (Google::Apis::MonitoringV3::Group) (defaults to: nil)
  • validate_only (Boolean) —

    If true, validate this request but do not update the existing group.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'generated/google/apis/monitoring_v3/service.rb', line 421

def update_project_group(name, group_object = nil, validate_only: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v3/{+name}', options)
  command.request_representation = Google::Apis::MonitoringV3::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::MonitoringV3::Group::Representation
  command.response_class = Google::Apis::MonitoringV3::Group
  command.params['name'] = name unless name.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end