Class: Google::Apis::MonitoringV1::XyChart

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/monitoring_v1/classes.rb,
lib/google/apis/monitoring_v1/representations.rb,
lib/google/apis/monitoring_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ XyChart

Returns a new instance of XyChart.



2963
2964
2965
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2963

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#chart_options ⇒ Google::Apis::MonitoringV1::ChartOptions

Options to control visual rendering of a chart. Corresponds to the JSON property chartOptions

Returns:



2928
2929
2930
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2928

def chart_options
  @chart_options
end

#data_sets ⇒ Array<Google::Apis::MonitoringV1::DataSet>

Required. The data displayed in this chart. Corresponds to the JSON property dataSets

Returns:



2933
2934
2935
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2933

def data_sets
  @data_sets
end

#thresholds ⇒ Array<Google::Apis::MonitoringV1::Threshold>

Threshold lines drawn horizontally across the chart. Corresponds to the JSON property thresholds

Returns:



2938
2939
2940
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2938

def thresholds
  @thresholds
end

#timeshift_duration ⇒ String

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. Corresponds to the JSON property timeshiftDuration

Returns:

  • (String) 


2946
2947
2948
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2946

def timeshift_duration
  @timeshift_duration
end

#x_axis ⇒ Google::Apis::MonitoringV1::Axis

A chart axis. Corresponds to the JSON property xAxis

Returns:



2951
2952
2953
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2951

def x_axis
  @x_axis
end

#y2_axis ⇒ Google::Apis::MonitoringV1::Axis

A chart axis. Corresponds to the JSON property y2Axis

Returns:



2956
2957
2958
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2956

def y2_axis
  @y2_axis
end

#y_axis ⇒ Google::Apis::MonitoringV1::Axis

A chart axis. Corresponds to the JSON property yAxis

Returns:



2961
2962
2963
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2961

def y_axis
  @y_axis
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2968
2969
2970
2971
2972
2973
2974
2975
2976
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2968

def update!(**args)
  @chart_options = args[:chart_options] if args.key?(:chart_options)
  @data_sets = args[:data_sets] if args.key?(:data_sets)
  @thresholds = args[:thresholds] if args.key?(:thresholds)
  @timeshift_duration = args[:timeshift_duration] if args.key?(:timeshift_duration)
  @x_axis = args[:x_axis] if args.key?(:x_axis)
  @y2_axis = args[:y2_axis] if args.key?(:y2_axis)
  @y_axis = args[:y_axis] if args.key?(:y_axis)
end