Class XyChart (2.5.2)

public final class XyChart extends GeneratedMessageV3 implements XyChartOrBuilder

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

Protobuf type google.monitoring.dashboard.v1.XyChart

Implements

XyChartOrBuilder

Static Fields

CHART_OPTIONS_FIELD_NUMBER

public static final int CHART_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_SETS_FIELD_NUMBER

public static final int DATA_SETS_FIELD_NUMBER
Field Value
TypeDescription
int

THRESHOLDS_FIELD_NUMBER

public static final int THRESHOLDS_FIELD_NUMBER
Field Value
TypeDescription
int

TIMESHIFT_DURATION_FIELD_NUMBER

public static final int TIMESHIFT_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

X_AXIS_FIELD_NUMBER

public static final int X_AXIS_FIELD_NUMBER
Field Value
TypeDescription
int

Y2_AXIS_FIELD_NUMBER

public static final int Y2_AXIS_FIELD_NUMBER
Field Value
TypeDescription
int

Y_AXIS_FIELD_NUMBER

public static final int Y_AXIS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static XyChart getDefaultInstance()
Returns
TypeDescription
XyChart

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static XyChart.Builder newBuilder()
Returns
TypeDescription
XyChart.Builder

newBuilder(XyChart prototype)

public static XyChart.Builder newBuilder(XyChart prototype)
Parameter
NameDescription
prototypeXyChart
Returns
TypeDescription
XyChart.Builder

parseDelimitedFrom(InputStream input)

public static XyChart parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static XyChart parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static XyChart parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static XyChart parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static XyChart parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static XyChart parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static XyChart parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static XyChart parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static XyChart parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static XyChart parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static XyChart parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static XyChart parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<XyChart> parser()
Returns
TypeDescription
Parser<XyChart>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getChartOptions()

public ChartOptions getChartOptions()

Display options for the chart.

.google.monitoring.dashboard.v1.ChartOptions chart_options = 8;

Returns
TypeDescription
ChartOptions

The chartOptions.

getChartOptionsOrBuilder()

public ChartOptionsOrBuilder getChartOptionsOrBuilder()

Display options for the chart.

.google.monitoring.dashboard.v1.ChartOptions chart_options = 8;

Returns
TypeDescription
ChartOptionsOrBuilder

getDataSets(int index)

public XyChart.DataSet getDataSets(int index)

Required. The data displayed in this chart.

repeated .google.monitoring.dashboard.v1.XyChart.DataSet data_sets = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
XyChart.DataSet

getDataSetsCount()

public int getDataSetsCount()

Required. The data displayed in this chart.

repeated .google.monitoring.dashboard.v1.XyChart.DataSet data_sets = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getDataSetsList()

public List<XyChart.DataSet> getDataSetsList()

Required. The data displayed in this chart.

repeated .google.monitoring.dashboard.v1.XyChart.DataSet data_sets = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<DataSet>

getDataSetsOrBuilder(int index)

public XyChart.DataSetOrBuilder getDataSetsOrBuilder(int index)

Required. The data displayed in this chart.

repeated .google.monitoring.dashboard.v1.XyChart.DataSet data_sets = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
XyChart.DataSetOrBuilder

getDataSetsOrBuilderList()

public List<? extends XyChart.DataSetOrBuilder> getDataSetsOrBuilderList()

Required. The data displayed in this chart.

repeated .google.monitoring.dashboard.v1.XyChart.DataSet data_sets = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.monitoring.dashboard.v1.XyChart.DataSetOrBuilder>

getDefaultInstanceForType()

public XyChart getDefaultInstanceForType()
Returns
TypeDescription
XyChart

getParserForType()

public Parser<XyChart> getParserForType()
Returns
TypeDescription
Parser<XyChart>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getThresholds(int index)

public Threshold getThresholds(int index)

Threshold lines drawn horizontally across the chart.

repeated .google.monitoring.dashboard.v1.Threshold thresholds = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Threshold

getThresholdsCount()

public int getThresholdsCount()

Threshold lines drawn horizontally across the chart.

repeated .google.monitoring.dashboard.v1.Threshold thresholds = 5;

Returns
TypeDescription
int

getThresholdsList()

public List<Threshold> getThresholdsList()

