Class: Google::Cloud::ErrorReporting::V1beta1::ErrorStatsServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/error_reporting/v1beta1/error_stats_service_client.rb

Overview

An API for retrieving and managing error statistics as well as data for individual events.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"clouderrorreporting.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ ErrorStatsServiceClient

Returns a new instance of ErrorStatsServiceClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/google/cloud/error_reporting/v1beta1/error_stats_service_client.rb', line 119

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/devtools/clouderrorreporting/v1beta1/error_stats_service_services_pb"

  credentials ||= Google::Cloud::ErrorReporting::V1beta1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::ErrorReporting::V1beta1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-error_reporting'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "error_stats_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.devtools.clouderrorreporting.v1beta1.ErrorStatsService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @error_stats_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Devtools::Clouderrorreporting::V1beta1::ErrorStatsService::Stub.method(:new)
  )

  @list_group_stats = Google::Gax.create_api_call(
    @error_stats_service_stub.method(:list_group_stats),
    defaults["list_group_stats"],
    exception_transformer: exception_transformer
  )
  @list_events = Google::Gax.create_api_call(
    @error_stats_service_stub.method(:list_events),
    defaults["list_events"],
    exception_transformer: exception_transformer
  )
  @delete_events = Google::Gax.create_api_call(
    @error_stats_service_stub.method(:delete_events),
    defaults["delete_events"],
    exception_transformer: exception_transformer
  )
end

Class Method Details

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


84
85
86
87
88
 
# File 'lib/google/cloud/error_reporting/v1beta1/error_stats_service_client.rb', line 84

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

Instance Method Details

#delete_events(project_name, options: nil) {|result, operation| ... } ⇒ Google::Devtools::Clouderrorreporting::V1beta1::DeleteEventsResponse

Deletes all error events of a given project.

Examples:

require "google/cloud/error_reporting"

error_stats_service_client = Google::Cloud::ErrorReporting::ErrorStats.new(version: :v1beta1)
formatted_project_name = Google::Cloud::ErrorReporting::V1beta1::ErrorStatsServiceClient.project_path("[PROJECT]")
response = error_stats_service_client.delete_events(formatted_project_name)

