Reference documentation and code samples for the Google Cloud Capacity Planner V1beta Client class QueryUsageHistoriesRequest.
The QueryUsageHistories request.
Next : 16
Generated from protobuf message google.cloud.capacityplanner.v1beta.QueryUsageHistoriesRequest
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. |
↳ is_spot |
bool
Optional. The is_spot flag is used to fetch the usage data for preemptible Resources. |
↳ machine_family |
string
The machine family for the |
↳ machine_shape |
MachineShape
Optional. The machine shape for the |
↳ disk_type |
string
Optional. The disk_type for the |
↳ confidential_mode |
bool
Optional. Whether the persistent disk is in confidential mode. |
↳ gpu_type |
string
Optional. The GPU type for the |
↳ tpu_type |
string
Optional. The TPU type for the |
↳ cloud_resource_type |
string
Required. The resource for the |
↳ usage_aggregation_method |
int
The method that should be used to convert sampled usage data to daily usage values. AGGREGATION_METHOD_UNSPECIFIED will return results matching all the aggregation methods. |
↳ 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 |
|
getIsSpot
Optional. The is_spot flag is used to fetch the usage data for preemptible Resources.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsSpot
Optional. The is_spot flag is used to fetch the usage data for preemptible Resources.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMachineFamily
The machine family for the UsageHistory values to return. Possible values
include "n1", and "n2d". See
https://cloud.google.com/compute/docs/machine-types for more examples.
Empty machine_family will return results matching all machine families.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMachineFamily
The machine family for the UsageHistory values to return. Possible values
include "n1", and "n2d". See
https://cloud.google.com/compute/docs/machine-types for more examples.
Empty machine_family will return results matching all machine families.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMachineShape
Optional. The machine shape for the UsageHistory values to return.
| Returns | |
|---|---|
| Type | Description |
MachineShape|null |
|
hasMachineShape
clearMachineShape
setMachineShape
Optional. The machine shape for the UsageHistory values to return.
| Parameter | |
|---|---|
| Name | Description |
var |
MachineShape
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDiskType
Optional. The disk_type for the UsageHistory values to return request
with persistent-disk cloud_resource_type. Empty disk_type will return
results matching all disk types.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDiskType
Optional. The disk_type for the UsageHistory values to return request
with persistent-disk cloud_resource_type. Empty disk_type will return
results matching all disk types.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConfidentialMode
Optional. Whether the persistent disk is in confidential mode.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setConfidentialMode
Optional. Whether the persistent disk is in confidential mode.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGpuType
Optional. The GPU type for the UsageHistory 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 UsageHistory 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 |
|
getTpuType
Optional. The TPU type for the UsageHistory values to return. Empty
tpu_type will return results matching all TPUs.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTpuType
Optional. The TPU type for the UsageHistory values to return. Empty
tpu_type will return results matching all TPUs.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCloudResourceType
Required. The resource for the UsageHistory values to return. Possible
values include "gce-vcpus", "gce-ram", "gce-local-ssd",
"gce-persistent-disk", "gce-gpu" and "gce-tpu". Empty cloud_resource_type
will return results matching all resources.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCloudResourceType
Required. The resource for the UsageHistory values to return. Possible
values include "gce-vcpus", "gce-ram", "gce-local-ssd",
"gce-persistent-disk", "gce-gpu" and "gce-tpu". Empty cloud_resource_type
will return results matching all resources.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUsageAggregationMethod
The method that should be used to convert sampled usage data to daily usage values.
AGGREGATION_METHOD_UNSPECIFIED will return results matching all the aggregation methods.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type AggregationMethod. |
setUsageAggregationMethod
The method that should be used to convert sampled usage data to daily usage values.
AGGREGATION_METHOD_UNSPECIFIED will return results matching all the aggregation methods.
| 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 |
|