public static final class Forecast.Builder extends GeneratedMessageV3.Builder<Forecast.Builder> implements ForecastOrBuilderA collection of data points that describes the predicted time-varying values of a resource.
Protobuf type google.cloud.capacityplanner.v1beta.Forecast
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Forecast.BuilderImplements
ForecastOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Forecast.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
build()
public Forecast build()| Returns | |
|---|---|
| Type | Description |
Forecast |
|
buildPartial()
public Forecast buildPartial()| Returns | |
|---|---|
| Type | Description |
Forecast |
|
clear()
public Forecast.Builder clear()| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
clearAggregationMethod()
public Forecast.Builder clearAggregationMethod()Aggregation Method of the historical usage for which the forecast is generated
.google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod aggregation_method = 6;
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
clearBounds()
public Forecast.Builder clearBounds()The bounds represented by this forecast time series.
.google.cloud.capacityplanner.v1beta.Forecast.Bounds bounds = 4;
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Forecast.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
clearForecastType()
public Forecast.Builder clearForecastType()The type of forecast.
.google.cloud.capacityplanner.v1beta.Forecast.ForecastType forecast_type = 3;
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
clearName()
public Forecast.Builder clearName() The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/forecasts/{forecast_id} or
organizations/{organization_id}/locations/{location_id}/forecasts/{forecast_id}
or folders/{folder_id}/locations/{location_id}/forecasts/{forecast_id}
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Forecast.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
clearPredictionInterval()
public Forecast.Builder clearPredictionInterval()The prediction interval represented by the time series.
.google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval prediction_interval = 5;
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
clearTimeSeries()
public Forecast.Builder clearTimeSeries()The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).
.google.cloud.capacityplanner.v1beta.TimeSeries time_series = 2;
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
clone()
public Forecast.Builder clone()| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
getAggregationMethod()
public UsageHistory.AggregationMethod getAggregationMethod()Aggregation Method of the historical usage for which the forecast is generated
.google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod aggregation_method = 6;
| Returns | |
|---|---|
| Type | Description |
UsageHistory.AggregationMethod |
The aggregationMethod. |
getAggregationMethodValue()
public int getAggregationMethodValue()Aggregation Method of the historical usage for which the forecast is generated
.google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod aggregation_method = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for aggregationMethod. |
getBounds()
public Forecast.Bounds getBounds()The bounds represented by this forecast time series.
.google.cloud.capacityplanner.v1beta.Forecast.Bounds bounds = 4;
| Returns | |
|---|---|
| Type | Description |
Forecast.Bounds |
The bounds. |
getBoundsValue()
public int getBoundsValue()The bounds represented by this forecast time series.
.google.cloud.capacityplanner.v1beta.Forecast.Bounds bounds = 4;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for bounds. |
getDefaultInstanceForType()
public Forecast getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Forecast |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getForecastType()
public Forecast.ForecastType getForecastType()The type of forecast.
.google.cloud.capacityplanner.v1beta.Forecast.ForecastType forecast_type = 3;
| Returns | |
|---|---|
| Type | Description |
Forecast.ForecastType |
The forecastType. |
getForecastTypeValue()
public int getForecastTypeValue()The type of forecast.
.google.cloud.capacityplanner.v1beta.Forecast.ForecastType forecast_type = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for forecastType. |
getName()
public String getName() The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/forecasts/{forecast_id} or
organizations/{organization_id}/locations/{location_id}/forecasts/{forecast_id}
or folders/{folder_id}/locations/{location_id}/forecasts/{forecast_id}
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/forecasts/{forecast_id} or
organizations/{organization_id}/locations/{location_id}/forecasts/{forecast_id}
or folders/{folder_id}/locations/{location_id}/forecasts/{forecast_id}
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getPredictionInterval()
public Forecast.PredictionInterval getPredictionInterval()The prediction interval represented by the time series.
.google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval prediction_interval = 5;
| Returns | |
|---|---|
| Type | Description |
Forecast.PredictionInterval |
The predictionInterval. |
getPredictionIntervalValue()
public int getPredictionIntervalValue()The prediction interval represented by the time series.
.google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval prediction_interval = 5;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for predictionInterval. |
getTimeSeries()
public TimeSeries getTimeSeries()The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).
.google.cloud.capacityplanner.v1beta.TimeSeries time_series = 2;
| Returns | |
|---|---|
| Type | Description |
TimeSeries |
The timeSeries. |
getTimeSeriesBuilder()
public TimeSeries.Builder getTimeSeriesBuilder()The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).
.google.cloud.capacityplanner.v1beta.TimeSeries time_series = 2;
| Returns | |
|---|---|
| Type | Description |
TimeSeries.Builder |
|
getTimeSeriesOrBuilder()
public TimeSeriesOrBuilder getTimeSeriesOrBuilder()The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).
.google.cloud.capacityplanner.v1beta.TimeSeries time_series = 2;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesOrBuilder |
|
hasTimeSeries()
public boolean hasTimeSeries()The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).
.google.cloud.capacityplanner.v1beta.TimeSeries time_series = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the timeSeries field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Forecast other)
public Forecast.Builder mergeFrom(Forecast other)| Parameter | |
|---|---|
| Name | Description |
other |
Forecast |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Forecast.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Forecast.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
mergeTimeSeries(TimeSeries value)
public Forecast.Builder mergeTimeSeries(TimeSeries value)The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).
.google.cloud.capacityplanner.v1beta.TimeSeries time_series = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
TimeSeries |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Forecast.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
setAggregationMethod(UsageHistory.AggregationMethod value)
public Forecast.Builder setAggregationMethod(UsageHistory.AggregationMethod value)Aggregation Method of the historical usage for which the forecast is generated
.google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod aggregation_method = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
UsageHistory.AggregationMethodThe aggregationMethod to set. |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
setAggregationMethodValue(int value)
public Forecast.Builder setAggregationMethodValue(int value)Aggregation Method of the historical usage for which the forecast is generated
.google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod aggregation_method = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for aggregationMethod to set. |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
setBounds(Forecast.Bounds value)
public Forecast.Builder setBounds(Forecast.Bounds value)The bounds represented by this forecast time series.
.google.cloud.capacityplanner.v1beta.Forecast.Bounds bounds = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Forecast.BoundsThe bounds to set. |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
setBoundsValue(int value)
public Forecast.Builder setBoundsValue(int value)The bounds represented by this forecast time series.
.google.cloud.capacityplanner.v1beta.Forecast.Bounds bounds = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for bounds to set. |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Forecast.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
setForecastType(Forecast.ForecastType value)
public Forecast.Builder setForecastType(Forecast.ForecastType value)The type of forecast.
.google.cloud.capacityplanner.v1beta.Forecast.ForecastType forecast_type = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
Forecast.ForecastTypeThe forecastType to set. |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
setForecastTypeValue(int value)
public Forecast.Builder setForecastTypeValue(int value)The type of forecast.
.google.cloud.capacityplanner.v1beta.Forecast.ForecastType forecast_type = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for forecastType to set. |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
setName(String value)
public Forecast.Builder setName(String value) The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/forecasts/{forecast_id} or
organizations/{organization_id}/locations/{location_id}/forecasts/{forecast_id}
or folders/{folder_id}/locations/{location_id}/forecasts/{forecast_id}
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Forecast.Builder setNameBytes(ByteString value) The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/forecasts/{forecast_id} or
organizations/{organization_id}/locations/{location_id}/forecasts/{forecast_id}
or folders/{folder_id}/locations/{location_id}/forecasts/{forecast_id}
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
setPredictionInterval(Forecast.PredictionInterval value)
public Forecast.Builder setPredictionInterval(Forecast.PredictionInterval value)The prediction interval represented by the time series.
.google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval prediction_interval = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
Forecast.PredictionIntervalThe predictionInterval to set. |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
setPredictionIntervalValue(int value)
public Forecast.Builder setPredictionIntervalValue(int value)The prediction interval represented by the time series.
.google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval prediction_interval = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for predictionInterval to set. |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Forecast.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
setTimeSeries(TimeSeries value)
public Forecast.Builder setTimeSeries(TimeSeries value)The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).
.google.cloud.capacityplanner.v1beta.TimeSeries time_series = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
TimeSeries |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
setTimeSeries(TimeSeries.Builder builderForValue)
public Forecast.Builder setTimeSeries(TimeSeries.Builder builderForValue)The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).
.google.cloud.capacityplanner.v1beta.TimeSeries time_series = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TimeSeries.Builder |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Forecast.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Forecast.Builder |
|