# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# EDITING INSTRUCTIONS
# This file was generated from the file
# https://github.com/googleapis/googleapis/blob/master/google/devtools/clouderrorreporting/v1beta1/error_group_service.proto,
# and updates to that file get reflected here through a refresh process.
# For the short term, the refresh process will only be runnable by Google
# engineers.
require "json"
require "pathname"
require "google/gax"
require "google/devtools/clouderrorreporting/v1beta1/error_group_service_pb"
require "google/cloud/error_reporting/v1beta1/credentials"
require "google/cloud/error_reporting/version"
module Google
module Cloud
module ErrorReporting
module V1beta1
# Service for retrieving and updating individual error groups.
#
# @!attribute [r] error_group_service_stub
# @return [Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroupService::Stub]
class ErrorGroupServiceClient
# @private
attr_reader :error_group_service_stub
# The default address of the service.
SERVICE_ADDRESS = "clouderrorreporting.googleapis.com".freeze
# The default port of the service.
DEFAULT_SERVICE_PORT = 443
# The default set of gRPC interceptors.
GRPC_INTERCEPTORS = []
DEFAULT_TIMEOUT = 30
# The scopes needed to make gRPC calls to all of the methods defined in
# this service.
ALL_SCOPES = [
"https://www.googleapis.com/auth/cloud-platform"
].freeze
GROUP_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
"projects/{project}/groups/{group}"
)
private_constant :GROUP_PATH_TEMPLATE
# Returns a fully-qualified group resource name string.
# @param project [String]
# @param group [String]
# @return [String]
def self.group_path project, group
GROUP_PATH_TEMPLATE.render(
:"project" => project,
:"group" => group
)
end
# @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
# 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.
# @param scopes [Array<String>]
# The OAuth scopes for this service. This parameter is ignored if
# an updater_proc is supplied.
# @param client_config [Hash]
# 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.
# @param timeout [Numeric]
# The default timeout, in seconds, for calls made through this client.
# @param metadata [Hash]
# Default metadata to be sent with each request. This can be overridden on a per call basis.
# @param service_address [String]
# Override for the service hostname, or `nil` to leave as the default.
# @param service_port [Integer]
# Override for the service port, or `nil` to leave as the default.
# @param exception_transformer [Proc]
# An optional proc that intercepts any exceptions raised during an API call to inject
# custom error handling.
def initialize \
credentials: nil,
scopes: ALL_SCOPES,
client_config: {},
timeout: DEFAULT_TIMEOUT,
metadata: nil,
service_address: nil,
service_port: 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_group_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 = Google::Cloud::ErrorReporting::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_group_service_client_config.json"
)
defaults = client_config_file.open do |f|
Google::Gax.construct_settings(
"google.devtools.clouderrorreporting.v1beta1.ErrorGroupService",
JSON.parse(f.read),
client_config,
Google::Gax::Grpc::STATUS_CODE_NAMES,
timeout,
errors: Google::Gax::Grpc::API_ERRORS,
metadata: headers
)
end
# Allow overriding the service path/port in subclasses.
service_path = service_address || self.class::SERVICE_ADDRESS
port = service_port || self.class::DEFAULT_SERVICE_PORT
interceptors = self.class::GRPC_INTERCEPTORS
@error_group_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::ErrorGroupService::Stub.method(:new)
)
@get_group = Google::Gax.create_api_call(
@error_group_service_stub.method(:get_group),
defaults["get_group"],
exception_transformer: exception_transformer,
params_extractor: proc do |request|
{'group_name' => request.group_name}
end
)
@update_group = Google::Gax.create_api_call(
@error_group_service_stub.method(:update_group),
defaults["update_group"],
exception_transformer: exception_transformer,
params_extractor: proc do |request|
{'group.name' => request.group.name}
end
)
end
# Service calls
# Get the specified group.
#
# @param group_name [String]
# [Required] The group resource name. Written as
# <code>projects/<var>projectID</var>/groups/<var>group_name</var></code>.
# Call
# <a href="/error-reporting/reference/rest/v1beta1/projects.groupStats/list">
# <code>groupStats.list</code></a> to return a list of groups belonging to
# this project.
#
# Example: <code>projects/my-project-123/groups/my-group</code>
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup]
# @yieldparam operation [GRPC::ActiveCall::Operation]
# @return [Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup]
# @raise [Google::Gax::GaxError] if the RPC is aborted.
# @example
# require "google/cloud/error_reporting"
#
# error_group_client = Google::Cloud::ErrorReporting::ErrorGroup.new(version: :v1beta1)
# formatted_group_name = Google::Cloud::ErrorReporting::V1beta1::ErrorGroupServiceClient.group_path("[PROJECT]", "[GROUP]")
# response = error_group_client.get_group(formatted_group_name)
def get_group \
group_name,
options: nil,
&block
req = {
group_name: group_name
}.delete_if { |_, v| v.nil? }
req = Google::Gax::to_proto(req, Google::Devtools::Clouderrorreporting::V1beta1::GetGroupRequest)
@get_group.call(req, options, &block)
end
# Replace the data for the specified group.
# Fails if the group does not exist.
#
# @param group [Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup | Hash]
# [Required] The group which replaces the resource on the server.
# A hash of the same form as `Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup`
# can also be provided.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup]
# @yieldparam operation [GRPC::ActiveCall::Operation]
# @return [Google::Devtools::Clouderrorreporting::V1beta1::ErrorGroup]
# @raise [Google::Gax::GaxError] if the RPC is aborted.
# @example
# require "google/cloud/error_reporting"
#
# error_group_client = Google::Cloud::ErrorReporting::ErrorGroup.new(version: :v1beta1)
#
# # TODO: Initialize `group`:
# group = {}
# response = error_group_client.update_group(group)
def update_group \
group,
options: nil,
&block
req = {
group: group
}.delete_if { |_, v| v.nil? }
req = Google::Gax::to_proto(req, Google::Devtools::Clouderrorreporting::V1beta1::UpdateGroupRequest)
@update_group.call(req, options, &block)
end
end
end
end
end
end