Class Forecast (0.6.0)

Version latest

• 0.6.0 (latest)
• 0.5.0
• 0.4.0
• 0.3.0
• 0.1.0

public final class Forecast extends GeneratedMessage implements ForecastOrBuilder

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

Protobuf type google.cloud.capacityplanner.v1beta.Forecast

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Forecast

Implements

ForecastOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessage.getParserForType()

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

GeneratedMessage.getSerializedSize()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public Forecast.Builder newBuilderForType()

Returns
Type	Description
Forecast.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Forecast.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Forecast.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public Forecast.Builder toBuilder()

Returns
Type	Description
Forecast.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException