DataSet

google.monitoring.dashboard.v1.XyChart. DataSet

Represents a DataSet.

Constructor

new DataSet(propertiesopt)

Constructs a new DataSet.

Parameters:
Name Type Attributes Description
properties google.monitoring.dashboard.v1.XyChart.IDataSet <optional>

Properties to set

Implements:
  • IDataSet

Members

legendTemplate

DataSet legendTemplate.

minAlignmentPeriod

DataSet minAlignmentPeriod.

plotType

DataSet plotType.

targetAxis

DataSet targetAxis.

timeSeriesQuery

DataSet timeSeriesQuery.

PlotType

PlotType enum.

Properties:
Name Type Description
PLOT_TYPE_UNSPECIFIED number

PLOT_TYPE_UNSPECIFIED value

LINE number

LINE value

STACKED_AREA number

STACKED_AREA value

STACKED_BAR number

STACKED_BAR value

HEATMAP number

HEATMAP value

TargetAxis

TargetAxis enum.

Properties:
Name Type Description
TARGET_AXIS_UNSPECIFIED number

TARGET_AXIS_UNSPECIFIED value

Y1 number

Y1 value

Y2 number

Y2 value

Methods

toJSON() → {Object.<string, *>}

Converts this DataSet to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.monitoring.dashboard.v1.XyChart.DataSet}

Creates a new DataSet instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.monitoring.dashboard.v1.XyChart.IDataSet <optional>

Properties to set

Returns:
Type Description
google.monitoring.dashboard.v1.XyChart.DataSet

DataSet instance

(static) decode(reader, lengthopt) → {google.monitoring.dashboard.v1.XyChart.DataSet}

Decodes a DataSet message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.monitoring.dashboard.v1.XyChart.DataSet

DataSet

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.monitoring.dashboard.v1.XyChart.DataSet}

Decodes a DataSet message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.monitoring.dashboard.v1.XyChart.DataSet

DataSet

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified DataSet message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.monitoring.dashboard.v1.XyChart.IDataSet

DataSet message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified DataSet message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.monitoring.dashboard.v1.XyChart.IDataSet

DataSet message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.monitoring.dashboard.v1.XyChart.DataSet}

Creates a DataSet message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.monitoring.dashboard.v1.XyChart.DataSet

DataSet

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for DataSet

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a DataSet message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.monitoring.dashboard.v1.XyChart.DataSet

DataSet

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a DataSet message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not