# Class QueryReservationsRequest (0.5.0)

0.5.0 (latest) 0.4.0 0.3.0 0.2.0 0.1.0

    QueryReservationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The `QueryReservations` request.

| ## Attributes ||
|---|---|
| **Name** | **Description** |
| `parent` | `str` 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} |
| `location_level` | `https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.TimeSeries.LocationType` Optional. The location level of the reservations usage timeseries. |
| `machine_family` | `str` 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. |
| `machine_shape` | `https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.MachineShape` Optional. The machine_shape as a filter to select matching reservations. |
| `gpu_type` | `str` 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. |
| `cloud_resource_type` | `str` Required. The resource for the reserved values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", "gce-gpu" and "gce-vm". |
| `reservation_type` | `https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest.ReservationType` Required. The Reservation type for example, future reservation request and allocation. If unspecified, all types are included. |
| `share_type` | `https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest.ShareType` Optional. Types of share settings to filter reservations in response. If unspecified, all types are included. |
| `ownership_type` | `https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest.OwnershipType` 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. |
| `reservation_data_level` | `https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest.ReservationDataLevel` Required. Reservations output data format. |
| `include_unapproved_reservations` | `bool` Optional. Whether to include pending for approval reservations in the response. This field is only applicable for future reservations. |
| `aggregation_method` | `https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.UsageHistory.AggregationMethod` Optional. Aggregation Method of the historical reservation usage |
| `start_date` | `google.type.date_pb2.Date` Optional. The start date of reservations usage. |
| `end_date` | `google.type.date_pb2.Date` Optional. The end date of reservations usage. |

## Classes

### OwnershipType

    OwnershipType(value)

Reservation ownership status to provide distinction for
Capacity Planning.

### ReservationDataLevel

    ReservationDataLevel(value)

The form in which data of reservations should be returned.
In case of AGGREGATED, timeseries for selected reservations is
returned. If unspecified, all levels are included.

### ReservationType

    ReservationType(value)

Type of the reservation

### ShareType

    ShareType(value)

Possible scope in which the reservation can be shared.