Class QueryForecastsRequest (0.1.0)

public final class QueryForecastsRequest extends GeneratedMessageV3 implements QueryForecastsRequestOrBuilder

The QueryForecasts request. Next : 14

Protobuf type google.cloud.capacityplanner.v1beta.QueryForecastsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > QueryForecastsRequest

Implements

QueryForecastsRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

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

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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

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

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

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

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

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

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

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

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

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

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

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.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

CLOUD_RESOURCE_TYPE_FIELD_NUMBER

public static final int CLOUD_RESOURCE_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

CONFIDENTIAL_MODE_FIELD_NUMBER

public static final int CONFIDENTIAL_MODE_FIELD_NUMBER

Field Value
Type	Description
int

DISK_TYPE_FIELD_NUMBER

public static final int DISK_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

FORECAST_TYPE_FIELD_NUMBER

public static final int FORECAST_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

GPU_TYPE_FIELD_NUMBER

public static final int GPU_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

MACHINE_FAMILY_FIELD_NUMBER

public static final int MACHINE_FAMILY_FIELD_NUMBER

Field Value
Type	Description
int

MACHINE_SHAPE_FIELD_NUMBER

public static final int MACHINE_SHAPE_FIELD_NUMBER

Field Value
Type	Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

Field Value
Type	Description
int

PREDICTION_INTERVAL_FIELD_NUMBER

public static final int PREDICTION_INTERVAL_FIELD_NUMBER

Field Value
Type	Description
int

TPU_TYPE_FIELD_NUMBER

public static final int TPU_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static QueryForecastsRequest getDefaultInstance()

Returns
Type	Description
QueryForecastsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static QueryForecastsRequest.Builder newBuilder()

Returns
Type	Description
QueryForecastsRequest.Builder

newBuilder(QueryForecastsRequest prototype)

public static QueryForecastsRequest.Builder newBuilder(QueryForecastsRequest prototype)

Parameter
Name	Description
prototype	QueryForecastsRequest

Returns
Type	Description
QueryForecastsRequest.Builder

parseDelimitedFrom(InputStream input)

public static QueryForecastsRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryForecastsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static QueryForecastsRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QueryForecastsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QueryForecastsRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QueryForecastsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QueryForecastsRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryForecastsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static QueryForecastsRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryForecastsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static QueryForecastsRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QueryForecastsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
QueryForecastsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<QueryForecastsRequest> parser()

Returns
Type	Description
Parser<QueryForecastsRequest>

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 = 8;

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 = 8;

Returns
Type	Description
int	The enum numeric value on the wire for aggregationMethod.

getCloudResourceType()

public String getCloudResourceType()

Required. The resource for the Forecast values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", "gce-persistent-disk", "gce-gpu" and "gce-tpu". Empty cloud_resource_type will return results matching all resources.

string cloud_resource_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The cloudResourceType.

getCloudResourceTypeBytes()

public ByteString getCloudResourceTypeBytes()

Required. The resource for the Forecast values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", "gce-persistent-disk", "gce-gpu" and "gce-tpu". Empty cloud_resource_type will return results matching all resources.

string cloud_resource_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for cloudResourceType.

getConfidentialMode()

public boolean getConfidentialMode()

Optional. Whether the persistent disk is in confidential mode.

bool confidential_mode = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The confidentialMode.

getDefaultInstanceForType()

public QueryForecastsRequest getDefaultInstanceForType()

Returns
Type	Description
QueryForecastsRequest

getDiskType()

public String getDiskType()

Optional. The disk_type for the Forecast values to return with request persistent-disk cloud_resource_type. Empty disk_type will return results matching all disk types.

string disk_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The diskType.

getDiskTypeBytes()

public ByteString getDiskTypeBytes()

Optional. The disk_type for the Forecast values to return with request persistent-disk cloud_resource_type. Empty disk_type will return results matching all disk types.

string disk_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for diskType.

getForecastType()

public Forecast.ForecastType getForecastType()

The type of forecast to use to select the Forecast values to return. FORECAST_TYPE_UNSPECIFIED will return results matching all the forecast types.

.google.cloud.capacityplanner.v1beta.Forecast.ForecastType forecast_type = 4;

Returns
Type	Description
Forecast.ForecastType	The forecastType.

getForecastTypeValue()

public int getForecastTypeValue()

The type of forecast to use to select the Forecast values to return. FORECAST_TYPE_UNSPECIFIED will return results matching all the forecast types.

.google.cloud.capacityplanner.v1beta.Forecast.ForecastType forecast_type = 4;

Returns
Type	Description
int	The enum numeric value on the wire for forecastType.

getGpuType()

public String getGpuType()

Optional. The GPU type for the Forecast values to return. Sample values are "nvidia-tesla-t4", and "nvidia-tesla-a100". See https://cloud.google.com/compute/docs/gpus for a list. Empty gpu_type will return results matching all GPUs.

string gpu_type = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The gpuType.

getGpuTypeBytes()

public ByteString getGpuTypeBytes()

Optional. The GPU type for the Forecast values to return. Sample values are "nvidia-tesla-t4", and "nvidia-tesla-a100". See https://cloud.google.com/compute/docs/gpus for a list. Empty gpu_type will return results matching all GPUs.

string gpu_type = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for gpuType.

getMachineFamily()

public String getMachineFamily()

The machine family to use to select the Forecast values to return. Possible values include "n1", and "n2d". Empty machine_family will return results matching all machine families.

string machine_family = 2;

Returns
Type	Description
String	The machineFamily.

getMachineFamilyBytes()

public ByteString getMachineFamilyBytes()

The machine family to use to select the Forecast values to return. Possible values include "n1", and "n2d". Empty machine_family will return results matching all machine families.

string machine_family = 2;

Returns
Type	Description
ByteString	The bytes for machineFamily.

getMachineShape()

public MachineShape getMachineShape()

Optional. The machine shape for the time series values to return.

.google.cloud.capacityplanner.v1beta.MachineShape machine_shape = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
MachineShape	The machineShape.

getMachineShapeOrBuilder()

public MachineShapeOrBuilder getMachineShapeOrBuilder()

Optional. The machine shape for the time series values to return.

.google.cloud.capacityplanner.v1beta.MachineShape machine_shape = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
MachineShapeOrBuilder

getParent()

public String getParent()

Required. The compute engine resource and location for the time series values to return. The format is:

projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The compute engine resource and location for the time series values to return. The format is:

projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.

getParserForType()

public Parser<QueryForecastsRequest> getParserForType()

Returns
Type	Description
Parser<QueryForecastsRequest>

Overrides

GeneratedMessageV3.getParserForType()

getPredictionInterval()

public Forecast.PredictionInterval getPredictionInterval()

The prediction interval to use to select the Forecast values to return. PREDICTION_INTERVAL_UNSPECIFIED will return results matching all prediction intervals.

.google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval prediction_interval = 5;

Returns
Type	Description
Forecast.PredictionInterval	The predictionInterval.

getPredictionIntervalValue()

public int getPredictionIntervalValue()

The prediction interval to use to select the Forecast values to return. PREDICTION_INTERVAL_UNSPECIFIED will return results matching all prediction intervals.

.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

GeneratedMessageV3.getSerializedSize()

getTpuType()

public String getTpuType()

Optional. The TPU type for the Forecast values to return. Empty tpu_type will return results matching all TPUs.

string tpu_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The tpuType.

getTpuTypeBytes()

public ByteString getTpuTypeBytes()

Optional. The TPU type for the Forecast values to return. Empty tpu_type will return results matching all TPUs.

string tpu_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for tpuType.

hasMachineShape()

public boolean hasMachineShape()

Optional. The machine shape for the time series values to return.

.google.cloud.capacityplanner.v1beta.MachineShape machine_shape = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the machineShape field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public QueryForecastsRequest.Builder newBuilderForType()

Returns
Type	Description
QueryForecastsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QueryForecastsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
QueryForecastsRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public QueryForecastsRequest.Builder toBuilder()

Returns
Type	Description
QueryForecastsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException