Class: Google::Cloud::Monitoring::Dashboard::V1::XyChart

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

Overview

A chart that displays data on a 2D (X and Y axes) plane.

Defined Under Namespace

Classes: Axis, DataSet

Instance Attribute Summary collapse

Instance Attribute Details

#chart_options ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::ChartOptions

Returns Display options for the chart.

Returns:



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 51

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

  # Groups a time series query definition with charting options.
  # @!attribute [rw] time_series_query
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
  #     Required. Fields for querying time series data from the
  #     Stackdriver metrics API.
  # @!attribute [rw] plot_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::PlotType]
  #     How this data should be plotted on the chart.
  # @!attribute [rw] legend_template
  #   @return [::String]
  #     A template string for naming `TimeSeries` in the resulting data set.
  #     This should be a string with interpolations of the form `${label_name}`,
  #     which will resolve to the label's value.
  # @!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.
  # @!attribute [rw] target_axis
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::TargetAxis]
  #     Optional. The target axis to use for plotting the metric.
  class DataSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The types of plotting strategies for data sets.
    module PlotType
      # Plot type is unspecified. The view will default to `LINE`.
      PLOT_TYPE_UNSPECIFIED = 0

      # The data is plotted as a set of lines (one line per series).
      LINE = 1

      # The data is plotted as a set of filled areas (one area per series),
      # with the areas stacked vertically (the base of each area is the top of
      # its predecessor, and the base of the first area is the x-axis). Since
      # the areas do not overlap, each is filled with a different opaque color.
      STACKED_AREA = 2

      # The data is plotted as a set of rectangular boxes (one box per series),
      # with the boxes stacked vertically (the base of each box is the top of
      # its predecessor, and the base of the first box is the x-axis). Since
      # the boxes do not overlap, each is filled with a different opaque color.
      STACKED_BAR = 3

      # The data is plotted as a heatmap. The series being plotted must have a
      # `DISTRIBUTION` value type. The value of each bucket in the distribution
      # is displayed as a color. This type is not currently available in the
      # Stackdriver Monitoring application.
      HEATMAP = 4
    end

    # An axis identifier.
    module TargetAxis
      # The target axis was not specified. Defaults to Y1.
      TARGET_AXIS_UNSPECIFIED = 0

      # The y_axis (the right axis of chart).
      Y1 = 1

      # The y2_axis (the left axis of chart).
      Y2 = 2
    end
  end

  # A chart axis.
  # @!attribute [rw] label
  #   @return [::String]
  #     The label of the axis.
  # @!attribute [rw] scale
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::Axis::Scale]
  #     The axis scale. By default, a linear scale is used.
  class Axis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Types of scales used in axes.
    module Scale
      # Scale is unspecified. The view will default to `LINEAR`.
      SCALE_UNSPECIFIED = 0

      # Linear scale.
      LINEAR = 1

      # Logarithmic scale (base 10).
      LOG10 = 2
    end
  end
end

#data_sets ⇒ ::Array<::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet>

Returns Required. The data displayed in this chart.

Returns:



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 51

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

  # Groups a time series query definition with charting options.
  # @!attribute [rw] time_series_query
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
  #     Required. Fields for querying time series data from the
  #     Stackdriver metrics API.
  # @!attribute [rw] plot_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::PlotType]
  #     How this data should be plotted on the chart.
  # @!attribute [rw] legend_template
  #   @return [::String]
  #     A template string for naming `TimeSeries` in the resulting data set.
  #     This should be a string with interpolations of the form `${label_name}`,
  #     which will resolve to the label's value.
  # @!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.
  # @!attribute [rw] target_axis
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::TargetAxis]
  #     Optional. The target axis to use for plotting the metric.
  class DataSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The types of plotting strategies for data sets.
    module PlotType
      # Plot type is unspecified. The view will default to `LINE`.
      PLOT_TYPE_UNSPECIFIED = 0

      # The data is plotted as a set of lines (one line per series).
      LINE = 1

      # The data is plotted as a set of filled areas (one area per series),
      # with the areas stacked vertically (the base of each area is the top of
      # its predecessor, and the base of the first area is the x-axis). Since
      # the areas do not overlap, each is filled with a different opaque color.
      STACKED_AREA = 2

      # The data is plotted as a set of rectangular boxes (one box per series),
      # with the boxes stacked vertically (the base of each box is the top of
      # its predecessor, and the base of the first box is the x-axis). Since
      # the boxes do not overlap, each is filled with a different opaque color.
      STACKED_BAR = 3

      # The data is plotted as a heatmap. The series being plotted must have a
      # `DISTRIBUTION` value type. The value of each bucket in the distribution
      # is displayed as a color. This type is not currently available in the
      # Stackdriver Monitoring application.
      HEATMAP = 4
    end

    # An axis identifier.
    module TargetAxis
      # The target axis was not specified. Defaults to Y1.
      TARGET_AXIS_UNSPECIFIED = 0

      # The y_axis (the right axis of chart).
      Y1 = 1

      # The y2_axis (the left axis of chart).
      Y2 = 2
    end
  end

  # A chart axis.
  # @!attribute [rw] label
  #   @return [::String]
  #     The label of the axis.
  # @!attribute [rw] scale
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::Axis::Scale]
  #     The axis scale. By default, a linear scale is used.
  class Axis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Types of scales used in axes.
    module Scale
      # Scale is unspecified. The view will default to `LINEAR`.
      SCALE_UNSPECIFIED = 0

      # Linear scale.
      LINEAR = 1

      # Logarithmic scale (base 10).
      LOG10 = 2
    end
  end
