Class TimeSeries.Builder (0.58.0)

public static final class TimeSeries.Builder extends GeneratedMessageV3.Builder<TimeSeries.Builder> implements TimeSeriesOrBuilder

The metrics object for a SubTask.

Protobuf type google.cloud.bigquery.migration.v2.TimeSeries

Implements

TimeSeriesOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllPoints(Iterable<? extends Point> values)

public TimeSeries.Builder addAllPoints(Iterable<? extends Point> values)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.cloud.bigquery.migration.v2.Point>
Returns
Type Description
TimeSeries.Builder

addPoints(Point value)

public TimeSeries.Builder addPoints(Point value)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Point
Returns
Type Description
TimeSeries.Builder

addPoints(Point.Builder builderForValue)

public TimeSeries.Builder addPoints(Point.Builder builderForValue)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Point.Builder
Returns
Type Description
TimeSeries.Builder

addPoints(int index, Point value)

public TimeSeries.Builder addPoints(int index, Point value)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value Point
Returns
Type Description
TimeSeries.Builder

addPoints(int index, Point.Builder builderForValue)

public TimeSeries.Builder addPoints(int index, Point.Builder builderForValue)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue Point.Builder
Returns
Type Description
TimeSeries.Builder

addPointsBuilder()

public Point.Builder addPointsBuilder()

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Point.Builder

addPointsBuilder(int index)

public Point.Builder addPointsBuilder(int index)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Point.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TimeSeries.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TimeSeries.Builder
Overrides

build()

public TimeSeries build()
Returns
Type Description
TimeSeries

buildPartial()

public TimeSeries buildPartial()
Returns
Type Description
TimeSeries

clear()

public TimeSeries.Builder clear()
Returns
Type Description
TimeSeries.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public TimeSeries.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TimeSeries.Builder
Overrides

clearMetric()

public TimeSeries.Builder clearMetric()

Required. The name of the metric.

If the metric is not known by the service yet, it will be auto-created.

string metric = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TimeSeries.Builder

This builder for chaining.

clearMetricKind()

public TimeSeries.Builder clearMetricKind()

Optional. The metric kind of the time series.

If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

.google.api.MetricDescriptor.MetricKind metric_kind = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimeSeries.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TimeSeries.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TimeSeries.Builder
Overrides

clearPoints()

public TimeSeries.Builder clearPoints()

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TimeSeries.Builder

clearValueType()

public TimeSeries.Builder clearValueType()

Required. The value type of the time series.

.google.api.MetricDescriptor.ValueType value_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TimeSeries.Builder

This builder for chaining.

clone()

public TimeSeries.Builder clone()
Returns
Type Description
TimeSeries.Builder
Overrides

getDefaultInstanceForType()

public TimeSeries getDefaultInstanceForType()
Returns
Type Description
TimeSeries

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMetric()

public String getMetric()

Required. The name of the metric.

If the metric is not known by the service yet, it will be auto-created.

string metric = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The metric.

getMetricBytes()

public ByteString getMetricBytes()

Required. The name of the metric.

If the metric is not known by the service yet, it will be auto-created.

string metric = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for metric.

getMetricKind()

public MetricDescriptor.MetricKind getMetricKind()

Optional. The metric kind of the time series.

If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

.google.api.MetricDescriptor.MetricKind metric_kind = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.api.MetricDescriptor.MetricKind

The metricKind.

getMetricKindValue()

public int getMetricKindValue()

Optional. The metric kind of the time series.

If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

.google.api.MetricDescriptor.MetricKind metric_kind = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for metricKind.

getPoints(int index)

public Point getPoints(int index)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Point

getPointsBuilder(int index)

public Point.Builder getPointsBuilder(int index)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Point.Builder

getPointsBuilderList()

public List<Point.Builder> getPointsBuilderList()

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getPointsCount()

public int getPointsCount()

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getPointsList()

public List<Point> getPointsList()

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Point>

getPointsOrBuilder(int index)

public PointOrBuilder getPointsOrBuilder(int index)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
PointOrBuilder

getPointsOrBuilderList()

public List<? extends PointOrBuilder> getPointsOrBuilderList()

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.bigquery.migration.v2.PointOrBuilder>

getValueType()

public MetricDescriptor.ValueType getValueType()

Required. The value type of the time series.

.google.api.MetricDescriptor.ValueType value_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.api.MetricDescriptor.ValueType

The valueType.

getValueTypeValue()

public int getValueTypeValue()

Required. The value type of the time series.

.google.api.MetricDescriptor.ValueType value_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for valueType.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TimeSeries other)

public TimeSeries.Builder mergeFrom(TimeSeries other)
Parameter
Name Description
other TimeSeries
Returns
Type Description
TimeSeries.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TimeSeries.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TimeSeries.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TimeSeries.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TimeSeries.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TimeSeries.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TimeSeries.Builder
Overrides

removePoints(int index)

public TimeSeries.Builder removePoints(int index)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
TimeSeries.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TimeSeries.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TimeSeries.Builder
Overrides

setMetric(String value)

public TimeSeries.Builder setMetric(String value)

Required. The name of the metric.

If the metric is not known by the service yet, it will be auto-created.

string metric = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The metric to set.

Returns
Type Description
TimeSeries.Builder

This builder for chaining.

setMetricBytes(ByteString value)

public TimeSeries.Builder setMetricBytes(ByteString value)

Required. The name of the metric.

If the metric is not known by the service yet, it will be auto-created.

string metric = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for metric to set.

Returns
Type Description
TimeSeries.Builder

This builder for chaining.

setMetricKind(MetricDescriptor.MetricKind value)

public TimeSeries.Builder setMetricKind(MetricDescriptor.MetricKind value)

Optional. The metric kind of the time series.

If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

.google.api.MetricDescriptor.MetricKind metric_kind = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value com.google.api.MetricDescriptor.MetricKind

The metricKind to set.

Returns
Type Description
TimeSeries.Builder

This builder for chaining.

setMetricKindValue(int value)

public TimeSeries.Builder setMetricKindValue(int value)

Optional. The metric kind of the time series.

If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

.google.api.MetricDescriptor.MetricKind metric_kind = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for metricKind to set.

Returns
Type Description
TimeSeries.Builder

This builder for chaining.

setPoints(int index, Point value)

public TimeSeries.Builder setPoints(int index, Point value)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value Point
Returns
Type Description
TimeSeries.Builder

setPoints(int index, Point.Builder builderForValue)

public TimeSeries.Builder setPoints(int index, Point.Builder builderForValue)

Required. The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

repeated .google.cloud.bigquery.migration.v2.Point points = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue Point.Builder
Returns
Type Description
TimeSeries.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TimeSeries.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TimeSeries.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TimeSeries.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TimeSeries.Builder
Overrides

setValueType(MetricDescriptor.ValueType value)

public TimeSeries.Builder setValueType(MetricDescriptor.ValueType value)

Required. The value type of the time series.

.google.api.MetricDescriptor.ValueType value_type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value com.google.api.MetricDescriptor.ValueType

The valueType to set.

Returns
Type Description
TimeSeries.Builder

This builder for chaining.

setValueTypeValue(int value)

public TimeSeries.Builder setValueTypeValue(int value)

Required. The value type of the time series.

.google.api.MetricDescriptor.ValueType value_type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for valueType to set.

Returns
Type Description
TimeSeries.Builder

This builder for chaining.