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

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

Overview

Groups a time series query definition with charting options.

Defined Under Namespace

Modules: PlotType, TargetAxis

Instance Attribute Summary collapse

Instance Attribute Details

#legend_template ⇒ ::String

Returns 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.

Returns:

  • (::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.



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
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 78

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

#min_alignment_period ⇒ ::Google::Protobuf::Duration

Returns 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.

Returns:

  • (::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.



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
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 78

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

#plot_type ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::PlotType

Returns How this data should be plotted on the chart.

Returns:



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
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 78

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

#target_axis ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::TargetAxis

Returns Optional. The target axis to use for plotting the metric.

Returns:



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
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 78

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

#time_series_query ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery

Returns Required. Fields for querying time series data from the Stackdriver metrics API.

Returns:



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
 
# File 'proto_docs/google/monitoring/dashboard/v1/xychart.rb', line 78

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