end

#thresholds ⇒ ::Array<::Google::Cloud::Monitoring::Dashboard::V1::Threshold>

Returns Threshold lines drawn horizontally across the chart.

Returns:



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 51

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

  # Groups a time series query definition with charting options.
  # @!attribute [rw] time_series_query
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
  #     Required. Fields for querying time series data from the
  #     Stackdriver metrics API.
  # @!attribute [rw] plot_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::PlotType]
  #     How this data should be plotted on the chart.
  # @!attribute [rw] legend_template
  #   @return [::String]
  #     A template string for naming `TimeSeries` in the resulting data set.
  #     This should be a string with interpolations of the form `${label_name}`,
  #     which will resolve to the label's value.
  # @!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.
  # @!attribute [rw] target_axis
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::TargetAxis]
  #     Optional. The target axis to use for plotting the metric.
  class DataSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The types of plotting strategies for data sets.
    module PlotType
      # Plot type is unspecified. The view will default to `LINE`.
      PLOT_TYPE_UNSPECIFIED = 0

      # The data is plotted as a set of lines (one line per series).
      LINE = 1

      # The data is plotted as a set of filled areas (one area per series),
      # with the areas stacked vertically (the base of each area is the top of
      # its predecessor, and the base of the first area is the x-axis). Since
      # the areas do not overlap, each is filled with a different opaque color.
      STACKED_AREA = 2

      # The data is plotted as a set of rectangular boxes (one box per series),
      # with the boxes stacked vertically (the base of each box is the top of
      # its predecessor, and the base of the first box is the x-axis). Since
      # the boxes do not overlap, each is filled with a different opaque color.
      STACKED_BAR = 3

      # The data is plotted as a heatmap. The series being plotted must have a
      # `DISTRIBUTION` value type. The value of each bucket in the distribution
      # is displayed as a color. This type is not currently available in the
      # Stackdriver Monitoring application.
      HEATMAP = 4
    end

    # An axis identifier.
    module TargetAxis
      # The target axis was not specified. Defaults to Y1.
      TARGET_AXIS_UNSPECIFIED = 0

      # The y_axis (the right axis of chart).
      Y1 = 1

      # The y2_axis (the left axis of chart).
      Y2 = 2
    end
  end

  # A chart axis.
  # @!attribute [rw] label
  #   @return [::String]
  #     The label of the axis.
  # @!attribute [rw] scale
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::Axis::Scale]
  #     The axis scale. By default, a linear scale is used.
  class Axis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Types of scales used in axes.
    module Scale
      # Scale is unspecified. The view will default to `LINEAR`.
      SCALE_UNSPECIFIED = 0

      # Linear scale.
      LINEAR = 1

      # Logarithmic scale (base 10).
      LOG10 = 2
    end
  end
end

#timeshift_duration ⇒ ::Google::Protobuf::Duration

Returns The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type.

