Interface QueryForecastsRequestOrBuilder (0.1.0)

public interface QueryForecastsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregationMethod()

public abstract 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 abstract 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 abstract 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 abstract ByteString getCloudResourceTypeBytes()

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

Returns
Type	Description
`ByteString`	The bytes for cloudResourceType.

getConfidentialMode()

public abstract 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.

getDiskType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ByteString getGpuTypeBytes()

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

Returns
Type	Description
`ByteString`	The bytes for gpuType.

getMachineFamily()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getPredictionInterval()

public abstract 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 abstract 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.

getTpuType()

public abstract 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 abstract 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 abstract 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.