Reference documentation and code samples for the Cloud Monitoring Dashboards V1 API class Google::Cloud::Monitoring::Dashboard::V1::Dashboard.
A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#column_layout
def column_layout() -> ::Google::Cloud::Monitoring::Dashboard::V1::ColumnLayout
Returns
- (::Google::Cloud::Monitoring::Dashboard::V1::ColumnLayout) — The content is divided into equally spaced columns and the widgets are arranged vertically.
#column_layout=
def column_layout=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::ColumnLayout
Parameter
- value (::Google::Cloud::Monitoring::Dashboard::V1::ColumnLayout) — The content is divided into equally spaced columns and the widgets are arranged vertically.
Returns
- (::Google::Cloud::Monitoring::Dashboard::V1::ColumnLayout) — The content is divided into equally spaced columns and the widgets are arranged vertically.
#dashboard_filters
def dashboard_filters() -> ::Array<::Google::Cloud::Monitoring::Dashboard::V1::DashboardFilter>
Returns
- (::Array<::Google::Cloud::Monitoring::Dashboard::V1::DashboardFilter>) — Filters to reduce the amount of data charted based on the filter criteria.
#dashboard_filters=
def dashboard_filters=(value) -> ::Array<::Google::Cloud::Monitoring::Dashboard::V1::DashboardFilter>
Parameter
- value (::Array<::Google::Cloud::Monitoring::Dashboard::V1::DashboardFilter>) — Filters to reduce the amount of data charted based on the filter criteria.
Returns
- (::Array<::Google::Cloud::Monitoring::Dashboard::V1::DashboardFilter>) — Filters to reduce the amount of data charted based on the filter criteria.
#display_name
def display_name() -> ::String
Returns
- (::String) — Required. The mutable, human-readable name.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Required. The mutable, human-readable name.
Returns
- (::String) — Required. The mutable, human-readable name.
#etag
def etag() -> ::String
Returns
-
(::String) —
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. Anetag
is returned in the response toGetDashboard
, and users are expected to put that etag in the request toUpdateDashboard
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.
#etag=
def etag=(value) -> ::String
Parameter
-
value (::String) —
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. Anetag
is returned in the response toGetDashboard
, and users are expected to put that etag in the request toUpdateDashboard
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.
Returns
-
(::String) —
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. Anetag
is returned in the response toGetDashboard
, and users are expected to put that etag in the request toUpdateDashboard
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.
#grid_layout
def grid_layout() -> ::Google::Cloud::Monitoring::Dashboard::V1::GridLayout
Returns
- (::Google::Cloud::Monitoring::Dashboard::V1::GridLayout) — Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles.
#grid_layout=
def grid_layout=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::GridLayout
Parameter
- value (::Google::Cloud::Monitoring::Dashboard::V1::GridLayout) — Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles.
Returns
- (::Google::Cloud::Monitoring::Dashboard::V1::GridLayout) — Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels applied to the dashboard
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Labels applied to the dashboard
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels applied to the dashboard
#mosaic_layout
def mosaic_layout() -> ::Google::Cloud::Monitoring::Dashboard::V1::MosaicLayout
Returns
- (::Google::Cloud::Monitoring::Dashboard::V1::MosaicLayout) — The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks.
#mosaic_layout=
def mosaic_layout=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::MosaicLayout
Parameter
- value (::Google::Cloud::Monitoring::Dashboard::V1::MosaicLayout) — The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks.
Returns
- (::Google::Cloud::Monitoring::Dashboard::V1::MosaicLayout) — The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks.
#name
def name() -> ::String
Returns
- (::String) — Identifier. The resource name of the dashboard.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Identifier. The resource name of the dashboard.
Returns
- (::String) — Identifier. The resource name of the dashboard.
#row_layout
def row_layout() -> ::Google::Cloud::Monitoring::Dashboard::V1::RowLayout
Returns
- (::Google::Cloud::Monitoring::Dashboard::V1::RowLayout) — The content is divided into equally spaced rows and the widgets are arranged horizontally.
#row_layout=
def row_layout=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::RowLayout
Parameter
- value (::Google::Cloud::Monitoring::Dashboard::V1::RowLayout) — The content is divided into equally spaced rows and the widgets are arranged horizontally.
Returns
- (::Google::Cloud::Monitoring::Dashboard::V1::RowLayout) — The content is divided into equally spaced rows and the widgets are arranged horizontally.