Returns:

  • (::Google::Protobuf::Duration) —

    The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type.



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 51

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

  # Groups a time series query definition with charting options.
  # @!attribute [rw] time_series_query
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
  #     Required. Fields for querying time series data from the
  #     Stackdriver metrics API.
  # @!attribute [rw] plot_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::PlotType]
  #     How this data should be plotted on the chart.
  # @!attribute [rw] legend_template
  #   @return [::String]
  #     A template string for naming `TimeSeries` in the resulting data set.
  #     This should be a string with interpolations of the form `${label_name}`,
  #     which will resolve to the label's value.
  # @!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.
  # @!attribute [rw] target_axis
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::TargetAxis]
  #     Optional. The target axis to use for plotting the metric.
  class DataSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The types of plotting strategies for data sets.
    module PlotType
      # Plot type is unspecified. The view will default to `LINE`.
      PLOT_TYPE_UNSPECIFIED = 0

      # The data is plotted as a set of lines (one line per series).
      LINE = 1

      # The data is plotted as a set of filled areas (one area per series),
      # with the areas stacked vertically (the base of each area is the top of
      # its predecessor, and the base of the first area is the x-axis). Since
      # the areas do not overlap, each is filled with a different opaque color.
      STACKED_AREA = 2

      # The data is plotted as a set of rectangular boxes (one box per series),
      # with the boxes stacked vertically (the base of each box is the top of
      # its predecessor, and the base of the first box is the x-axis). Since
      # the boxes do not overlap, each is filled with a different opaque color.
      STACKED_BAR = 3

      # The data is plotted as a heatmap. The series being plotted must have a
      # `DISTRIBUTION` value type. The value of each bucket in the distribution
      # is displayed as a color. This type is not currently available in the
      # Stackdriver Monitoring application.
      HEATMAP = 4
    end

    # An axis identifier.
    module TargetAxis
      # The target axis was not specified. Defaults to Y1.
      TARGET_AXIS_UNSPECIFIED = 0

      # The y_axis (the right axis of chart).
      Y1 = 1

      # The y2_axis (the left axis of chart).
      Y2 = 2
    end
  end

  # A chart axis.
  # @!attribute [rw] label
  #   @return [::String]
  #     The label of the axis.
  # @!attribute [rw] scale
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::Axis::Scale]
  #     The axis scale. By default, a linear scale is used.
  class Axis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Types of scales used in axes.
    module Scale
      # Scale is unspecified. The view will default to `LINEAR`.
      SCALE_UNSPECIFIED = 0

      # Linear scale.
      LINEAR = 1

      # Logarithmic scale (base 10).
      LOG10 = 2
    end
  end
end

#x_axis ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::XyChart::Axis

Returns The properties applied to the x-axis.

Returns:



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 51

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

  # Groups a time series query definition with charting options.
  # @!attribute [rw] time_series_query
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
  #     Required. Fields for querying time series data from the
  #     Stackdriver metrics API.
  # @!attribute [rw] plot_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::PlotType]
  #     How this data should be plotted on the chart.
  # @!attribute [rw] legend_template
  #   @return [::String]
  #     A template string for naming `TimeSeries` in the resulting data set.
  #     This should be a string with interpolations of the form `${label_name}`,
  #     which will resolve to the label's value.
  # @!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.
  # @!attribute [rw] target_axis
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::TargetAxis]
  #     Optional. The target axis to use for plotting the metric.
  class DataSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The types of plotting strategies for data sets.
    module PlotType
      # Plot type is unspecified. The view will default to `LINE`.
      PLOT_TYPE_UNSPECIFIED = 0

      # The data is plotted as a set of lines (one line per series).
      LINE = 1

      # The data is plotted as a set of filled areas (one area per series),
      # with the areas stacked vertically (the base of each area is the top of
      # its predecessor, and the base of the first area is the x-axis). Since
      # the areas do not overlap, each is filled with a different opaque color.
      STACKED_AREA = 2

      # The data is plotted as a set of rectangular boxes (one box per series),
      # with the boxes stacked vertically (the base of each box is the top of
      # its predecessor, and the base of the first box is the x-axis). Since
      # the boxes do not overlap, each is filled with a different opaque color.
      STACKED_BAR = 3

      # The data is plotted as a heatmap. The series being plotted must have a
      # `DISTRIBUTION` value type. The value of each bucket in the distribution
      # is displayed as a color. This type is not currently available in the
      # Stackdriver Monitoring application.
      HEATMAP = 4
    end

    # An axis identifier.
    module TargetAxis
      # The target axis was not specified. Defaults to Y1.
      TARGET_AXIS_UNSPECIFIED = 0

      # The y_axis (the right axis of chart).
      Y1 = 1

      # The y2_axis (the left axis of chart).
      Y2 = 2
    end
  end

  # A chart axis.
  # @!attribute [rw] label
  #   @return [::String]
  #     The label of the axis.
  # @!attribute [rw] scale
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::Axis::Scale]
  #     The axis scale. By default, a linear scale is used.
  class Axis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Types of scales used in axes.
    module Scale
      # Scale is unspecified. The view will default to `LINEAR`.
      SCALE_UNSPECIFIED = 0

      # Linear scale.
      LINEAR = 1

      # Logarithmic scale (base 10).
      LOG10 = 2
    end
  end
end

#y2_axis ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::XyChart::Axis

Returns The properties applied to the y2-axis.

