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

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

Overview

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:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://clouderrorreporting.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ClouderrorreportingService

Returns a new instance of ClouderrorreportingService.



48
49
50
51
52
53
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-clouderrorreporting_v1beta1',
        client_version: Google::Apis::ClouderrorreportingV1beta1::GEM_VERSION)
  @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.



41
42
43
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 41

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.



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

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/projectIDor `projects/`projectID`/locations/`location, where projectID is the Google Cloud Platform project ID and location is a Cloud region. Examples: projects/my-project-123, projects/my-project-123/locations/global. For a list of supported locations, see Supported Regions. global is the default when unspecified.

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



81
82
83
84
85
86
87
88
89
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 81

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

#delete_project_location_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/projectIDor `projects/`projectID`/locations/`location, where projectID is the Google Cloud Platform project ID and location is a Cloud region. Examples: projects/my-project-123, projects/my-project-123/locations/global. For a list of supported locations, see Supported Regions. global is the default when unspecified.

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



395
396
397
398
399
400
401
402
403
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 395

def delete_project_location_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 either projects/projectID/ groups/group_idor `projects/`projectID`/locations/`location`/groups/` group_id. Call groupStats.list to return a list of groups belonging to this project. Examples: projects/my-project-123/groups/my-group, projects/my- project-123/locations/global/groups/my-group In the group resource name, the group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice. For a list of supported locations, see Supported Regions. global is the default when unspecified.

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



317
318
319
320
321
322
323
324
325
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 317

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

#get_project_location_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 either projects/projectID/ groups/group_idor `projects/`projectID`/locations/`location`/groups/` group_id. Call groupStats.list to return a list of groups belonging to this project. Examples: projects/my-project-123/groups/my-group, projects/my- project-123/locations/global/groups/my-group In the group resource name, the group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice. For a list of supported locations, see Supported Regions. global is the default when unspecified.

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



584
585
586
587
588
589
590
591
592
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 584

def get_project_location_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/projectIDor `projects/`projectID`/locations/`location, where projectID is the Google Cloud Platform project ID and location is a Cloud region. Examples: projects/my-project-123, projects/my-project-123/locations/global. For a list of supported locations, see Supported Regions. global is the default when unspecified.

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

    Required. The group for which events shall be returned. The group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice.

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 138

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/projectIDor `projects/`projectNumber, where projectID and projectNumber can be found in the Google Cloud console. It may also include a location, such as projects/projectID/locations/locationwherelocation`is a cloud region. Examples:projects/my-project-123,projects/5551234,projects/my- project-123/locations/us-central1,projects/5551234/locations/us-central1. For a list of supported locations, see [Supported Regions](https://cloud. google.com/logging/docs/region-support).globalis the default when unspecified. Use-` as a wildcard to request group stats from all regions.

  • 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. The group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice.

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 266

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

#list_project_location_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/projectIDor `projects/`projectID`/locations/`location, where projectID is the Google Cloud Platform project ID and location is a Cloud region. Examples: projects/my-project-123, projects/my-project-123/locations/global. For a list of supported locations, see Supported Regions. global is the default when unspecified.

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

    Required. The group for which events shall be returned. The group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice.

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 452

def list_project_location_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_location_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/projectIDor `projects/`projectNumber, where projectID and projectNumber can be found in the Google Cloud console. It may also include a location, such as projects/projectID/locations/locationwherelocation`is a cloud region. Examples:projects/my-project-123,projects/5551234,projects/my- project-123/locations/us-central1,projects/5551234/locations/us-central1. For a list of supported locations, see [Supported Regions](https://cloud. google.com/logging/docs/region-support).globalis the default when unspecified. Use-` as a wildcard to request group stats from all regions.

  • 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. The group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice.

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 533

def list_project_location_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 and record the event to a log. 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 Note: Error Reporting is a service built on Cloud Logging and can analyze log entries when all of the following are true: * Customer-managed encryption keys (CMEK) are disabled on the log bucket. * The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.

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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 190

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. Written as projects/projectID/groups/group_id or `projects/`projectID`/locations/`location`/groups/`group_id Examples: projects/my-project-123/groups/my-group, projects/my-project-123/locations/ us-central1/groups/my-group In the group resource name, the group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice. For a list of supported locations, see Supported Regions. global is the default when unspecified.

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 357

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

#update_project_location_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. Written as projects/projectID/groups/group_id or `projects/`projectID`/locations/`location`/groups/`group_id Examples: projects/my-project-123/groups/my-group, projects/my-project-123/locations/ us-central1/groups/my-group In the group resource name, the group_id is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice. For a list of supported locations, see Supported Regions. global is the default when unspecified.

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/google/apis/clouderrorreporting_v1beta1/service.rb', line 624

def update_project_location_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