Capacity Planner v1beta API - Class QueryReservationsRequest (1.0.0-beta01)

public sealed class QueryReservationsRequest : IMessage<QueryReservationsRequest>, IEquatable<QueryReservationsRequest>, IDeepCloneable<QueryReservationsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Capacity Planner v1beta API class QueryReservationsRequest.

The QueryReservations request.

Inheritance

object > QueryReservationsRequest

Namespace

Google.Cloud.CapacityPlanner.V1Beta

Assembly

Google.Cloud.CapacityPlanner.V1Beta.dll

Constructors

QueryReservationsRequest()

public QueryReservationsRequest()

QueryReservationsRequest(QueryReservationsRequest)

public QueryReservationsRequest(QueryReservationsRequest other)
Parameter
Name Description
other QueryReservationsRequest

Properties

AggregationMethod

public UsageHistory.Types.AggregationMethod AggregationMethod { get; set; }

Optional. Aggregation Method of the historical reservation usage

Property Value
Type Description
UsageHistoryTypesAggregationMethod

CloudResourceType

public string CloudResourceType { get; set; }

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

Property Value
Type Description
string

EndDate

public Date EndDate { get; set; }

Optional. The end date of reservations usage.

Property Value
Type Description
Date

GpuType

public string GpuType { get; set; }

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.

Property Value
Type Description
string

IncludeUnapprovedReservations

public bool IncludeUnapprovedReservations { get; set; }

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

Property Value
Type Description
bool

LocationLevel

public TimeSeries.Types.LocationType LocationLevel { get; set; }

Optional. The location level of the reservations usage timeseries.

Property Value
Type Description
TimeSeriesTypesLocationType

MachineFamily

public string MachineFamily { get; set; }

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.

Property Value
Type Description
string

MachineShape

public MachineShape MachineShape { get; set; }

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

Property Value
Type Description
MachineShape

OwnershipType

public QueryReservationsRequest.Types.OwnershipType OwnershipType { get; set; }

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.

Property Value
Type Description
QueryReservationsRequestTypesOwnershipType

Parent

public string Parent { get; set; }

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}

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName

ReservationDataLevel

public QueryReservationsRequest.Types.ReservationDataLevel ReservationDataLevel { get; set; }

Required. Reservations output data format.

Property Value
Type Description
QueryReservationsRequestTypesReservationDataLevel

ReservationType

public QueryReservationsRequest.Types.ReservationType ReservationType { get; set; }

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

Property Value
Type Description
QueryReservationsRequestTypesReservationType

ShareType

public QueryReservationsRequest.Types.ShareType ShareType { get; set; }

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

Property Value
Type Description
QueryReservationsRequestTypesShareType

StartDate

public Date StartDate { get; set; }

Optional. The start date of reservations usage.

Property Value
Type Description
Date