# Capacity Planner V1BETA API - Class Google::Cloud::CapacityPlanner::V1beta::Forecast (v0.5.0)

0.5.0 (latest) 0.4.0 0.3.1 0.2.0 0.1.0 Reference documentation and code samples for the Capacity Planner V1BETA API class Google::Cloud::CapacityPlanner::V1beta::Forecast.

A collection of data points that describes the predicted time-varying values
of a resource.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #aggregation_method

    def aggregation_method() -> ::Google::Cloud::CapacityPlanner::V1beta::UsageHistory::AggregationMethod

**Returns**

- ([::Google::Cloud::CapacityPlanner::V1beta::UsageHistory::AggregationMethod](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-UsageHistory-AggregationMethod)) --- Aggregation Method of the historical usage for which the forecast is generated

### #aggregation_method=

    def aggregation_method=(value) -> ::Google::Cloud::CapacityPlanner::V1beta::UsageHistory::AggregationMethod

**Parameter**

- **value** ([::Google::Cloud::CapacityPlanner::V1beta::UsageHistory::AggregationMethod](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-UsageHistory-AggregationMethod)) --- Aggregation Method of the historical usage for which the forecast is generated
**Returns**

- ([::Google::Cloud::CapacityPlanner::V1beta::UsageHistory::AggregationMethod](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-UsageHistory-AggregationMethod)) --- Aggregation Method of the historical usage for which the forecast is generated

### #bounds

    def bounds() -> ::Google::Cloud::CapacityPlanner::V1beta::Forecast::Bounds

**Returns**

- ([::Google::Cloud::CapacityPlanner::V1beta::Forecast::Bounds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-Forecast-Bounds)) --- The bounds represented by this forecast time series.

### #bounds=

    def bounds=(value) -> ::Google::Cloud::CapacityPlanner::V1beta::Forecast::Bounds

**Parameter**

- **value** ([::Google::Cloud::CapacityPlanner::V1beta::Forecast::Bounds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-Forecast-Bounds)) --- The bounds represented by this forecast time series.
**Returns**

- ([::Google::Cloud::CapacityPlanner::V1beta::Forecast::Bounds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-Forecast-Bounds)) --- The bounds represented by this forecast time series.

### #forecast_type

    def forecast_type() -> ::Google::Cloud::CapacityPlanner::V1beta::Forecast::ForecastType

**Returns**

- ([::Google::Cloud::CapacityPlanner::V1beta::Forecast::ForecastType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-Forecast-ForecastType)) --- The type of forecast.

### #forecast_type=

    def forecast_type=(value) -> ::Google::Cloud::CapacityPlanner::V1beta::Forecast::ForecastType

**Parameter**

- **value** ([::Google::Cloud::CapacityPlanner::V1beta::Forecast::ForecastType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-Forecast-ForecastType)) --- The type of forecast.
**Returns**

- ([::Google::Cloud::CapacityPlanner::V1beta::Forecast::ForecastType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-Forecast-ForecastType)) --- The type of forecast.

### #name

    def name() -> ::String

**Returns**

- (::String) --- The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/forecasts/{forecast_id}` or `organizations/{organization_id}/locations/{location_id}/forecasts/{forecast_id}` or `folders/{folder_id}/locations/{location_id}/forecasts/{forecast_id}`

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/forecasts/{forecast_id}` or `organizations/{organization_id}/locations/{location_id}/forecasts/{forecast_id}` or `folders/{folder_id}/locations/{location_id}/forecasts/{forecast_id}`
**Returns**

- (::String) --- The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/forecasts/{forecast_id}` or `organizations/{organization_id}/locations/{location_id}/forecasts/{forecast_id}` or `folders/{folder_id}/locations/{location_id}/forecasts/{forecast_id}`

### #prediction_interval

    def prediction_interval() -> ::Google::Cloud::CapacityPlanner::V1beta::Forecast::PredictionInterval

**Returns**

- ([::Google::Cloud::CapacityPlanner::V1beta::Forecast::PredictionInterval](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-Forecast-PredictionInterval)) --- The prediction interval represented by the time series.

### #prediction_interval=

    def prediction_interval=(value) -> ::Google::Cloud::CapacityPlanner::V1beta::Forecast::PredictionInterval

**Parameter**

- **value** ([::Google::Cloud::CapacityPlanner::V1beta::Forecast::PredictionInterval](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-Forecast-PredictionInterval)) --- The prediction interval represented by the time series.
**Returns**

- ([::Google::Cloud::CapacityPlanner::V1beta::Forecast::PredictionInterval](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-Forecast-PredictionInterval)) --- The prediction interval represented by the time series.

### #time_series

    def time_series() -> ::Google::Cloud::CapacityPlanner::V1beta::TimeSeries

**Returns**

- ([::Google::Cloud::CapacityPlanner::V1beta::TimeSeries](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-TimeSeries)) --- The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).

### #time_series=

    def time_series=(value) -> ::Google::Cloud::CapacityPlanner::V1beta::TimeSeries

**Parameter**

- **value** ([::Google::Cloud::CapacityPlanner::V1beta::TimeSeries](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-TimeSeries)) --- The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).
**Returns**

- ([::Google::Cloud::CapacityPlanner::V1beta::TimeSeries](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-capacity_planner-v1beta/latest/Google-Cloud-CapacityPlanner-V1beta-TimeSeries)) --- The collection of data points that represent the predicted values. Note that some of these values may be in the past (if, for example, the forecast was created in the past and predicted values for the present day).