Class QueryUsageHistoriesRequest (0.1.0)

public final class QueryUsageHistoriesRequest extends GeneratedMessageV3 implements QueryUsageHistoriesRequestOrBuilder

The QueryUsageHistories request. Next : 16

Protobuf type google.cloud.capacityplanner.v1beta.QueryUsageHistoriesRequest

Static Fields

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

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

LOCATION_LEVEL_FIELD_NUMBER

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

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 QueryUsageHistoriesRequest getDefaultInstance()
Returns
Type Description
QueryUsageHistoriesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(QueryUsageHistoriesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCloudResourceType()

public String getCloudResourceType()

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

Returns
Type Description
boolean

The confidentialMode.

getDefaultInstanceForType()

public QueryUsageHistoriesRequest getDefaultInstanceForType()
Returns
Type Description
QueryUsageHistoriesRequest

getDiskType()

public String getDiskType()

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

string disk_type = 7 [(.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 cloud_resource_type. Empty disk_type will return results matching all disk types.

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

Returns
Type Description
ByteString

The bytes for diskType.

getEndDate()

public Date getEndDate()

Optional. The end date of reservations usage.

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

Returns
Type Description
com.google.type.Date

The endDate.

getEndDateOrBuilder()

public DateOrBuilder getEndDateOrBuilder()

Optional. The end date of reservations usage.

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

Returns
Type Description
ByteString

The bytes for gpuType.

getIsSpot()

public boolean getIsSpot()

Optional. The is_spot flag is used to fetch the usage data for preemptible Resources.

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

Returns
Type Description
boolean

The isSpot.

getLocationLevel()

public TimeSeries.LocationType getLocationLevel()

Optional. The location level of the reservations usage timeseries.

.google.cloud.capacityplanner.v1beta.TimeSeries.LocationType location_level = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimeSeries.LocationType

The locationLevel.

getLocationLevelValue()

public int getLocationLevelValue()

Optional. The location level of the reservations usage timeseries.

.google.cloud.capacityplanner.v1beta.TimeSeries.LocationType location_level = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for locationLevel.

getMachineFamily()

public String getMachineFamily()

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. 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 for the UsageHistory values to return. Possible values include "n1", and "n2d". See https://cloud.google.com/compute/docs/machine-types for more examples. 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 UsageHistory values to return.

.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 UsageHistory values to return.

.google.cloud.capacityplanner.v1beta.MachineShape machine_shape = 13 [(.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<QueryUsageHistoriesRequest> getParserForType()
Returns
Type Description
Parser<QueryUsageHistoriesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartDate()

public Date getStartDate()

Optional. The start date of reservations usage.

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

Returns
Type Description
com.google.type.Date

The startDate.

getStartDateOrBuilder()

public DateOrBuilder getStartDateOrBuilder()

Optional. The start date of reservations usage.

.google.type.Date start_date = 9 [(.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 = 12 [(.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 = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for tpuType.

getUsageAggregationMethod()

public UsageHistory.AggregationMethod getUsageAggregationMethod()

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

Returns
Type Description
UsageHistory.AggregationMethod

The usageAggregationMethod.

getUsageAggregationMethodValue()

public int getUsageAggregationMethodValue()

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

Returns
Type Description
int

The enum numeric value on the wire for usageAggregationMethod.

hasEndDate()

public boolean hasEndDate()

Optional. The end date of reservations usage.

.google.type.Date end_date = 10 [(.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 UsageHistory values to return.

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

Returns
Type Description
boolean

Whether the machineShape field is set.

hasStartDate()

public boolean hasStartDate()

Optional. The start date of reservations usage.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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