Class: Google::Cloud::Monitoring::Dashboard::V1::PieChart

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/dashboard/v1/piechart.rb

Overview

A widget that displays timeseries data as a pie or a donut.

Defined Under Namespace

Modules: PieChartType Classes: PieChartDataSet

Instance Attribute Summary collapse

Instance Attribute Details

#chart_type ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::PieChart::PieChartType

Returns Required. Indicates the visualization type for the PieChart.

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'proto_docs/google/monitoring/dashboard/v1/piechart.rb', line 35

class PieChart
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Groups a time series query definition.
  # @!attribute [rw] time_series_query
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
  #     Required. The query for the PieChart. See,
  #     `google.monitoring.dashboard.v1.TimeSeriesQuery`.
  # @!attribute [rw] slice_name_template
  #   @return [::String]
  #     Optional. A template for the name of the slice. This name will be
  #     displayed in the legend and the tooltip of the pie chart. It replaces the
  #     auto-generated names for the slices. For example, if the template is set
  #     to
  #     `${resource.labels.zone}`, the zone's value will be used for the name
  #     instead of the default name.
  # @!attribute [rw] min_alignment_period
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The lower bound on data point frequency for this data set,
  #     implemented by specifying the minimum alignment period to use in a time
  #     series query. For example, if the data is published once every 10
  #     minutes, the `min_alignment_period` should be at least 10 minutes. It
  #     would not make sense to fetch and align data at one minute intervals.
  class PieChartDataSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Types for the pie chart.
  module PieChartType
    # The zero value. No type specified. Do not use.
    PIE_CHART_TYPE_UNSPECIFIED = 0

    # A Pie type PieChart.
    PIE = 1

    # Similar to PIE, but the DONUT type PieChart has a hole in the middle.
    DONUT = 2
  end
end

#data_sets ⇒ ::Array<::Google::Cloud::Monitoring::Dashboard::V1::PieChart::PieChartDataSet>

Returns Required. The queries for the chart's data.

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'proto_docs/google/monitoring/dashboard/v1/piechart.rb', line 35

class PieChart
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Groups a time series query definition.
  # @!attribute [rw] time_series_query
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
  #     Required. The query for the PieChart. See,
  #     `google.monitoring.dashboard.v1.TimeSeriesQuery`.
  # @!attribute [rw] slice_name_template
  #   @return [::String]
  #     Optional. A template for the name of the slice. This name will be
  #     displayed in the legend and the tooltip of the pie chart. It replaces the
  #     auto-generated names for the slices. For example, if the template is set
  #     to
  #     `${resource.labels.zone}`, the zone's value will be used for the name
  #     instead of the default name.
  # @!attribute [rw] min_alignment_period
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The lower bound on data point frequency for this data set,
  #     implemented by specifying the minimum alignment period to use in a time
  #     series query. For example, if the data is published once every 10
  #     minutes, the `min_alignment_period` should be at least 10 minutes. It
  #     would not make sense to fetch and align data at one minute intervals.
  class PieChartDataSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Types for the pie chart.
  module PieChartType
    # The zero value. No type specified. Do not use.
    PIE_CHART_TYPE_UNSPECIFIED = 0

    # A Pie type PieChart.
    PIE = 1

    # Similar to PIE, but the DONUT type PieChart has a hole in the middle.
    DONUT = 2
  end
end

#show_labels ⇒ ::Boolean

Returns Optional. Indicates whether or not the pie chart should show slices' labels.

Returns:

  • (::Boolean) —

    Optional. Indicates whether or not the pie chart should show slices' labels



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'proto_docs/google/monitoring/dashboard/v1/piechart.rb', line 35

class PieChart
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Groups a time series query definition.
  # @!attribute [rw] time_series_query
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
  #     Required. The query for the PieChart. See,
  #     `google.monitoring.dashboard.v1.TimeSeriesQuery`.
  # @!attribute [rw] slice_name_template
  #   @return [::String]
  #     Optional. A template for the name of the slice. This name will be
  #     displayed in the legend and the tooltip of the pie chart. It replaces the
  #     auto-generated names for the slices. For example, if the template is set
  #     to
  #     `${resource.labels.zone}`, the zone's value will be used for the name
  #     instead of the default name.
  # @!attribute [rw] min_alignment_period
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The lower bound on data point frequency for this data set,
  #     implemented by specifying the minimum alignment period to use in a time
  #     series query. For example, if the data is published once every 10
  #     minutes, the `min_alignment_period` should be at least 10 minutes. It
  #     would not make sense to fetch and align data at one minute intervals.
  class PieChartDataSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Types for the pie chart.
  module PieChartType
    # The zero value. No type specified. Do not use.
    PIE_CHART_TYPE_UNSPECIFIED = 0

    # A Pie type PieChart.
    PIE = 1

    # Similar to PIE, but the DONUT type PieChart has a hole in the middle.
    DONUT = 2
  end
end