Parameters:

  • project_name (String) —

    [Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID. Example: projects/my-project-123.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



426
427
428
429
430
431
432
433
434
435
 
# File 'lib/google/cloud/error_reporting/v1beta1/error_stats_service_client.rb', line 426

def delete_events \
    project_name,
    options: nil,
    &block
  req = {
    project_name: project_name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Devtools::Clouderrorreporting::V1beta1::DeleteEventsRequest)
  @delete_events.call(req, options, &block)
end

#list_events(project_name, group_id, service_filter: nil, time_range: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Devtools::Clouderrorreporting::V1beta1::ErrorEvent>

Lists the specified events.

Examples:

require "google/cloud/error_reporting"

error_stats_service_client = Google::Cloud::ErrorReporting::ErrorStats.new(version: :v1beta1)
formatted_project_name = Google::Cloud::ErrorReporting::V1beta1::ErrorStatsServiceClient.project_path("[PROJECT]")

# TODO: Initialize `group_id`:
group_id = ''

# Iterate over all results.
error_stats_service_client.list_events(formatted_project_name, group_id).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
error_stats_service_client.list_events(formatted_project_name, group_id).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • project_name (String) —

    [Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID. Example: projects/my-project-123.

  • group_id (String) —

    [Required] The group for which events shall be returned.

  • service_filter (Google::Devtools::Clouderrorreporting::V1beta1::ServiceContextFilter | Hash) (defaults to: nil) —

    [Optional] List only ErrorGroups which belong to a service context that matches the filter. Data for all service contexts is returned if this field is not specified. A hash of the same form as Google::Devtools::Clouderrorreporting::V1beta1::ServiceContextFilter can also be provided.

  • time_range (Google::Devtools::Clouderrorreporting::V1beta1::QueryTimeRange | Hash) (defaults to: nil) —

    [Optional] List only data for the given time range. If not set a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. A hash of the same form as Google::Devtools::Clouderrorreporting::V1beta1::QueryTimeRange can also be provided.

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

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Devtools::Clouderrorreporting::V1beta1::ErrorEvent>) —

    An enumerable of Google::Devtools::Clouderrorreporting::V1beta1::ErrorEvent instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/google/cloud/error_reporting/v1beta1/error_stats_service_client.rb', line 384

def list_events \
    project_name,
    group_id,
    service_filter: nil,
    time_range: nil,
    page_size: nil,
    options: nil,
    &block
  req = {
    project_name: project_name,
    group_id: group_id,
    service_filter: service_filter,
    time_range: time_range,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Devtools::Clouderrorreporting::V1beta1::ListEventsRequest)
  @list_events.call(req, options, &block)
end

#list_group_stats(project_name, time_range, group_id: nil, service_filter: nil, timed_count_duration: nil, alignment: nil, alignment_time: nil, order: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroupStats>

Lists the specified groups.

Examples:

require "google/cloud/error_reporting"

error_stats_service_client = Google::Cloud::ErrorReporting::ErrorStats.new(version: :v1beta1)
formatted_project_name = Google::Cloud::ErrorReporting::V1beta1::ErrorStatsServiceClient.project_path("[PROJECT]")

# TODO: Initialize `time_range`:
time_range = {}

# Iterate over all results.
error_stats_service_client.list_group_stats(formatted_project_name, time_range).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
error_stats_service_client.list_group_stats(formatted_project_name, time_range).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • project_name (String) —

    [Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID.

    Example: projects/my-project-123.

  • time_range (Google::Devtools::Clouderrorreporting::V1beta1::QueryTimeRange | Hash) —

    [Optional] List data for the given time range. If not set a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. Only ErrorGroupStats with a non-zero count in the given time range are returned, unless the request contains an explicit group_id list. If a group_id list is given, also ErrorGroupStats with zero occurrences are returned. A hash of the same form as Google::Devtools::Clouderrorreporting::V1beta1::QueryTimeRange can also be provided.

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

    [Optional] List all ErrorGroupStats with these IDs.

  • service_filter (Google::Devtools::Clouderrorreporting::V1beta1::ServiceContextFilter | Hash) (defaults to: nil) —

    [Optional] List only ErrorGroupStats which belong to a service context that matches the filter. Data for all service contexts is returned if this field is not specified. A hash of the same form as Google::Devtools::Clouderrorreporting::V1beta1::ServiceContextFilter can also be provided.

  • timed_count_duration (Google::Protobuf::Duration | Hash) (defaults to: nil) —

    [Optional] The preferred duration for a single returned TimedCount. If not set, no timed counts are returned. A hash of the same form as Google::Protobuf::Duration can also be provided.

  • alignment (Google::Devtools::Clouderrorreporting::V1beta1::TimedCountAlignment) (defaults to: nil) —

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

  • alignment_time (Google::Protobuf::Timestamp | Hash) (defaults to: nil) —

    [Optional] Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • order (Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroupOrder) (defaults to: nil) —

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

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

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroupStats>) —

    An enumerable of Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroupStats instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/google/cloud/error_reporting/v1beta1/error_stats_service_client.rb', line 295

def list_group_stats \
    project_name,
    time_range,
    group_id: nil,
    service_filter: nil,
    timed_count_duration: nil,
    alignment: nil,
    alignment_time: nil,
    order: nil,
    page_size: nil,
    options: nil,
    &block
  req = {
    project_name: project_name,
    time_range: time_range,
    group_id: group_id,
    service_filter: service_filter,
    timed_count_duration: timed_count_duration,
    alignment: alignment,
    alignment_time: alignment_time,
    order: order,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Devtools::Clouderrorreporting::V1beta1::ListGroupStatsRequest)
  @list_group_stats.call(req, options, &block)
end