class Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client
Client
for the ErrorGroupService
service.
Service
for retrieving and updating individual error groups.
Attributes
@private
Public Class Methods
Configure the ErrorGroupService
Client
class.
See {::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all ErrorGroupService clients ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::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/error_group_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.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config end yield @configure if block_given? @configure end
Create a new ErrorGroupService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the ErrorGroupService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/error_reporting/v1beta1/error_group_service/client.rb, line 114 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/error_group_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 @error_group_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the ErrorGroupService
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::ErrorGroupService::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/error_group_service/client.rb, line 93 def configure yield @config if block_given? @config end
Get the specified group.
@overload get_group
(request, options = nil)
Pass arguments to `get_group` via a request object, either of type {::Google::Cloud::ErrorReporting::V1beta1::GetGroupRequest} or an equivalent Hash. @param request [::Google::Cloud::ErrorReporting::V1beta1::GetGroupRequest, ::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 get_group
(group_name: nil)
Pass arguments to `get_group` 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 group_name [::String] Required. The group resource name. Written as `projects/{projectID}/groups/{group_name}`. Call [`groupStats.list`](https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.groupStats/list) to return a list of groups belonging to this project. Example: `projects/my-project-123/groups/my-group`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/error_reporting/v1beta1/error_group_service/client.rb, line 186 def get_group request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ErrorReporting::V1beta1::GetGroupRequest # 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.get_group.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 = { "group_name" => request.group_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.get_group.timeout, metadata: metadata, retry_policy: @config.rpcs.get_group.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @error_group_service_stub.call_rpc :get_group, 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
Replace the data for the specified group. Fails if the group does not exist.
@overload update_group
(request, options = nil)
Pass arguments to `update_group` via a request object, either of type {::Google::Cloud::ErrorReporting::V1beta1::UpdateGroupRequest} or an equivalent Hash. @param request [::Google::Cloud::ErrorReporting::V1beta1::UpdateGroupRequest, ::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 update_group
(group: nil)
Pass arguments to `update_group` 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 group [::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup, ::Hash] Required. The group which replaces the resource on the server.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/error_reporting/v1beta1/error_group_service/client.rb, line 255 def update_group request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ErrorReporting::V1beta1::UpdateGroupRequest # 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.update_group.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 = { "group.name" => request.group.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.update_group.timeout, metadata: metadata, retry_policy: @config.rpcs.update_group.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @error_group_service_stub.call_rpc :update_group, 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