Class Forecast (0.1.0)

public final class Forecast extends GeneratedMessageV3 implements ForecastOrBuilder

A collection of data points that describes the predicted time-varying values of a resource.

Protobuf type google.cloud.capacityplanner.v1beta.Forecast

Implements

ForecastOrBuilder

Static Fields

AGGREGATION_METHOD_FIELD_NUMBER

public static final int AGGREGATION_METHOD_FIELD_NUMBER
Field Value
Type Description
int

BOUNDS_FIELD_NUMBER

public static final int BOUNDS_FIELD_NUMBER
Field Value
Type Description
int

FORECAST_TYPE_FIELD_NUMBER

public static final int FORECAST_TYPE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PREDICTION_INTERVAL_FIELD_NUMBER

public static final int PREDICTION_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

TIME_SERIES_FIELD_NUMBER

public static final int TIME_SERIES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Forecast getDefaultInstance()
Returns
Type Description
Forecast

getDescriptor()

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

newBuilder()

public static Forecast.Builder newBuilder()
Returns
Type Description
Forecast.Builder

newBuilder(Forecast prototype)

public static Forecast.Builder newBuilder(Forecast prototype)
Parameter
Name Description
prototype Forecast
Returns
Type Description
Forecast.Builder

parseDelimitedFrom(InputStream input)

public static Forecast parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Forecast
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Forecast parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Forecast
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Forecast parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Forecast
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Forecast parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Forecast
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Forecast parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Forecast
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Forecast parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Forecast
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Forecast parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Forecast
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Forecast parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Forecast
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Forecast parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Forecast
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Forecast parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Forecast
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Forecast parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Forecast
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Forecast parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Forecast
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Forecast> parser()
Returns
Type Description
Parser<Forecast>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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.

getParserForType()

public Parser<Forecast> getParserForType()
Returns
Type Description
Parser<Forecast>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Forecast.Builder newBuilderForType()
Returns
Type Description
Forecast.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Forecast.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Forecast.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Forecast.Builder toBuilder()
Returns
Type Description
Forecast.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException