Class: Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Paths

#alert_policy_path, #dashboard_path, #project_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new DashboardsService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the DashboardsService client.

Yield Parameters:



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.

Examples:


# Modify the configuration for all DashboardsService clients
::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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.

Overloads:

  • #create_dashboard(request, options = nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard

    Pass arguments to create_dashboard via a request object, either of type CreateDashboardRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Monitoring::Dashboard::V1::CreateDashboardRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_dashboard(parent: nil, dashboard: nil, validate_only: nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard

    Pass arguments to create_dashboard 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project on which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]

      The [PROJECT_ID_OR_NUMBER] must match the dashboard resource name.

    • dashboard (::Google::Cloud::Monitoring::Dashboard::V1::Dashboard, ::Hash) (defaults to: nil) —

      Required. The initial dashboard specification.

    • validate_only (::Boolean) (defaults to: nil) —

      If set, validate the request and preview the review, but do not actually save it.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



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
231
232
233
234
235
236
 
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 199

def create_dashboard request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_dashboard.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::Monitoring::Dashboard::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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.create_dashboard.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_dashboard.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dashboards_service_stub.call_rpc :create_dashboard, 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

#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.

Overloads:

  • #delete_dashboard(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_dashboard via a request object, either of type Google::Cloud::Monitoring::Dashboard::V1::DeleteDashboardRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Monitoring::Dashboard::V1::DeleteDashboardRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_dashboard(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_dashboard 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name of the Dashboard. The format is:

      projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



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
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 431

def delete_dashboard request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_dashboard.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::Monitoring::Dashboard::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.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.delete_dashboard.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_dashboard.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dashboards_service_stub.call_rpc :delete_dashboard, 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

#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.

Overloads:

  • #get_dashboard(request, options = nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard

    Pass arguments to get_dashboard via a request object, either of type GetDashboardRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Monitoring::Dashboard::V1::GetDashboardRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_dashboard(name: nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard

    Pass arguments to get_dashboard 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name of the Dashboard. The format is one of:

      • dashboards/[DASHBOARD_ID] (for system dashboards)
      • projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] (for custom dashboards).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 357

def get_dashboard request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_dashboard.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::Monitoring::Dashboard::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.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_dashboard.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_dashboard.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dashboards_service_stub.call_rpc :get_dashboard, 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

#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.

Overloads:

  • #list_dashboards(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::Dashboard::V1::Dashboard>

    Pass arguments to list_dashboards via a request object, either of type ListDashboardsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Monitoring::Dashboard::V1::ListDashboardsRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_dashboards(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::Dashboard::V1::Dashboard>

    Pass arguments to list_dashboards 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The scope of the dashboards to list. The format is:

      projects/[PROJECT_ID_OR_NUMBER]
    • page_size (::Integer) (defaults to: nil) —

      A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.

    • page_token (::String) (defaults to: nil) —

      If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 280

def list_dashboards request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_dashboards.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::Monitoring::Dashboard::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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.list_dashboards.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_dashboards.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dashboards_service_stub.call_rpc :list_dashboards, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dashboards_service_stub, :list_dashboards, request, response, operation, options
    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.

Overloads:

  • #update_dashboard(request, options = nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard

    Pass arguments to update_dashboard via a request object, either of type UpdateDashboardRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Monitoring::Dashboard::V1::UpdateDashboardRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_dashboard(dashboard: nil, validate_only: nil) ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard

    Pass arguments to update_dashboard 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).

    Parameters:

    • dashboard (::Google::Cloud::Monitoring::Dashboard::V1::Dashboard, ::Hash) (defaults to: nil) —

      Required. The dashboard that will replace the existing dashboard.

    • validate_only (::Boolean) (defaults to: nil) —

      If set, validate the request and preview the review, but do not actually save it.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



506
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
 
# File 'lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb', line 506

def update_dashboard request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_dashboard.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::Monitoring::Dashboard::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "dashboard.name" => request.dashboard.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_dashboard.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_dashboard.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dashboards_service_stub.call_rpc :update_dashboard, 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