class Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Client

Client for the ReportErrorsService service.

An API for reporting error events.

Attributes

report_errors_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the ReportErrorsService Client class.

See {::Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all ReportErrorsService clients
::Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/error_reporting/v1beta1/report_errors_service/client.rb, line 56
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "ErrorReporting", "V1beta1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 600.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new ReportErrorsService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the ReportErrorsService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/error_reporting/v1beta1/report_errors_service/client.rb, line 111
def initialize
  # 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 "gapic/grpc"
  require "google/devtools/clouderrorreporting/v1beta1/report_errors_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @report_errors_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the ReportErrorsService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.

See {::Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/error_reporting/v1beta1/report_errors_service/client.rb, line 90
def configure
  yield @config if block_given?
  @config
end
report_error_event(request, options = nil) { |response, operation| ... } click to toggle source

Report an individual error event and record the event to a log.

This endpoint accepts either an OAuth token, or an [API key](support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example:

`POST clouderrorreporting.googleapis.com/v1beta1/\{projectName}/events:report?key=123ABC456`

Note: [Error Reporting](/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects.

For more information, see [Using Error Reporting with regionalized logs](/error-reporting/docs/regionalization).

@overload report_error_event(request, options = nil)

Pass arguments to `report_error_event` via a request object, either of type
{::Google::Cloud::ErrorReporting::V1beta1::ReportErrorEventRequest} or an equivalent Hash.

@param request [::Google::Cloud::ErrorReporting::V1beta1::ReportErrorEventRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload report_error_event(project_name: nil, event: nil)

Pass arguments to `report_error_event` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param project_name [::String]
  Required. The resource name of the Google Cloud Platform project. Written
  as `projects/{projectId}`, where `{projectId}` is the
  [Google Cloud Platform project
  ID](https://support.google.com/cloud/answer/6158840).

  Example: // `projects/my-project-123`.
@param event [::Google::Cloud::ErrorReporting::V1beta1::ReportedErrorEvent, ::Hash]
  Required. The error event to be reported.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ErrorReporting::V1beta1::ReportErrorEventResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::ErrorReporting::V1beta1::ReportErrorEventResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/error_reporting/v1beta1/report_errors_service/client.rb, line 201
def report_error_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ErrorReporting::V1beta1::ReportErrorEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.report_error_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ErrorReporting::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "project_name" => request.project_name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.report_error_event.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.report_error_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @report_errors_service_stub.call_rpc :report_error_event, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end