Class: Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb
Overview
Client for the DashboardsService service.
Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the DashboardsService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the DashboardsService Client instance.
-
#create_dashboard(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard
Creates a new custom dashboard.
-
#delete_dashboard(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an existing custom dashboard.
-
#get_dashboard(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard
Fetches a specific dashboard.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new DashboardsService client object.
-
#list_dashboards(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::Dashboard::V1::Dashboard>
Lists the existing dashboards.
-
#update_dashboard(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard
Replaces an existing custom dashboard with a new definition.
Methods included from Paths
#alert_policy_path, #dashboard_path, #project_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new DashboardsService client object.
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 |
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_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/monitoring/dashboard/v1/dashboards_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 @dashboards_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the DashboardsService Client class.
See Configuration for a description of the configuration fields.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 58 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Monitoring", "Dashboard", "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.timeout = 30.0 default_config.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 2] } default_config.rpcs.create_dashboard.timeout = 30.0 default_config.rpcs.delete_dashboard.timeout = 30.0 default_config.rpcs.update_dashboard.timeout = 30.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the DashboardsService 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.
101 102 103 104 |
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 101 def configure yield @config if block_given? @config end |
#create_dashboard(request, options = nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard #create_dashboard(parent: nil, dashboard: nil, validate_only: nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard
Creates a new custom dashboard. For examples on how you can use this API to
create dashboards, see Managing dashboards by
API. This
method requires the monitoring.dashboards.create
permission on the
specified project. For more information about permissions, see Cloud
Identity and Access Management.
218 219 220 221 222 223 224 225 226 227 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 |
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 218 def create_dashboard request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::Dashboard::V1::CreateDashboardRequest # 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_dashboard..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::Monitoring::Dashboard::V1::VERSION [:"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_dashboard.timeout, metadata: , retry_policy: @config.rpcs.create_dashboard.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @dashboards_service_stub.call_rpc :create_dashboard, 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 |
#delete_dashboard(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_dashboard(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes an existing custom dashboard.
This method requires the monitoring.dashboards.delete
permission
on the specified dashboard. For more information, see
Cloud Identity and Access Management.
507 508 509 510 511 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 |
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 507 def delete_dashboard request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::Dashboard::V1::DeleteDashboardRequest # 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_dashboard..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::Monitoring::Dashboard::V1::VERSION [:"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_dashboard.timeout, metadata: , retry_policy: @config.rpcs.delete_dashboard.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @dashboards_service_stub.call_rpc :delete_dashboard, 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 |
#get_dashboard(request, options = nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard #get_dashboard(name: nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard
Fetches a specific dashboard.
This method requires the monitoring.dashboards.get
permission
on the specified dashboard. For more information, see
Cloud Identity and Access Management.
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 454 455 |
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 416 def get_dashboard request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::Dashboard::V1::GetDashboardRequest # 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_dashboard..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::Monitoring::Dashboard::V1::VERSION [:"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_dashboard.timeout, metadata: , retry_policy: @config.rpcs.get_dashboard.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @dashboards_service_stub.call_rpc :get_dashboard, 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_dashboards(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::Dashboard::V1::Dashboard> #list_dashboards(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::Dashboard::V1::Dashboard>
Lists the existing dashboards.
This method requires the monitoring.dashboards.list
permission
on the specified project. For more information, see
Cloud Identity and Access Management.
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 351 352 353 354 355 356 357 358 359 360 361 362 |
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 322 def list_dashboards request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::Dashboard::V1::ListDashboardsRequest # 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_dashboards..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::Monitoring::Dashboard::V1::VERSION [:"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.list_dashboards.timeout, metadata: , retry_policy: @config.rpcs.list_dashboards.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @dashboards_service_stub.call_rpc :list_dashboards, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @dashboards_service_stub, :list_dashboards, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#update_dashboard(request, options = nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard #update_dashboard(dashboard: nil, validate_only: nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard
Replaces an existing custom dashboard with a new definition.
This method requires the monitoring.dashboards.update
permission
on the specified dashboard. For more information, see
Cloud Identity and Access Management.
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 |
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 599 def update_dashboard request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::Dashboard::V1::UpdateDashboardRequest # 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_dashboard..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::Monitoring::Dashboard::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.dashboard&.name header_params["dashboard.name"] = request.dashboard.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.update_dashboard.timeout, metadata: , retry_policy: @config.rpcs.update_dashboard.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @dashboards_service_stub.call_rpc :update_dashboard, 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 |