Class: Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/error_reporting/v1beta1/error_group_service/client.rb
Overview
Client for the ErrorGroupService service.
Service for retrieving and updating individual error groups.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the ErrorGroupService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the ErrorGroupService Client instance.
-
#get_group(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup
Get the specified group.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new ErrorGroupService client object.
-
#update_group(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup
Replace the data for the specified group.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new ErrorGroupService client object.
Examples
To create a new ErrorGroupService client with the default configuration:
client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new
To create a new ErrorGroupService client with a custom configuration:
client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new do |config|
config.timeout = 10.0
end
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 |
# File 'lib/google/cloud/error_reporting/v1beta1/error_group_service/client.rb', line 122 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 scope and endpoint are unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.scope == Client.configure.scope && @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 |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the ErrorGroupService Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all ErrorGroupService clients:
::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.configure do |config|
config.timeout = 10.0
end
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/google/cloud/error_reporting/v1beta1/error_group_service/client.rb', line 57 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 |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
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 configure.
See Configuration for a description of the configuration fields.
97 98 99 100 |
# File 'lib/google/cloud/error_reporting/v1beta1/error_group_service/client.rb', line 97 def configure yield @config if block_given? @config end |
#get_group(request, options = nil) ⇒ ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup #get_group(group_name: nil) ⇒ ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup
Get the specified group.
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/google/cloud/error_reporting/v1beta1/error_group_service/client.rb', line 195 def get_group request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_group..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_group.timeout, metadata: , retry_policy: @config.rpcs.get_group.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @error_group_service_stub.call_rpc :get_group, request, 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 |
#update_group(request, options = nil) ⇒ ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup #update_group(group: nil) ⇒ ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroup
Replace the data for the specified group. Fails if the group does not exist.
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 |
# File 'lib/google/cloud/error_reporting/v1beta1/error_group_service/client.rb', line 262 def update_group request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_group..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_group.timeout, metadata: , retry_policy: @config.rpcs.update_group.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @error_group_service_stub.call_rpc :update_group, request, 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 |