Threshold lines drawn horizontally across the chart.

repeated .google.monitoring.dashboard.v1.Threshold thresholds = 5;

Returns
TypeDescription
List<Threshold>

getThresholdsOrBuilder(int index)

public ThresholdOrBuilder getThresholdsOrBuilder(int index)

Threshold lines drawn horizontally across the chart.

repeated .google.monitoring.dashboard.v1.Threshold thresholds = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
ThresholdOrBuilder

getThresholdsOrBuilderList()

public List<? extends ThresholdOrBuilder> getThresholdsOrBuilderList()

Threshold lines drawn horizontally across the chart.

repeated .google.monitoring.dashboard.v1.Threshold thresholds = 5;

Returns
TypeDescription
List<? extends com.google.monitoring.dashboard.v1.ThresholdOrBuilder>

getTimeshiftDuration()

public Duration getTimeshiftDuration()

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.

.google.protobuf.Duration timeshift_duration = 4;

Returns
TypeDescription
Duration

The timeshiftDuration.

getTimeshiftDurationOrBuilder()

public DurationOrBuilder getTimeshiftDurationOrBuilder()

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.

.google.protobuf.Duration timeshift_duration = 4;

Returns
TypeDescription
DurationOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getXAxis()

public XyChart.Axis getXAxis()

The properties applied to the X axis.

.google.monitoring.dashboard.v1.XyChart.Axis x_axis = 6;

Returns
TypeDescription
XyChart.Axis

The xAxis.

getXAxisOrBuilder()

public XyChart.AxisOrBuilder getXAxisOrBuilder()

The properties applied to the X axis.

.google.monitoring.dashboard.v1.XyChart.Axis x_axis = 6;

Returns
TypeDescription
XyChart.AxisOrBuilder

getY2Axis()

public XyChart.Axis getY2Axis()

The properties applied to the Y2 axis.

.google.monitoring.dashboard.v1.XyChart.Axis y2_axis = 9;

Returns
TypeDescription
XyChart.Axis

The y2Axis.

getY2AxisOrBuilder()

public XyChart.AxisOrBuilder getY2AxisOrBuilder()

The properties applied to the Y2 axis.

.google.monitoring.dashboard.v1.XyChart.Axis y2_axis = 9;

Returns
TypeDescription
XyChart.AxisOrBuilder

getYAxis()

public XyChart.Axis getYAxis()

The properties applied to the Y axis.

.google.monitoring.dashboard.v1.XyChart.Axis y_axis = 7;

Returns
TypeDescription
XyChart.Axis

The yAxis.

getYAxisOrBuilder()

public XyChart.AxisOrBuilder getYAxisOrBuilder()

The properties applied to the Y axis.

.google.monitoring.dashboard.v1.XyChart.Axis y_axis = 7;

Returns
TypeDescription
XyChart.AxisOrBuilder

hasChartOptions()

public boolean hasChartOptions()

Display options for the chart.

.google.monitoring.dashboard.v1.ChartOptions chart_options = 8;

Returns
TypeDescription
boolean

Whether the chartOptions field is set.

hasTimeshiftDuration()

public boolean hasTimeshiftDuration()

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.

.google.protobuf.Duration timeshift_duration = 4;

Returns
TypeDescription
boolean

Whether the timeshiftDuration field is set.

hasXAxis()

public boolean hasXAxis()

The properties applied to the X axis.

.google.monitoring.dashboard.v1.XyChart.Axis x_axis = 6;

Returns
TypeDescription
boolean

Whether the xAxis field is set.

hasY2Axis()

public boolean hasY2Axis()

The properties applied to the Y2 axis.

.google.monitoring.dashboard.v1.XyChart.Axis y2_axis = 9;

Returns
TypeDescription
boolean

Whether the y2Axis field is set.

hasYAxis()

public boolean hasYAxis()

The properties applied to the Y axis.

.google.monitoring.dashboard.v1.XyChart.Axis y_axis = 7;

Returns
TypeDescription
boolean

Whether the yAxis field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public XyChart.Builder newBuilderForType()
Returns
TypeDescription
XyChart.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected XyChart.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
XyChart.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public XyChart.Builder toBuilder()
Returns
TypeDescription
XyChart.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException