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.



312
313
314
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 312

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

Instance Attribute Details

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



261
262
263
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 261

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:



266
267
268
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 266

def dashboard_filters
  @dashboard_filters
end

#display_name ⇒ String

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

Returns:

  • (String) 


271
272
273
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 271

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) 


281
282
283
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 281

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:



287
288
289
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 287

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>) 


292
293
294
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 292

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:



299
300
301
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 299

def mosaic_layout
  @mosaic_layout
end

#name ⇒ String

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

Returns:

  • (String) 


304
305
306
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 304

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:



310
311
312
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 310

def row_layout
  @row_layout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 317

def update!(**args)
  @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