Class ExportUsageHistoriesRequest (0.1.0)

public final class ExportUsageHistoriesRequest extends GeneratedMessageV3 implements ExportUsageHistoriesRequestOrBuilder

The ExportUsageHistories request Next : 12

Protobuf type google.cloud.capacityplanner.v1beta.ExportUsageHistoriesRequest

Static Fields

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

IS_SPOT_FIELD_NUMBER

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

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

USAGE_AGGREGATION_METHOD_FIELD_NUMBER

public static final int USAGE_AGGREGATION_METHOD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportUsageHistoriesRequest getDefaultInstance()
Returns
Type Description
ExportUsageHistoriesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ExportUsageHistoriesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ExportUsageHistoriesRequest getDefaultInstanceForType()
Returns
Type Description
ExportUsageHistoriesRequest

getDiskType()

public String getDiskType()

Optional. The disk_type for the UsageHistory values to return request with persistent-disk resource_type. Possible values include "pd-ssd", "pd-standard", "pd-balanced", and "pd-extreme".

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 UsageHistory values to return request with persistent-disk resource_type. Possible values include "pd-ssd", "pd-standard", "pd-balanced", and "pd-extreme".

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

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

Returns
Type Description
com.google.type.Date

The endDate.

getEndDateOrBuilder()

public DateOrBuilder getEndDateOrBuilder()

Optional. The end date of usage.

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

Returns
Type Description
com.google.type.DateOrBuilder

getGpuType()

public String getGpuType()

Optional. The GPU type for the UsageHistory 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 = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The gpuType.

getGpuTypeBytes()

public ByteString getGpuTypeBytes()

Optional. The GPU type for the UsageHistory 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 = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for gpuType.

getIsSpot()

public boolean getIsSpot()

Optional. Set true to export usage for spot resources.

bool is_spot = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The isSpot.

getMachineFamily()

public String getMachineFamily()

Optional. The machine family for the UsageHistory values to return. Possible values include "n1", and "n2d". See https://cloud.google.com/compute/docs/machine-types for more examples.

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

Returns
Type Description
String

The machineFamily.

getMachineFamilyBytes()

public ByteString getMachineFamilyBytes()

Optional. The machine family for the UsageHistory values to return. Possible values include "n1", and "n2d". See https://cloud.google.com/compute/docs/machine-types for more examples.

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 = 13 [(.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 = 13 [(.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 = 8 [(.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 = 8 [(.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<ExportUsageHistoriesRequest> getParserForType()
Returns
Type Description
Parser<ExportUsageHistoriesRequest>
Overrides

getResourceType()

public String getResourceType()

Required. The resource for the UsageHistory 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 UsageHistory 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 usage.

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

Returns
Type Description
com.google.type.Date

The startDate.

getStartDateOrBuilder()

public DateOrBuilder getStartDateOrBuilder()

Optional. The start date of usage.

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

Returns
Type Description
com.google.type.DateOrBuilder

getTpuType()

public String getTpuType()

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

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

Returns
Type Description
String

The tpuType.

getTpuTypeBytes()

public ByteString getTpuTypeBytes()

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

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

Returns
Type Description
ByteString

The bytes for tpuType.

getUsageAggregationMethod()

public UsageHistory.AggregationMethod getUsageAggregationMethod()

Optional. The method that should be used to convert sampled usage data to daily usage values. AGGREGATION_METHOD_UNSPECIFIED will return results matching all the aggregation methods.

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

Returns
Type Description
UsageHistory.AggregationMethod

The usageAggregationMethod.

getUsageAggregationMethodValue()

public int getUsageAggregationMethodValue()

Optional. The method that should be used to convert sampled usage data to daily usage values. AGGREGATION_METHOD_UNSPECIFIED will return results matching all the aggregation methods.

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

Returns
Type Description
int

The enum numeric value on the wire for usageAggregationMethod.

hasEndDate()

public boolean hasEndDate()

Optional. The end date of usage.

.google.type.Date end_date = 7 [(.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 = 13 [(.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 = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the outputConfig field is set.

hasStartDate()

public boolean hasStartDate()

Optional. The start date of usage.

.google.type.Date start_date = 6 [(.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 ExportUsageHistoriesRequest.Builder newBuilderForType()
Returns
Type Description
ExportUsageHistoriesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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