Returns:



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 51

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

  # Groups a time series query definition with charting options.
  # @!attribute [rw] time_series_query
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
  #     Required. Fields for querying time series data from the
  #     Stackdriver metrics API.
  # @!attribute [rw] plot_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::PlotType]
  #     How this data should be plotted on the chart.
  # @!attribute [rw] legend_template
  #   @return [::String]
  #     A template string for naming `TimeSeries` in the resulting data set.
  #     This should be a string with interpolations of the form `${label_name}`,
  #     which will resolve to the label's value.
  # @!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.
  # @!attribute [rw] target_axis
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::TargetAxis]
  #     Optional. The target axis to use for plotting the metric.
  class DataSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The types of plotting strategies for data sets.
    module PlotType
      # Plot type is unspecified. The view will default to `LINE`.
      PLOT_TYPE_UNSPECIFIED = 0

      # The data is plotted as a set of lines (one line per series).
      LINE = 1

      # The data is plotted as a set of filled areas (one area per series),
      # with the areas stacked vertically (the base of each area is the top of
      # its predecessor, and the base of the first area is the x-axis). Since
      # the areas do not overlap, each is filled with a different opaque color.
      STACKED_AREA = 2

      # The data is plotted as a set of rectangular boxes (one box per series),
      # with the boxes stacked vertically (the base of each box is the top of
      # its predecessor, and the base of the first box is the x-axis). Since
      # the boxes do not overlap, each is filled with a different opaque color.
      STACKED_BAR = 3

      # The data is plotted as a heatmap. The series being plotted must have a
      # `DISTRIBUTION` value type. The value of each bucket in the distribution
      # is displayed as a color. This type is not currently available in the
      # Stackdriver Monitoring application.
      HEATMAP = 4
    end

    # An axis identifier.
    module TargetAxis
      # The target axis was not specified. Defaults to Y1.
      TARGET_AXIS_UNSPECIFIED = 0

      # The y_axis (the right axis of chart).
      Y1 = 1

      # The y2_axis (the left axis of chart).
      Y2 = 2
    end
  end

  # A chart axis.
  # @!attribute [rw] label
  #   @return [::String]
  #     The label of the axis.
  # @!attribute [rw] scale
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::Axis::Scale]
  #     The axis scale. By default, a linear scale is used.
  class Axis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Types of scales used in axes.
    module Scale
      # Scale is unspecified. The view will default to `LINEAR`.
      SCALE_UNSPECIFIED = 0

      # Linear scale.
      LINEAR = 1

      # Logarithmic scale (base 10).
      LOG10 = 2
    end
  end
end

#y_axis ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::XyChart::Axis

Returns The properties applied to the y-axis.

Returns:



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 51

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

  # Groups a time series query definition with charting options.
  # @!attribute [rw] time_series_query
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
  #     Required. Fields for querying time series data from the
  #     Stackdriver metrics API.
  # @!attribute [rw] plot_type
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::PlotType]
  #     How this data should be plotted on the chart.
  # @!attribute [rw] legend_template
  #   @return [::String]
  #     A template string for naming `TimeSeries` in the resulting data set.
  #     This should be a string with interpolations of the form `${label_name}`,
  #     which will resolve to the label's value.
  # @!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.
  # @!attribute [rw] target_axis
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::TargetAxis]
  #     Optional. The target axis to use for plotting the metric.
  class DataSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The types of plotting strategies for data sets.
    module PlotType
      # Plot type is unspecified. The view will default to `LINE`.
      PLOT_TYPE_UNSPECIFIED = 0

      # The data is plotted as a set of lines (one line per series).
      LINE = 1

      # The data is plotted as a set of filled areas (one area per series),
      # with the areas stacked vertically (the base of each area is the top of
      # its predecessor, and the base of the first area is the x-axis). Since
      # the areas do not overlap, each is filled with a different opaque color.
      STACKED_AREA = 2

      # The data is plotted as a set of rectangular boxes (one box per series),
      # with the boxes stacked vertically (the base of each box is the top of
      # its predecessor, and the base of the first box is the x-axis). Since
      # the boxes do not overlap, each is filled with a different opaque color.
      STACKED_BAR = 3

      # The data is plotted as a heatmap. The series being plotted must have a
      # `DISTRIBUTION` value type. The value of each bucket in the distribution
      # is displayed as a color. This type is not currently available in the
      # Stackdriver Monitoring application.
      HEATMAP = 4
    end

    # An axis identifier.
    module TargetAxis
      # The target axis was not specified. Defaults to Y1.
      TARGET_AXIS_UNSPECIFIED = 0

      # The y_axis (the right axis of chart).
      Y1 = 1

      # The y2_axis (the left axis of chart).
      Y2 = 2
    end
  end

  # A chart axis.
  # @!attribute [rw] label
  #   @return [::String]
  #     The label of the axis.
  # @!attribute [rw] scale
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::Axis::Scale]
  #     The axis scale. By default, a linear scale is used.
  class Axis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Types of scales used in axes.
    module Scale
      # Scale is unspecified. The view will default to `LINEAR`.
      SCALE_UNSPECIFIED = 0

      # Linear scale.
      LINEAR = 1

      # Logarithmic scale (base 10).
      LOG10 = 2
    end
  end
end