Class: Google::Apis::ClouderrorreportingV1beta1::ClouderrorreportingService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/clouderrorreporting_v1beta1/service.rb

Overview

Stackdriver Error Reporting API

Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.

Examples:

require 'google/apis/clouderrorreporting_v1beta1'

Clouderrorreporting = Google::Apis::ClouderrorreportingV1beta1 # Alias the module
service = Clouderrorreporting::ClouderrorreportingService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeClouderrorreportingService

Returns a new instance of ClouderrorreportingService.


46
47
48
49
# File 'generated/google/apis/clouderrorreporting_v1beta1/service.rb', line 46

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

Instance Attribute Details

#keyString

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.


39
40
41
# File 'generated/google/apis/clouderrorreporting_v1beta1/service.rb', line 39

def key
  @key
end

#quota_userString

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.


44
45
46
# File 'generated/google/apis/clouderrorreporting_v1beta1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#delete_project_events(project_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouderrorreportingV1beta1::DeleteEventsResponse

Deletes all error events of a given project.

Parameters:

  • project_name (String)

    Required. The resource name of the Google Cloud Platform project. Written as projects/projectID, whereprojectID`is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example:projects/my-project-123`.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


75
76
77
78
79
80
81
82
83
# File 'generated/google/apis/clouderrorreporting_v1beta1/service.rb', line 75

