Reference documentation and code samples for the Google Cloud Capacity Planner V1beta Client class QueryReservationsRequest.
The QueryReservations request.
Generated from protobuf message google.cloud.capacityplanner.v1beta.QueryReservationsRequest
Namespace
Google \ Cloud \ CapacityPlanner \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
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 |
int
Optional. The location level of the reservations usage timeseries. |
↳ machine_family |
string
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 |
MachineShape
Optional. The machine_shape as a filter to select matching reservations. |
↳ gpu_type |
string
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 |
string
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 |
int
Required. The Reservation type for example, future reservation request and allocation. If unspecified, all types are included. |
↳ share_type |
int
Optional. Types of share settings to filter reservations in response. If unspecified, all types are included. |
↳ ownership_type |
int
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 |
int
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 |
int
Optional. Aggregation Method of the historical reservation usage |
↳ start_date |
Google\Type\Date
Optional. The start date of reservations usage. |
↳ end_date |
Google\Type\Date
Optional. The end date of reservations usage. |
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}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
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}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocationLevel
Optional. The location level of the reservations usage timeseries.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type LocationType. |
setLocationLevel
Optional. The location level of the reservations usage timeseries.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type LocationType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMachineFamily
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMachineShape
Optional. The machine_shape as a filter to select matching reservations.
| Returns | |
|---|---|
| Type | Description |
MachineShape|null |
|
hasMachineShape
clearMachineShape
setMachineShape
Optional. The machine_shape as a filter to select matching reservations.
| Parameter | |
|---|---|
| Name | Description |
var |
MachineShape
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGpuType
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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".
| Returns | |
|---|---|
| Type | Description |
string |
|
setCloudResourceType
Required. The resource for the reserved values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", "gce-gpu" and "gce-vm".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReservationType
Required. The Reservation type for example, future reservation request and allocation. If unspecified, all types are included.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ReservationType. |
setReservationType
Required. The Reservation type for example, future reservation request and allocation. If unspecified, all types are included.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ReservationType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShareType
Optional. Types of share settings to filter reservations in response. If unspecified, all types are included.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ShareType. |
setShareType
Optional. Types of share settings to filter reservations in response. If unspecified, all types are included.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ShareType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type OwnershipType. |
setOwnershipType
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type OwnershipType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReservationDataLevel
Required. Reservations output data format.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ReservationDataLevel. |
setReservationDataLevel
Required. Reservations output data format.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ReservationDataLevel. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIncludeUnapprovedReservations
Optional. Whether to include pending for approval reservations in the response. This field is only applicable for future reservations.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIncludeUnapprovedReservations
Optional. Whether to include pending for approval reservations in the response. This field is only applicable for future reservations.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAggregationMethod
Optional. Aggregation Method of the historical reservation usage
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type AggregationMethod. |
setAggregationMethod
Optional. Aggregation Method of the historical reservation usage
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type AggregationMethod. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartDate
Optional. The start date of reservations usage.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Date|null |
|
hasStartDate
clearStartDate
setStartDate
Optional. The start date of reservations usage.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Date
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndDate
Optional. The end date of reservations usage.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Date|null |
|
hasEndDate
clearEndDate
setEndDate
Optional. The end date of reservations usage.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Date
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
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} Please see UsageServiceClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
QueryReservationsRequest |
|