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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v1/classes.rb,
generated/google/apis/monitoring_v1/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Dashboard

Returns a new instance of Dashboard.


254
255
256
# File 'generated/google/apis/monitoring_v1/classes.rb', line 254

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

Instance Attribute Details

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


220
221
222
# File 'generated/google/apis/monitoring_v1/classes.rb', line 220

def column_layout
  @column_layout
end

#display_nameString

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

Returns:

  • (String)

225
226
227
# File 'generated/google/apis/monitoring_v1/classes.rb', line 225

def display_name
  @display_name
end

#etagString

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)

235
236
237
# File 'generated/google/apis/monitoring_v1/classes.rb', line 235

def etag
  @etag
end

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


241
242
243
# File 'generated/google/apis/monitoring_v1/classes.rb', line 241

def grid_layout
  @grid_layout
end

#nameString

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

Returns:

  • (String)

246
247
248
# File 'generated/google/apis/monitoring_v1/classes.rb', line 246

def name
  @name
end

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


252
253
254
# File 'generated/google/apis/monitoring_v1/classes.rb', line 252

def row_layout
  @row_layout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


259
260
261
262
263
264
265
266
# File 'generated/google/apis/monitoring_v1/classes.rb', line 259

def update!(**args)
  @column_layout = args[:column_layout] if args.key?(:column_layout)
  @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)
  @name = args[:name] if args.key?(:name)
  @row_layout = args[:row_layout] if args.key?(:row_layout)
end