Interface QueryUsageHistoriesRequestOrBuilder (0.1.0) 

public interface QueryUsageHistoriesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCloudResourceType()

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

getDiskType()

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

getStartDate()

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