Represents a DataSet.
Package
@google-cloud/monitoring-dashboards!Constructors
(constructor)(properties)
constructor(properties?: google.monitoring.dashboard.v1.XyChart.IDataSet);
Constructs a new DataSet.
Type | Name | Description |
---|---|---|
IDataSet | properties |
Properties to set |
Properties
legendTemplate
public legendTemplate: string;
DataSet legendTemplate.
Type | Description |
---|---|
string |
minAlignmentPeriod
public minAlignmentPeriod?: (google.protobuf.IDuration|null);
DataSet minAlignmentPeriod.
Type | Description |
---|---|
(google.protobuf.IDuration|null) |
plotType
public plotType: (google.monitoring.dashboard.v1.XyChart.DataSet.PlotType|keyof typeof google.monitoring.dashboard.v1.XyChart.DataSet.PlotType);
DataSet plotType.
Type | Description |
---|---|
(google.monitoring.dashboard.v1.XyChart.DataSet.PlotType|keyof typeof google.monitoring.dashboard.v1.XyChart.DataSet.PlotType) |
timeSeriesQuery
public timeSeriesQuery?: (google.monitoring.dashboard.v1.ITimeSeriesQuery|null);
DataSet timeSeriesQuery.
Type | Description |
---|---|
(google.monitoring.dashboard.v1.ITimeSeriesQuery|null) |
Methods
create(properties)
public static create(properties?: google.monitoring.dashboard.v1.XyChart.IDataSet): google.monitoring.dashboard.v1.XyChart.DataSet;
Creates a new DataSet instance using the specified properties.
Type | Name | Description |
---|---|---|
IDataSet | properties |
Properties to set |
Type | Description |
---|---|
google.monitoring.dashboard.v1.XyChart.DataSet | DataSet instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.dashboard.v1.XyChart.DataSet;
Decodes a DataSet message from the specified reader or buffer.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
number | length |
Message length if known beforehand |
Type | Description |
---|---|
google.monitoring.dashboard.v1.XyChart.DataSet | DataSet |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.dashboard.v1.XyChart.DataSet;
Decodes a DataSet message from the specified reader or buffer, length delimited.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
Type | Description |
---|---|
google.monitoring.dashboard.v1.XyChart.DataSet | DataSet |
encode(message, writer)
public static encode(message: google.monitoring.dashboard.v1.XyChart.IDataSet, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified DataSet message. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IDataSet | message |
DataSet message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.monitoring.dashboard.v1.XyChart.IDataSet, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified DataSet message, length delimited. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IDataSet | message |
DataSet message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.monitoring.dashboard.v1.XyChart.DataSet;
Creates a DataSet message from a plain object. Also converts values to their respective internal types.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | object |
Plain object |
Type | Description |
---|---|
google.monitoring.dashboard.v1.XyChart.DataSet | DataSet |
toJSON()
public toJSON(): { [k: string]: any };
Converts this DataSet to JSON.
Type | Description |
---|---|
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.monitoring.dashboard.v1.XyChart.DataSet, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a DataSet message. Also converts values to other types if specified.
Type | Name | Description |
---|---|---|
google.monitoring.dashboard.v1.XyChart.DataSet | message |
DataSet |
$protobuf.IConversionOptions | options |
Conversion options |
Type | Description |
---|---|
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a DataSet message.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | message |
Plain object to verify |
Type | Description |
---|---|
(string|null) |
|