Cloud Monitoring Dashboards V1 API - Class Google::Cloud::Monitoring::Dashboard::V1::Widget (v1.2.1)

Reference documentation and code samples for the Cloud Monitoring Dashboards V1 API class Google::Cloud::Monitoring::Dashboard::V1::Widget.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#alert_chart

def alert_chart() -> ::Google::Cloud::Monitoring::Dashboard::V1::AlertChart
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::AlertChart) — A chart of alert policy data.

    Note: The following fields are mutually exclusive: alert_chart, xy_chart, scorecard, text, blank, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#alert_chart=

def alert_chart=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::AlertChart
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::AlertChart) — A chart of alert policy data.

    Note: The following fields are mutually exclusive: alert_chart, xy_chart, scorecard, text, blank, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::AlertChart) — A chart of alert policy data.

    Note: The following fields are mutually exclusive: alert_chart, xy_chart, scorecard, text, blank, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#blank

def blank() -> ::Google::Protobuf::Empty
Returns
  • (::Google::Protobuf::Empty) — A blank space.

    Note: The following fields are mutually exclusive: blank, xy_chart, scorecard, text, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#blank=

def blank=(value) -> ::Google::Protobuf::Empty
Parameter
  • value (::Google::Protobuf::Empty) — A blank space.

    Note: The following fields are mutually exclusive: blank, xy_chart, scorecard, text, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Empty) — A blank space.

    Note: The following fields are mutually exclusive: blank, xy_chart, scorecard, text, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#collapsible_group

def collapsible_group() -> ::Google::Cloud::Monitoring::Dashboard::V1::CollapsibleGroup
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::CollapsibleGroup) — A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

    Note: The following fields are mutually exclusive: collapsible_group, xy_chart, scorecard, text, blank, alert_chart, time_series_table, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#collapsible_group=

def collapsible_group=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::CollapsibleGroup
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::CollapsibleGroup) — A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

    Note: The following fields are mutually exclusive: collapsible_group, xy_chart, scorecard, text, blank, alert_chart, time_series_table, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::CollapsibleGroup) — A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

    Note: The following fields are mutually exclusive: collapsible_group, xy_chart, scorecard, text, blank, alert_chart, time_series_table, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#error_reporting_panel

def error_reporting_panel() -> ::Google::Monitoring::Dashboard::V1::ErrorReportingPanel
Returns
  • (::Google::Monitoring::Dashboard::V1::ErrorReportingPanel) — A widget that displays a list of error groups.

    Note: The following fields are mutually exclusive: error_reporting_panel, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#error_reporting_panel=

def error_reporting_panel=(value) -> ::Google::Monitoring::Dashboard::V1::ErrorReportingPanel
Parameter
  • value (::Google::Monitoring::Dashboard::V1::ErrorReportingPanel) — A widget that displays a list of error groups.

    Note: The following fields are mutually exclusive: error_reporting_panel, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Monitoring::Dashboard::V1::ErrorReportingPanel) — A widget that displays a list of error groups.

    Note: The following fields are mutually exclusive: error_reporting_panel, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#id

def id() -> ::String
Returns
  • (::String) — Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional.
Returns
  • (::String) — Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional.

#incident_list

def incident_list() -> ::Google::Cloud::Monitoring::Dashboard::V1::IncidentList
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::IncidentList) — A widget that shows list of incidents.

    Note: The following fields are mutually exclusive: incident_list, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#incident_list=

def incident_list=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::IncidentList
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::IncidentList) — A widget that shows list of incidents.

    Note: The following fields are mutually exclusive: incident_list, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::IncidentList) — A widget that shows list of incidents.

    Note: The following fields are mutually exclusive: incident_list, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#logs_panel

def logs_panel() -> ::Google::Cloud::Monitoring::Dashboard::V1::LogsPanel
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::LogsPanel) — A widget that shows a stream of logs.

    Note: The following fields are mutually exclusive: logs_panel, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#logs_panel=

def logs_panel=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::LogsPanel
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::LogsPanel) — A widget that shows a stream of logs.

    Note: The following fields are mutually exclusive: logs_panel, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::LogsPanel) — A widget that shows a stream of logs.

    Note: The following fields are mutually exclusive: logs_panel, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#pie_chart

def pie_chart() -> ::Google::Cloud::Monitoring::Dashboard::V1::PieChart
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::PieChart) — A widget that displays timeseries data as a pie chart.

    Note: The following fields are mutually exclusive: pie_chart, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#pie_chart=

def pie_chart=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::PieChart
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::PieChart) — A widget that displays timeseries data as a pie chart.

    Note: The following fields are mutually exclusive: pie_chart, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::PieChart) — A widget that displays timeseries data as a pie chart.

    Note: The following fields are mutually exclusive: pie_chart, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#scorecard

def scorecard() -> ::Google::Cloud::Monitoring::Dashboard::V1::Scorecard
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::Scorecard) — A scorecard summarizing time series data.

    Note: The following fields are mutually exclusive: scorecard, xy_chart, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#scorecard=

def scorecard=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::Scorecard
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::Scorecard) — A scorecard summarizing time series data.

    Note: The following fields are mutually exclusive: scorecard, xy_chart, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::Scorecard) — A scorecard summarizing time series data.

    Note: The following fields are mutually exclusive: scorecard, xy_chart, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#section_header

def section_header() -> ::Google::Cloud::Monitoring::Dashboard::V1::SectionHeader
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::SectionHeader) — A widget that defines a section header for easier navigation of the dashboard.

    Note: The following fields are mutually exclusive: section_header, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#section_header=

def section_header=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::SectionHeader
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::SectionHeader) — A widget that defines a section header for easier navigation of the dashboard.

    Note: The following fields are mutually exclusive: section_header, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::SectionHeader) — A widget that defines a section header for easier navigation of the dashboard.

    Note: The following fields are mutually exclusive: section_header, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#single_view_group

def single_view_group() -> ::Google::Cloud::Monitoring::Dashboard::V1::SingleViewGroup
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::SingleViewGroup) — A widget that groups the other widgets by using a dropdown menu.

    Note: The following fields are mutually exclusive: single_view_group, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header. If a field in that set is populated, all other fields in the set will automatically be cleared.

#single_view_group=

def single_view_group=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::SingleViewGroup
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::SingleViewGroup) — A widget that groups the other widgets by using a dropdown menu.

    Note: The following fields are mutually exclusive: single_view_group, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::SingleViewGroup) — A widget that groups the other widgets by using a dropdown menu.

    Note: The following fields are mutually exclusive: single_view_group, xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text

def text() -> ::Google::Cloud::Monitoring::Dashboard::V1::Text
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::Text) — A raw string or markdown displaying textual content.

    Note: The following fields are mutually exclusive: text, xy_chart, scorecard, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text=

def text=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::Text
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::Text) — A raw string or markdown displaying textual content.

    Note: The following fields are mutually exclusive: text, xy_chart, scorecard, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::Text) — A raw string or markdown displaying textual content.

    Note: The following fields are mutually exclusive: text, xy_chart, scorecard, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#time_series_table

def time_series_table() -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesTable
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesTable) — A widget that displays time series data in a tabular format.

    Note: The following fields are mutually exclusive: time_series_table, xy_chart, scorecard, text, blank, alert_chart, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#time_series_table=

def time_series_table=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesTable
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesTable) — A widget that displays time series data in a tabular format.

    Note: The following fields are mutually exclusive: time_series_table, xy_chart, scorecard, text, blank, alert_chart, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesTable) — A widget that displays time series data in a tabular format.

    Note: The following fields are mutually exclusive: time_series_table, xy_chart, scorecard, text, blank, alert_chart, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#title

def title() -> ::String
Returns
  • (::String) — Optional. The title of the widget.

#title=

def title=(value) -> ::String
Parameter
  • value (::String) — Optional. The title of the widget.
Returns
  • (::String) — Optional. The title of the widget.

#xy_chart

def xy_chart() -> ::Google::Cloud::Monitoring::Dashboard::V1::XyChart
Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::XyChart) — A chart of time series data.

    Note: The following fields are mutually exclusive: xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

#xy_chart=

def xy_chart=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::XyChart
Parameter
  • value (::Google::Cloud::Monitoring::Dashboard::V1::XyChart) — A chart of time series data.

    Note: The following fields are mutually exclusive: xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::Dashboard::V1::XyChart) — A chart of time series data.

    Note: The following fields are mutually exclusive: xy_chart, scorecard, text, blank, alert_chart, time_series_table, collapsible_group, logs_panel, incident_list, pie_chart, error_reporting_panel, section_header, single_view_group. If a field in that set is populated, all other fields in the set will automatically be cleared.