Interface QueryReservationsRequestOrBuilder (0.1.0)

public interface QueryReservationsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregationMethod()

public abstract UsageHistory.AggregationMethod getAggregationMethod()

Optional. Aggregation Method of the historical reservation usage

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

Returns
Type	Description
`UsageHistory.AggregationMethod`	The aggregationMethod.

getAggregationMethodValue()

public abstract int getAggregationMethodValue()

Optional. Aggregation Method of the historical reservation usage

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

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

getCloudResourceType()

public abstract String getCloudResourceType()

Required. The resource for the reserved values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", "gce-gpu" and "gce-vm".

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

Returns
Type	Description
`String`	The cloudResourceType.

getCloudResourceTypeBytes()

public abstract ByteString getCloudResourceTypeBytes()

Required. The resource for the reserved values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", "gce-gpu" and "gce-vm".

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

Returns
Type	Description
`ByteString`	The bytes for cloudResourceType.

getEndDate()

public abstract Date getEndDate()

Optional. The end date of reservations usage.

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

Returns
Type	Description
`com.google.type.DateOrBuilder`

getGpuType()

public abstract String getGpuType()

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

Returns
Type	Description
`String`	The gpuType.

getGpuTypeBytes()

public abstract ByteString getGpuTypeBytes()

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

Returns
Type	Description
`ByteString`	The bytes for gpuType.

getIncludeUnapprovedReservations()

public abstract boolean getIncludeUnapprovedReservations()

Optional. Whether to include pending for approval reservations in the response. This field is only applicable for future reservations.

bool include_unapproved_reservations = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The includeUnapprovedReservations.

getLocationLevel()

public abstract TimeSeries.LocationType getLocationLevel()

Optional. The location level of the reservations usage timeseries.

.google.cloud.capacityplanner.v1beta.TimeSeries.LocationType location_level = 16 [(.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 = 16 [(.google.api.field_behavior) = OPTIONAL];

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

getMachineFamily()

public abstract String getMachineFamily()

Optional. The machine family to use to select the aggregate reserved values to return. Possible values include "n1", and "n2d" etc. Empty machine_family will return results matching all machine families.

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

Returns
Type	Description
`String`	The machineFamily.

getMachineFamilyBytes()

public abstract ByteString getMachineFamilyBytes()

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 as a filter to select matching reservations.

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

Returns
Type	Description
`MachineShape`	The machineShape.

getMachineShapeOrBuilder()

public abstract MachineShapeOrBuilder getMachineShapeOrBuilder()

Optional. The machine_shape as a filter to select matching reservations.

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

Returns
Type	Description
`MachineShapeOrBuilder`

getOwnershipType()

public abstract QueryReservationsRequest.OwnershipType getOwnershipType()

Optional. Types of ownerships to filter reservations based on. In case of OWNED, it filters reservations which are owned by selected parent project/folder/organization. If unspecified, all types are included.

.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.OwnershipType ownership_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`QueryReservationsRequest.OwnershipType`	The ownershipType.

getOwnershipTypeValue()

public abstract int getOwnershipTypeValue()

.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.OwnershipType ownership_type = 7 [(.google.api.field_behavior) = OPTIONAL];

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

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.

getReservationDataLevel()

public abstract QueryReservationsRequest.ReservationDataLevel getReservationDataLevel()

Required. Reservations output data format.

.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.ReservationDataLevel reservation_data_level = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`QueryReservationsRequest.ReservationDataLevel`	The reservationDataLevel.

getReservationDataLevelValue()

public abstract int getReservationDataLevelValue()

Required. Reservations output data format.

.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.ReservationDataLevel reservation_data_level = 8 [(.google.api.field_behavior) = REQUIRED];

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

getReservationType()

public abstract QueryReservationsRequest.ReservationType getReservationType()

Required. The Reservation type for example, future reservation request and allocation. If unspecified, all types are included.

.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.ReservationType reservation_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`QueryReservationsRequest.ReservationType`	The reservationType.

getReservationTypeValue()

public abstract int getReservationTypeValue()

Required. The Reservation type for example, future reservation request and allocation. If unspecified, all types are included.

.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.ReservationType reservation_type = 5 [(.google.api.field_behavior) = REQUIRED];

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

getShareType()

public abstract QueryReservationsRequest.ShareType getShareType()

Optional. Types of share settings to filter reservations in response. If unspecified, all types are included.

.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.ShareType share_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`QueryReservationsRequest.ShareType`	The shareType.

getShareTypeValue()

public abstract int getShareTypeValue()

Optional. Types of share settings to filter reservations in response. If unspecified, all types are included.

.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.ShareType share_type = 6 [(.google.api.field_behavior) = OPTIONAL];

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

getStartDate()

public abstract Date getStartDate()

Optional. The start date of reservations usage.

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

Returns
Type	Description
`com.google.type.DateOrBuilder`

hasEndDate()

public abstract boolean hasEndDate()

Optional. The end date of reservations usage.

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

Returns
Type	Description
`boolean`	Whether the endDate field is set.

hasMachineShape()

public abstract boolean hasMachineShape()

Optional. The machine_shape as a filter to select matching reservations.

.google.cloud.capacityplanner.v1beta.MachineShape machine_shape = 11 [(.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 = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the startDate field is set.