Class: Google::Apis::MonitoringV1::Dashboard

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/monitoring_v1/classes.rb,
lib/google/apis/monitoring_v1/representations.rb,
lib/google/apis/monitoring_v1/representations.rb

Overview

A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Dashboard

Returns a new instance of Dashboard.



431
432
433
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 431

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotations ⇒ Google::Apis::MonitoringV1::DashboardAnnotations

Dashboard-level configuration for annotations Corresponds to the JSON property annotations

Returns:



374
375
376
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 374

def annotations
  @annotations
end

#column_layout ⇒ Google::Apis::MonitoringV1::ColumnLayout

A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column. Corresponds to the JSON property columnLayout

Returns:



380
381
382
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 380

def column_layout
  @column_layout
end

#dashboard_filters ⇒ Array<Google::Apis::MonitoringV1::DashboardFilter>

Filters to reduce the amount of data charted based on the filter criteria. Corresponds to the JSON property dashboardFilters

Returns:



385
386
387
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 385

def dashboard_filters
  @dashboard_filters
end

#display_name ⇒ String

Required. The mutable, human-readable name. Corresponds to the JSON property displayName

Returns:

  • (String) 


390
391
392
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 390

def display_name
  @display_name
end

#etag ⇒ String

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. An etag is returned in the response to GetDashboard, and users are expected to put that etag in the request to UpdateDashboard to ensure that their change will be applied to the same version of the Dashboard configuration. The field should not be passed during dashboard creation. Corresponds to the JSON property etag

Returns:

  • (String) 


400
401
402
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 400

def etag
  @etag
end

#grid_layout ⇒ Google::Apis::MonitoringV1::GridLayout

A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy. Corresponds to the JSON property gridLayout

Returns:



406
407
408
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 406

def grid_layout
  @grid_layout
end

#labels ⇒ Hash<String,String>

Labels applied to the dashboard Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


411
412
413
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 411

def labels
  @labels
end

#mosaic_layout ⇒ Google::Apis::MonitoringV1::MosaicLayout

A mosaic layout divides the available space into a grid of blocks, and overlays the grid with tiles. Unlike GridLayout, tiles may span multiple grid blocks and can be placed at arbitrary locations in the grid. Corresponds to the JSON property mosaicLayout

Returns:



418
419
420
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 418

def mosaic_layout
  @mosaic_layout
end

#name ⇒ String

Identifier. The resource name of the dashboard. Corresponds to the JSON property name

Returns:

  • (String) 


423
424
425
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 423

def name
  @name
end

#row_layout ⇒ Google::Apis::MonitoringV1::RowLayout

A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row. Corresponds to the JSON property rowLayout

Returns:



429
430
431
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 429

def row_layout
  @row_layout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 436

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @column_layout = args[:column_layout] if args.key?(:column_layout)
  @dashboard_filters = args[:dashboard_filters] if args.key?(:dashboard_filters)
  @display_name = args[:display_name] if args.key?(:display_name)
  @etag = args[:etag] if args.key?(:etag)
  @grid_layout = args[:grid_layout] if args.key?(:grid_layout)
  @labels = args[:labels] if args.key?(:labels)
  @mosaic_layout = args[:mosaic_layout] if args.key?(:mosaic_layout)
  @name = args[:name] if args.key?(:name)
  @row_layout = args[:row_layout] if args.key?(:row_layout)
end