Class: Google::Apis::MonitoringV1::Widget

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

Widget contains a single dashboard component and configuration of how to present the component in the dashboard.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Widget

Returns a new instance of Widget.



3127
3128
3129
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3127

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

Instance Attribute Details

#alert_chart ⇒ Google::Apis::MonitoringV1::AlertChart

A chart that displays alert policy data. Corresponds to the JSON property alertChart

Returns:



3030
3031
3032
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3030

def alert_chart
  @alert_chart
end

#blank ⇒ Google::Apis::MonitoringV1::Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo rpc Bar(google. protobuf.Empty) returns (google.protobuf.Empty); Corresponds to the JSON property blank

Returns:



3038
3039
3040
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3038

def blank
  @blank
end

#collapsible_group ⇒ Google::Apis::MonitoringV1::CollapsibleGroup

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. Corresponds to the JSON property collapsibleGroup

Returns:



3044
3045
3046
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3044

def collapsible_group
  @collapsible_group
end

#error_reporting_panel ⇒ Google::Apis::MonitoringV1::ErrorReportingPanel

A widget that displays a list of error groups. Corresponds to the JSON property errorReportingPanel

Returns:



3049
3050
3051
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3049

def error_reporting_panel
  @error_reporting_panel
end

#filter_control ⇒ Google::Apis::MonitoringV1::FilterControl

A widget that displays an input field to change the value of a template variable. Corresponds to the JSON property filterControl

Returns:



3055
3056
3057
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3055

def filter_control
  @filter_control
end

#id ⇒ String

Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. Corresponds to the JSON property id

Returns:

  • (String) 


3061
3062
3063
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3061

def id
  @id
end

#incident_list ⇒ Google::Apis::MonitoringV1::IncidentList

A widget that displays a list of incidents Corresponds to the JSON property incidentList

Returns:



3066
3067
3068
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3066

def incident_list
  @incident_list
end

#logs_panel ⇒ Google::Apis::MonitoringV1::LogsPanel

A widget that displays a stream of log. Corresponds to the JSON property logsPanel

Returns:



3071
3072
3073
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3071

def logs_panel
  @logs_panel
end

#pie_chart ⇒ Google::Apis::MonitoringV1::PieChart

A widget that displays timeseries data as a pie or a donut. Corresponds to the JSON property pieChart

Returns:



3076
3077
3078
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3076

def pie_chart
  @pie_chart
end

#scorecard ⇒ Google::Apis::MonitoringV1::Scorecard

A widget showing the latest value of a metric, and how this value relates to one or more thresholds. Corresponds to the JSON property scorecard

Returns:



3082
3083
3084
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3082

def scorecard
  @scorecard
end

#section_header ⇒ Google::Apis::MonitoringV1::SectionHeader

A widget that defines a new section header. Sections populate a table of contents and allow easier navigation of long-form content. Corresponds to the JSON property sectionHeader

Returns:



3088
3089
3090
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3088

def section_header
  @section_header
end

#single_view_group ⇒ Google::Apis::MonitoringV1::SingleViewGroup

A widget that groups the other widgets by using a dropdown menu. All widgets that are within the area spanned by the grouping widget are considered member widgets. Corresponds to the JSON property singleViewGroup

Returns:



3095
3096
3097
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3095

def single_view_group
  @single_view_group
end

#text ⇒ Google::Apis::MonitoringV1::Text

A widget that displays textual content. Corresponds to the JSON property text

Returns:



3100
3101
3102
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3100

def text
  @text
end

#time_series_table ⇒ Google::Apis::MonitoringV1::TimeSeriesTable

A table that displays time series data. Corresponds to the JSON property timeSeriesTable

Returns:



3105
3106
3107
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3105

def time_series_table
  @time_series_table
end

#title ⇒ String

Optional. The title of the widget. Corresponds to the JSON property title

Returns:

  • (String) 


3110
3111
3112
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3110

def title
  @title
end

#treemap ⇒ Google::Apis::MonitoringV1::Treemap

A widget that displays hierarchical data as a treemap. Corresponds to the JSON property treemap

Returns:



3115
3116
3117
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3115

def treemap
  @treemap
end

#visibility_condition ⇒ Google::Apis::MonitoringV1::VisibilityCondition

Condition that determines whether the widget should be displayed. Corresponds to the JSON property visibilityCondition

Returns:



3120
3121
3122
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3120

def visibility_condition
  @visibility_condition
end

#xy_chart ⇒ Google::Apis::MonitoringV1::XyChart

A chart that displays data on a 2D (X and Y axes) plane. Corresponds to the JSON property xyChart

Returns:



3125
3126
3127
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3125

def xy_chart
  @xy_chart
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 3132

def update!(**args)
  @alert_chart = args[:alert_chart] if args.key?(:alert_chart)
  @blank = args[:blank] if args.key?(:blank)
  @collapsible_group = args[:collapsible_group] if args.key?(:collapsible_group)
  @error_reporting_panel = args[:error_reporting_panel] if args.key?(:error_reporting_panel)
  @filter_control = args[:filter_control] if args.key?(:filter_control)
  @id = args[:id] if args.key?(:id)
  @incident_list = args[:incident_list] if args.key?(:incident_list)
  @logs_panel = args[:logs_panel] if args.key?(:logs_panel)
  @pie_chart = args[:pie_chart] if args.key?(:pie_chart)
  @scorecard = args[:scorecard] if args.key?(:scorecard)
  @section_header = args[:section_header] if args.key?(:section_header)
  @single_view_group = args[:single_view_group] if args.key?(:single_view_group)
  @text = args[:text] if args.key?(:text)
  @time_series_table = args[:time_series_table] if args.key?(:time_series_table)
  @title = args[:title] if args.key?(:title)
  @treemap = args[:treemap] if args.key?(:treemap)
  @visibility_condition = args[:visibility_condition] if args.key?(:visibility_condition)
  @xy_chart = args[:xy_chart] if args.key?(:xy_chart)
end