Google Cloud Capacity Planner V1beta Client - Class ExportReservationsUsageRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Capacity Planner V1beta Client class ExportReservationsUsageRequest.

The ExportReservationsUsage request

Generated from protobuf message google.cloud.capacityplanner.v1beta.ExportReservationsUsageRequest

Namespace

Google \ Cloud \ CapacityPlanner \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ machine_family`	`string` Optional. The machine family to query reservations and usage by. For example: n1, n2d.
`↳ machine_shape`	`MachineShape` Optional. The machine_shape as a filter to select matching reservations and its usage.
`↳ gpu_type`	`string` Optional. The GPU type to query reservations and usage by. For example: NVIDIA T4.
`↳ parent`	`string` Required. The compute engine resource and location of the reservationsusage. 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.
`↳ cloud_resource_type`	`string` Required. The resource for the `ReservationsUsage` values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", and "gce-gpu".
`↳ usage_aggregation_method`	`int` Required. The method that should be used to convert sampled reservations data to daily usage values.
`↳ share_type`	`int` Optional. Type of share settings to filter reservations in response. If unspecified, all types are included.
`↳ start_date`	`Google\Type\Date` Optional. The start date of reservations usage.
`↳ end_date`	`Google\Type\Date` Optional. The end date of reservations usage.
`↳ output_config`	`OutputConfig` Required. Output configuration indicating where the results will be output to.

getMachineFamily

Optional. The machine family to query reservations and usage by. For example: n1, n2d.

Returns
Type	Description
`string`

hasMachineFamily

setMachineFamily

Optional. The machine family to query reservations and usage by. For example: n1, n2d.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMachineShape

Optional. The machine_shape as a filter to select matching reservations and its usage.

Returns
Type	Description
`MachineShape\|null`

hasMachineShape

setMachineShape

Optional. The machine_shape as a filter to select matching reservations and its usage.

Parameter
Name	Description
`var`	`MachineShape`

Returns
Type	Description
`$this`

getGpuType

Optional. The GPU type to query reservations and usage by. For example: NVIDIA T4.

Returns
Type	Description
`string`

hasGpuType

setGpuType

Optional. The GPU type to query reservations and usage by. For example: NVIDIA T4.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getParent

Required. The compute engine resource and location of the reservationsusage. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}

Returns
Type	Description
`string`

setParent

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`

getCloudResourceType

Required. The resource for the ReservationsUsage values to return.

Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", and "gce-gpu".

Returns
Type	Description
`string`

setCloudResourceType

Required. The resource for the ReservationsUsage values to return.

Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", and "gce-gpu".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUsageAggregationMethod

Required. The method that should be used to convert sampled reservations data to daily usage values.

Returns
Type	Description
`int`	Enum of type AggregationMethod.

setUsageAggregationMethod

Required. The method that should be used to convert sampled reservations data to daily usage values.

Parameter
Name	Description
`var`	`int` Enum of type AggregationMethod.

Returns
Type	Description
`$this`

getShareType

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

Returns
Type	Description
`int`	Enum of type ShareType.

setShareType

Optional. Type 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`

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`

getOutputConfig

Required. Output configuration indicating where the results will be output to.

Returns
Type	Description
`OutputConfig\|null`

hasOutputConfig

clearOutputConfig

setOutputConfig

Required. Output configuration indicating where the results will be output to.

Parameter
Name	Description
`var`	`OutputConfig`

Returns
Type	Description
`$this`

getResource

Returns
Type	Description
`string`