Class QueryReservationsRequest (0.1.0)

public final class QueryReservationsRequest extends GeneratedMessageV3 implements QueryReservationsRequestOrBuilder

The QueryReservations request.

Protobuf type google.cloud.capacityplanner.v1beta.QueryReservationsRequest

Static Fields

AGGREGATION_METHOD_FIELD_NUMBER

public static final int AGGREGATION_METHOD_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_RESOURCE_TYPE_FIELD_NUMBER

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

INCLUDE_UNAPPROVED_RESERVATIONS_FIELD_NUMBER

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

OWNERSHIP_TYPE_FIELD_NUMBER

public static final int OWNERSHIP_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

RESERVATION_DATA_LEVEL_FIELD_NUMBER

public static final int RESERVATION_DATA_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

RESERVATION_TYPE_FIELD_NUMBER

public static final int RESERVATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SHARE_TYPE_FIELD_NUMBER

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

Static Methods

getDefaultInstance()

public static QueryReservationsRequest getDefaultInstance()
Returns
Type Description
QueryReservationsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(QueryReservationsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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

getDefaultInstanceForType()

public QueryReservationsRequest getDefaultInstanceForType()
Returns
Type Description
QueryReservationsRequest

getEndDate()

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

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
ByteString

The bytes for gpuType.

getIncludeUnapprovedReservations()

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

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
ByteString

The bytes for machineFamily.

getMachineShape()

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

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
int

The enum numeric value on the wire for ownershipType.

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

getReservationDataLevel()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShareType()

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

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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