Class: Google::Cloud::Monitoring::MetricsScope::V1::MetricsScopes::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Monitoring::MetricsScope::V1::MetricsScopes::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb
Overview
Client for the MetricsScopes service.
Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#operations_client ⇒ ::Google::Cloud::Monitoring::MetricsScope::V1::MetricsScopes::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the MetricsScopes Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the MetricsScopes Client instance.
-
#create_monitored_project(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Adds a
MonitoredProject
with the given project ID to the specifiedMetrics Scope
. -
#delete_monitored_project(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a
MonitoredProject
from the specifiedMetrics Scope
. -
#get_metrics_scope(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::MetricsScope::V1::MetricsScope
Returns a specific
Metrics Scope
. -
#initialize {|config| ... } ⇒ Client
constructor
Create a new MetricsScopes client object.
-
#list_metrics_scopes_by_monitored_project(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::MetricsScope::V1::ListMetricsScopesByMonitoredProjectResponse
Returns a list of every
Metrics Scope
that a specificMonitoredProject
has been added to. -
#universe_domain ⇒ String
The effective universe domain.
Methods included from Paths
#metrics_scope_path, #monitored_project_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new MetricsScopes client object.
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 |
# File 'lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb', line 126 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/monitoring/metricsscope/v1/metrics_scopes_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.nil? || (@config.endpoint == Configuration::DEFAULT_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 @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @metrics_scopes_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Monitoring::MetricsScope::V1::MetricsScopes::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end |
Instance Attribute Details
#operations_client ⇒ ::Google::Cloud::Monitoring::MetricsScope::V1::MetricsScopes::Operations (readonly)
Get the associated client for long-running operations.
178 179 180 |
# File 'lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb', line 178 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the MetricsScopes Client class.
See Configuration for a description of the configuration fields.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb', line 64 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Monitoring", "MetricsScope", "V1"] 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 end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the MetricsScopes 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.
96 97 98 99 |
# File 'lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb', line 96 def configure yield @config if block_given? @config end |
#create_monitored_project(request, options = nil) ⇒ ::Gapic::Operation #create_monitored_project(parent: nil, monitored_project: nil) ⇒ ::Gapic::Operation
Adds a MonitoredProject
with the given project ID
to the specified Metrics Scope
.
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 |
# File 'lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb', line 412 def create_monitored_project request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::MetricsScope::V1::CreateMonitoredProjectRequest # 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.create_monitored_project..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Monitoring::MetricsScope::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_monitored_project.timeout, metadata: , retry_policy: @config.rpcs.create_monitored_project.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @metrics_scopes_stub.call_rpc :create_monitored_project, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_monitored_project(request, options = nil) ⇒ ::Gapic::Operation #delete_monitored_project(name: nil) ⇒ ::Gapic::Operation
Deletes a MonitoredProject
from the specified Metrics Scope
.
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 |
# File 'lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb', line 512 def delete_monitored_project request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::MetricsScope::V1::DeleteMonitoredProjectRequest # 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.delete_monitored_project..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Monitoring::MetricsScope::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_monitored_project.timeout, metadata: , retry_policy: @config.rpcs.delete_monitored_project.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @metrics_scopes_stub.call_rpc :delete_monitored_project, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_metrics_scope(request, options = nil) ⇒ ::Google::Cloud::Monitoring::MetricsScope::V1::MetricsScope #get_metrics_scope(name: nil) ⇒ ::Google::Cloud::Monitoring::MetricsScope::V1::MetricsScope
Returns a specific Metrics Scope
.
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb', line 228 def get_metrics_scope request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::MetricsScope::V1::GetMetricsScopeRequest # 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_metrics_scope..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Monitoring::MetricsScope::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_metrics_scope.timeout, metadata: , retry_policy: @config.rpcs.get_metrics_scope.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @metrics_scopes_stub.call_rpc :get_metrics_scope, 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 |
#list_metrics_scopes_by_monitored_project(request, options = nil) ⇒ ::Google::Cloud::Monitoring::MetricsScope::V1::ListMetricsScopesByMonitoredProjectResponse #list_metrics_scopes_by_monitored_project(monitored_resource_container: nil) ⇒ ::Google::Cloud::Monitoring::MetricsScope::V1::ListMetricsScopesByMonitoredProjectResponse
Returns a list of every Metrics Scope
that a specific MonitoredProject
has been added to. The metrics scope representing the specified monitored
project will always be the first entry in the response.
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb', line 318 def list_metrics_scopes_by_monitored_project request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::MetricsScope::V1::ListMetricsScopesByMonitoredProjectRequest # 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.list_metrics_scopes_by_monitored_project..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Monitoring::MetricsScope::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_metrics_scopes_by_monitored_project.timeout, metadata: , retry_policy: @config.rpcs.list_metrics_scopes_by_monitored_project.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @metrics_scopes_stub.call_rpc :list_metrics_scopes_by_monitored_project, 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 |
#universe_domain ⇒ String
The effective universe domain
106 107 108 |
# File 'lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb', line 106 def universe_domain @metrics_scopes_stub.universe_domain end |