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

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

The ExportForecasts request Next : 13

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

Namespace

Google \ Cloud \ CapacityPlanner \ V1beta

Methods

__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}
`↳ machine_family`	`string` Optional. The machine family to use to select the `Forecast` values to return. Possible values include "n1", and "n2d".
`↳ machine_shape`	`MachineShape` Optional. The machine shape for the time series values to export.
`↳ disk_type`	`string` Optional. The disk_type for the `Forecast` values to return with request persistent-disk resource_type.
`↳ gpu_type`	`string` Optional. The GPU type for the `Forecast` 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.
`↳ tpu_type`	`string` Optional. The TPU type for the `Forecast` values to return. Empty tpu_type will return results matching all TPUs.
`↳ resource_type`	`string` Required. The resource for the `Forecast` values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", "gce-persistent-disk", "gce-gpu" and "gce-tpu".
`↳ prediction_interval`	`int` Optional. The prediction interval to use to select the `Forecast` values to return. PREDICTION_INTERVAL_UNSPECIFIED will return results matching all prediction intervals.
`↳ aggregation_method`	`int` Optional. Aggregation Method of the historical usage for which the forecast is generated.
`↳ start_date`	`Google\Type\Date` Optional. The start date of forecasts.
`↳ end_date`	`Google\Type\Date` Optional. The end date of forecasts.
`↳ output_config`	`OutputConfig` Required. Output configuration indicating where the results will be output to.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMachineFamily

Optional. The machine family to use to select the Forecast values to return. Possible values include "n1", and "n2d".

Returns
Type	Description
`string`

setMachineFamily

Optional. The machine family to use to select the Forecast values to return. Possible values include "n1", and "n2d".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMachineShape

Optional. The machine shape for the time series values to export.

Returns
Type	Description
`MachineShape\|null`

hasMachineShape

clearMachineShape

setMachineShape

Optional. The machine shape for the time series values to export.

Parameter
Name	Description
`var`	`MachineShape`

Returns
Type	Description
`$this`

getDiskType

Optional. The disk_type for the Forecast values to return with request persistent-disk resource_type.

Returns
Type	Description
`string`

setDiskType

Optional. The disk_type for the Forecast values to return with request persistent-disk resource_type.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGpuType

Optional. The GPU type for the Forecast 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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTpuType

Optional. The TPU type for the Forecast values to return. Empty tpu_type will return results matching all TPUs.

Returns
Type	Description
`string`

setTpuType

Optional. The TPU type for the Forecast values to return. Empty tpu_type will return results matching all TPUs.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getResourceType

Required. The resource for the Forecast values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", "gce-persistent-disk", "gce-gpu" and "gce-tpu".

Returns
Type	Description
`string`

setResourceType

Required. The resource for the Forecast values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", "gce-persistent-disk", "gce-gpu" and "gce-tpu".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPredictionInterval

Optional. The prediction interval to use to select the Forecast values to return. PREDICTION_INTERVAL_UNSPECIFIED will return results matching all prediction intervals.

Returns
Type	Description
`int`	Enum of type PredictionInterval.

setPredictionInterval

Optional. The prediction interval to use to select the Forecast values to return. PREDICTION_INTERVAL_UNSPECIFIED will return results matching all prediction intervals.

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

Returns
Type	Description
`$this`

getAggregationMethod

Optional. Aggregation Method of the historical usage for which the forecast is generated.

Returns
Type	Description
`int`	Enum of type AggregationMethod.

setAggregationMethod