# Package Classes (0.5.0) 0.5.0 (latest) 0.4.0 0.3.0 0.2.0 0.1.0 Summary of entries of Classes for google-cloud-capacityplanner. ## Classes ### [UsageServiceAsyncClient](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient) Provides access to historical and forecasted usage data. ### [UsageServiceClient](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient) Provides access to historical and forecasted usage data. ### [Allocation](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Allocation) Repesents Allocation which is part of aggregated reservations data response of "QueryReservations". .. _oneof: ### [ShareSettings](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Allocation.ShareSettings) The share setting for reservation. ### [ShareType](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Allocation.ShareSettings.ShareType) Possible scope in which the reservation can be shared. More granularity can be added in future. ### [SpecificSKUAllocation](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Allocation.SpecificSKUAllocation) This reservation type allows to pre allocate specific instance configuration. ### [AllocatedInstanceProperties](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties) Properties of the SKU instances being reserved. ### [AcceleratorConfig](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.AcceleratorConfig) A specification of the type and number of accelerator cards attached to the instance. ### [AllocatedDisk](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.AllocatedDisk) A specification of the interface and size of disk attached to the instance. ### [DiskInterface](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.AllocatedDisk.DiskInterface) guest device interface options to use for the disk. ### [Status](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Allocation.Status) The status of the reservation. ### [BigQueryDestination](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.BigQueryDestination) A BigQuery destination for exporting assets to. ### [CreateDisposition](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.BigQueryDestination.CreateDisposition) Specifies the action that occurs if the destination table does not exist. By default, a new table will be created. ### [PartitionKey](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.BigQueryDestination.PartitionKey) This enum determines the partition key column for the BigQuery tables. Partitioning can improve query performance and reduce query cost by filtering partitions. Refer to for details. ### [WriteDisposition](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.BigQueryDestination.WriteDisposition) Specifies the action that occurs if the destination table or partition already exists. By default, the data will be appended to the existing table. ### [ExportForecastsRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportForecastsRequest) The `ExportForecasts` request Next : 13 ### [ExportForecastsResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportForecastsResponse) A response message for \[UsageService.ExportForecasts\]. ### [ExportReservationsUsageRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportReservationsUsageRequest) The `ExportReservationsUsage` request This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: ### [ShareType](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportReservationsUsageRequest.ShareType) Possible scope in which the reservation can be shared. ### [ExportReservationsUsageResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportReservationsUsageResponse) A response message for \[UsageService.ExportReservationsUsage\]. ### [ExportUsageHistoriesRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportUsageHistoriesRequest) The `ExportUsageHistories` request Next : 12 ### [ExportUsageHistoriesResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportUsageHistoriesResponse) A response message for \[UsageService.ExportUsageHistories\]. ### [Forecast](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Forecast) A collection of data points that describes the predicted time-varying values of a resource. ### [Bounds](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Forecast.Bounds) The bounds of the forecast time series. ### [ForecastType](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Forecast.ForecastType) The type of the forecast. This describes the method that was used to produce future time series values from historical time series values. ### [PredictionInterval](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Forecast.PredictionInterval) The prediction interval represented by a forecast. ### [FutureReservation](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.FutureReservation) Repesents Future Reservation request which is part of aggregated reservations data response of "QueryReservations". .. _oneof: ### [SpecificSKUProperties](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.FutureReservation.SpecificSKUProperties) Represents specific SKU properties for the Future Reservation. ### [Status](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.FutureReservation.Status) Represents status related to the future reservation. ### [ProcurementStatus](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.FutureReservation.Status.ProcurementStatus) Represents procurement status of the Future Reservation. ### [TimeWindow](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.FutureReservation.TimeWindow) Represents time window for the Future Reservation. ### [GcsDestination](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.GcsDestination) A Cloud Storage location. ### [LocationIdentifier](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.LocationIdentifier) Identifier for a Google Cloud Platform location. ### [LinkedLocation](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.LocationIdentifier.LinkedLocation) ### [LocationLevel](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.LocationLevel) The level of the Google Cloud Platform location. ### [MachineShape](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.MachineShape) Machine shape details Next : 13 ### [OperationMetadata](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.OperationMetadata) Represents the metadata of a long-running operation. ### [OutputConfig](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.OutputConfig) Output configuration for export destination. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: ### [Point](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Point) A single data point in a time series. ### [QueryForecastsRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryForecastsRequest) The `QueryForecasts` request. Next : 14 ### [QueryForecastsResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryForecastsResponse) The `QueryForecasts` response. ### [QueryReservationsRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest) The `QueryReservations` request. ### [OwnershipType](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest.OwnershipType) Reservation ownership status to provide distinction for Capacity Planning. ### [ReservationDataLevel](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest.ReservationDataLevel) The form in which data of reservations should be returned. In case of AGGREGATED, timeseries for selected reservations is returned. If unspecified, all levels are included. ### [ReservationType](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest.ReservationType) Type of the reservation ### [ShareType](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest.ShareType) Possible scope in which the reservation can be shared. ### [QueryReservationsResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsResponse) The `QueryReservations` response. ### [QueryUsageHistoriesRequest](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryUsageHistoriesRequest) The `QueryUsageHistories` request. Next : 16 ### [QueryUsageHistoriesResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryUsageHistoriesResponse) The `QueryUsageHistories` response. ### [ReservationData](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ReservationData) Response entity for reservations data. ### [ResourceAttribute](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ResourceAttribute) An attribute of a Google Cloud Platform resource. ### [ResourceContainer](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ResourceContainer) The resource container of Google Cloud Platform hierarchy such as a project. ### [Type](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ResourceContainer.Type) ### [ResourceIdKey](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ResourceIdKey) The id for a Google Cloud Platform resource key. .. _oneof: ### [ResourceIdentifier](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ResourceIdentifier) The identifier for a Google Cloud Platform resource. ### [ResourceValue](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ResourceValue) ### [TimeSeries](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.TimeSeries) A collection of data points that describes the time-varying values of a resource. A time series is identified by its ID. Next : 13 ### [LocationType](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.TimeSeries.LocationType) The type of location that the time series is summarizing. ### [Unit](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Unit) ### [UsageHistory](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.UsageHistory) A collection of data points that describes the historical time-varying values of a resource. ### [AggregationMethod](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.UsageHistory.AggregationMethod) Methods for converting sampled data to time series values. ### [Value](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.Value) This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: