Interface ExportForecastsRequestOrBuilder (0.1.0)

public interface ExportForecastsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregationMethod()

public abstract UsageHistory.AggregationMethod getAggregationMethod()

Optional. Aggregation Method of the historical usage for which the forecast is generated.

.google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod aggregation_method = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UsageHistory.AggregationMethod	The aggregationMethod.

getAggregationMethodValue()

public abstract int getAggregationMethodValue()

Optional. Aggregation Method of the historical usage for which the forecast is generated.

.google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod aggregation_method = 6 [(.google.api.field_behavior) = OPTIONAL];

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

getDiskType()

public abstract String getDiskType()

Optional. The disk_type for the Forecast values to return with request persistent-disk resource_type.

string disk_type = 3 [(.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 resource_type.

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

Returns
Type	Description
ByteString	The bytes for diskType.

getEndDate()

public abstract Date getEndDate()

Optional. The end date of forecasts.

.google.type.Date end_date = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
com.google.type.Date	The endDate.

getEndDateOrBuilder()

public abstract DateOrBuilder getEndDateOrBuilder()

Optional. The end date of forecasts.

.google.type.Date end_date = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
com.google.type.DateOrBuilder

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()

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 abstract String getMachineFamily()

Optional. The machine family to use to select the Forecast values to return. Possible values include "n1", and "n2d".

string machine_family = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The machineFamily.

getMachineFamilyBytes()

public abstract ByteString getMachineFamilyBytes()

Optional. The machine family to use to select the Forecast values to return. Possible values include "n1", and "n2d".

string machine_family = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for machineFamily.

getMachineShape()

public abstract MachineShape getMachineShape()

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

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

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

Returns
Type	Description
MachineShapeOrBuilder

getOutputConfig()

public abstract OutputConfig getOutputConfig()

Required. Output configuration indicating where the results will be output to.

.google.cloud.capacityplanner.v1beta.OutputConfig output_config = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
OutputConfig	The outputConfig.

getOutputConfigOrBuilder()

public abstract OutputConfigOrBuilder getOutputConfigOrBuilder()

Required. Output configuration indicating where the results will be output to.

.google.cloud.capacityplanner.v1beta.OutputConfig output_config = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
OutputConfigOrBuilder

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()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Forecast.PredictionInterval	The predictionInterval.

getPredictionIntervalValue()

public abstract int getPredictionIntervalValue()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

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

getResourceType()

public abstract String getResourceType()

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

string resource_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The resourceType.

getResourceTypeBytes()

public abstract ByteString getResourceTypeBytes()

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

string resource_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for resourceType.

getStartDate()

public abstract Date getStartDate()

Optional. The start date of forecasts.

.google.type.Date start_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
com.google.type.Date	The startDate.

getStartDateOrBuilder()

public abstract DateOrBuilder getStartDateOrBuilder()

Optional. The start date of forecasts.

.google.type.Date start_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
com.google.type.DateOrBuilder

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.

hasEndDate()

public abstract boolean hasEndDate()

Optional. The end date of forecasts.

.google.type.Date end_date = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the endDate field is set.

hasMachineShape()

public abstract boolean hasMachineShape()

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

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

Returns
Type	Description
boolean	Whether the machineShape field is set.

hasOutputConfig()

public abstract boolean hasOutputConfig()

Required. Output configuration indicating where the results will be output to.

.google.cloud.capacityplanner.v1beta.OutputConfig output_config = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the outputConfig field is set.

hasStartDate()

public abstract boolean hasStartDate()

Optional. The start date of forecasts.

.google.type.Date start_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the startDate field is set.