Class ExportForecastsRequest (0.1.0)

public final class ExportForecastsRequest extends GeneratedMessageV3 implements ExportForecastsRequestOrBuilder

The ExportForecasts request Next : 13

Protobuf type google.cloud.capacityplanner.v1beta.ExportForecastsRequest

Static Fields

AGGREGATION_METHOD_FIELD_NUMBER

public static final int AGGREGATION_METHOD_FIELD_NUMBER
Field Value
Type Description
int

DISK_TYPE_FIELD_NUMBER

public static final int DISK_TYPE_FIELD_NUMBER
Field Value
Type Description
int

END_DATE_FIELD_NUMBER

public static final int END_DATE_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

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_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

RESOURCE_TYPE_FIELD_NUMBER

public static final int RESOURCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

START_DATE_FIELD_NUMBER

public static final int START_DATE_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 ExportForecastsRequest getDefaultInstance()
Returns
Type Description
ExportForecastsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ExportForecastsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAggregationMethod()

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

getDefaultInstanceForType()

public ExportForecastsRequest getDefaultInstanceForType()
Returns
Type Description
ExportForecastsRequest

getDiskType()

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

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 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 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 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 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 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 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<ExportForecastsRequest> getParserForType()
Returns
Type Description
Parser<ExportForecastsRequest>
Overrides

getPredictionInterval()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartDate()

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

hasEndDate()

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

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 ExportForecastsRequest.Builder newBuilderForType()
Returns
Type Description
ExportForecastsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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