def delete_project_events(project_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+projectName}/events', options)
  command.response_representation = Google::Apis::ClouderrorreportingV1beta1::DeleteEventsResponse::Representation
  command.response_class = Google::Apis::ClouderrorreportingV1beta1::DeleteEventsResponse
  command.params['projectName'] = project_name unless project_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_group(group_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouderrorreportingV1beta1::ErrorGroup

Get the specified group.

Parameters:

  • group_name (String)

    Required. The group resource name. Written as projects/projectID/groups/group_name. Call groupStats.list to return a list of groups belonging to this project. Example: projects/my-project-123/groups/my-group

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


296
297
298
299
300
301
302
303
304
# File 'generated/google/apis/clouderrorreporting_v1beta1/service.rb', line 296

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

#list_project_events(project_name, group_id: nil, page_size: nil, page_token: nil, service_filter_resource_type: nil, service_filter_service: nil, service_filter_version: nil, time_range_period: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouderrorreportingV1beta1::ListEventsResponse

Lists the specified events.

Parameters:

  • project_name (String)

    Required. The resource name of the Google Cloud Platform project. Written as projects/projectID, whereprojectID`is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example:projects/my-project-123`.

  • group_id (String) (defaults to: nil)

    Required. The group for which events shall be returned.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of results to return per response.

  • page_token (String) (defaults to: nil)

    Optional. A next_page_token provided by a previous response.

  • service_filter_resource_type (String) (defaults to: nil)

    Optional. The exact value to match against ServiceContext.resource_type.

  • service_filter_service (String) (defaults to: nil)

    Optional. The exact value to match against ServiceContext.service.

  • service_filter_version (String) (defaults to: nil)

    Optional. The exact value to match against ServiceContext.version.

  • time_range_period (String) (defaults to: nil)

    Restricts the query to the specified time range.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'generated/google/apis/clouderrorreporting_v1beta1/service.rb', line 129

def list_project_events(project_name, group_id: nil, page_size: nil, page_token: nil, service_filter_resource_type: nil, service_filter_service: nil, service_filter_version: nil, time_range_period: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+projectName}/events', options)
  command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ListEventsResponse::Representation
  command.response_class = Google::Apis::ClouderrorreportingV1beta1::ListEventsResponse
  command.params['projectName'] = project_name unless project_name.nil?
  command.query['groupId'] = group_id unless group_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['serviceFilter.resourceType'] = service_filter_resource_type unless service_filter_resource_type.nil?
  command.query['serviceFilter.service'] = service_filter_service unless service_filter_service.nil?
  command.query['serviceFilter.version'] = service_filter_version unless service_filter_version.nil?
  command.query['timeRange.period'] = time_range_period unless time_range_period.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_group_stats(project_name, alignment: nil, alignment_time: nil, group_id: nil, order: nil, page_size: nil, page_token: nil, service_filter_resource_type: nil, service_filter_service: nil, service_filter_version: nil, time_range_period: nil, timed_count_duration: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouderrorreportingV1beta1::ListGroupStatsResponse

Lists the specified groups.

Parameters:

  • project_name (String)

    Required. The resource name of the Google Cloud Platform project. Written as projects/projectID, whereprojectID`is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example:projects/my-project-123`.

  • alignment (String) (defaults to: nil)

    Optional. The alignment of the timed counts to be returned. Default is ALIGNMENT_EQUAL_AT_END.

  • alignment_time (String) (defaults to: nil)

    Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.

  • group_id (Array<String>, String) (defaults to: nil)

    Optional. List all ErrorGroupStats with these IDs.

  • order (String) (defaults to: nil)

    Optional. The sort order in which the results are returned. Default is COUNT_DESC.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of results to return per response. Default is 20.

  • page_token (String) (defaults to: nil)

    Optional. A next_page_token provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.

  • service_filter_resource_type (String) (defaults to: nil)

    Optional. The exact value to match against ServiceContext.resource_type.

  • service_filter_service (String) (defaults to: nil)

    Optional. The exact value to match against ServiceContext.service.

  • service_filter_version (String) (defaults to: nil)

    Optional. The exact value to match against ServiceContext.version.

  • time_range_period (String) (defaults to: nil)

    Restricts the query to the specified time range.

  • timed_count_duration (String) (defaults to: nil)

    Optional. The preferred duration for a single returned TimedCount. If not set, no timed counts are returned.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'generated/google/apis/clouderrorreporting_v1beta1/service.rb', line 249

def list_project_group_stats(project_name, alignment: nil, alignment_time: nil, group_id: nil, order: nil, page_size: nil, page_token: nil, service_filter_resource_type: nil, service_filter_service: nil, service_filter_version: nil, time_range_period: nil, timed_count_duration: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+projectName}/groupStats', options)
  command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ListGroupStatsResponse::Representation
  command.response_class = Google::Apis::ClouderrorreportingV1beta1::ListGroupStatsResponse
  command.params['projectName'] = project_name unless project_name.nil?
  command.query['alignment'] = alignment unless alignment.nil?
  command.query['alignmentTime'] = alignment_time unless alignment_time.nil?
  command.query['groupId'] = group_id unless group_id.nil?
  command.query['order'] = order unless order.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['serviceFilter.resourceType'] = service_filter_resource_type unless service_filter_resource_type.nil?
  command.query['serviceFilter.service'] = service_filter_service unless service_filter_service.nil?
  command.query['serviceFilter.version'] = service_filter_version unless service_filter_version.nil?
  command.query['timeRange.period'] = time_range_period unless time_range_period.nil?
  command.query['timedCountDuration'] = timed_count_duration unless timed_count_duration.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#report_project_event(project_name, reported_error_event_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouderrorreportingV1beta1::ReportErrorEventResponse

Report an individual error event. This endpoint accepts either an OAuth token, or an API key for authentication. To use an API key, append it to the URL as the value of a key parameter. For example: POST https://clouderrorreporting.googleapis.com/v1beta1/projectName/events:report? key=123ABC456

Parameters:

  • project_name (String)

    Required. The resource name of the Google Cloud Platform project. Written as projects/projectId, whereprojectId`is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: //projects/my-project-123`.

  • reported_error_event_object (Google::Apis::ClouderrorreportingV1beta1::ReportedErrorEvent) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


178
179
180
181
182
183
184
185
186
187
188
# File 'generated/google/apis/clouderrorreporting_v1beta1/service.rb', line 178

def report_project_event(project_name, reported_error_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+projectName}/events:report', options)
  command.request_representation = Google::Apis::ClouderrorreportingV1beta1::ReportedErrorEvent::Representation
  command.request_object = reported_error_event_object
  command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ReportErrorEventResponse::Representation
  command.response_class = Google::Apis::ClouderrorreportingV1beta1::ReportErrorEventResponse
  command.params['projectName'] = project_name unless project_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_group(name, error_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouderrorreportingV1beta1::ErrorGroup

Replace the data for the specified group. Fails if the group does not exist.

Parameters:

  • name (String)

    The group resource name. Example: projects/my-project-123/groups/CNSgkpnppqKCUw

  • error_group_object (Google::Apis::ClouderrorreportingV1beta1::ErrorGroup) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


329
330
331
332
333
334
335
336
337
338
339
# File 'generated/google/apis/clouderrorreporting_v1beta1/service.rb', line 329

def update_project_group(name, error_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup::Representation
  command.request_object = error_group_object
  command.response_representation = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup::Representation
  command.response_class = Google::Apis::ClouderrorreportingV1beta1::ErrorGroup
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end