Summary of entries of Classes for google-cloud-capacityplanner.
Classes
CapacityPlanningServiceAsyncClient
This API allows users to plan for GCP capacity associated with their projects. Users can request additional capacity for GCP resources such as VMs, PDs, etc.
CapacityPlanningServiceClient
This API allows users to plan for GCP capacity associated with their projects. Users can request additional capacity for GCP resources such as VMs, PDs, etc.
QueryCapacityPlansAsyncPager
A pager for iterating through query_capacity_plans requests.
This class thinly wraps an initial
QueryCapacityPlansResponse object, and
provides an __aiter__ method to iterate through its
capacity_plans field.
If there are more pages, the __aiter__ method will make additional
QueryCapacityPlans requests and continue to iterate
through the capacity_plans field on the
corresponding responses.
All the usual QueryCapacityPlansResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
QueryCapacityPlansPager
A pager for iterating through query_capacity_plans requests.
This class thinly wraps an initial
QueryCapacityPlansResponse object, and
provides an __iter__ method to iterate through its
capacity_plans field.
If there are more pages, the __iter__ method will make additional
QueryCapacityPlans requests and continue to iterate
through the capacity_plans field on the
corresponding responses.
All the usual QueryCapacityPlansResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
UsageServiceAsyncClient
Provides access to historical and forecasted usage data.
UsageServiceClient
Provides access to historical and forecasted usage data.
Allocation
Repesents Allocation which is part of aggregated reservations data response of "QueryReservations".
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ShareSettings
The share setting for reservation.
ShareType
Possible scope in which the reservation can be shared. More granularity can be added in future.
SpecificSKUAllocation
This reservation type allows to pre allocate specific instance configuration.
AllocatedInstanceProperties
Properties of the SKU instances being reserved.
AcceleratorConfig
A specification of the type and number of accelerator cards attached to the instance.
AllocatedDisk
A specification of the interface and size of disk attached to the instance.
DiskInterface
guest device interface options to use for the disk.
Status
The status of the reservation.
BigQueryDestination
A BigQuery destination for exporting assets to.
CreateDisposition
Specifies the action that occurs if the destination table does not exist. By default, a new table will be created.
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 https://cloud.google.com/bigquery/docs/partitioned-tables for details.
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.
CapacityPlan
A plan for additional capacity needed by a Google Cloud Platform project. This is synonymous with CapacityDemand, CapacityRequest, and CapacityDemandRequest.
CapacityPlanFilters
CapacityPlanFilters is a set of filters to apply to the capacity plan.
CapacityPlanKey
CapacityPlanKey is a the unique identifier for each Capacity Plan.
CapacityPlanView
CapacityPlanView contains the capacity plan key and the time series views.
CapacityType
CapacityType is the type of the capacity plan.
ChildResourceDemand
Capacity demand for a child resource such as shapes.
DemandMetadata
The metadata associated with a capacity demand.
DemandPreference
Preference associated with a request, such as flexibility with alternate resource type.
DemandValue
Capacity demand value for a single resource attribute such as CPU count, vertex AI peak QPM, etc.
DemandValues
The capacity demand values for a resource.
ExportForecastsRequest
The ExportForecasts request Next : 13
ExportForecastsResponse
A response message for [UsageService.ExportForecasts].
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: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ShareType
Possible scope in which the reservation can be shared.
ExportReservationsUsageResponse
A response message for [UsageService.ExportReservationsUsage].
ExportUsageHistoriesRequest
The ExportUsageHistories request Next : 12
ExportUsageHistoriesResponse
A response message for [UsageService.ExportUsageHistories].
Forecast
A collection of data points that describes the predicted time-varying values of a resource.
Bounds
The bounds of the forecast time series.
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
The prediction interval represented by a forecast.
FutureReservation
Repesents Future Reservation request which is part of aggregated reservations data response of "QueryReservations".
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SpecificSKUProperties
Represents specific SKU properties for the Future Reservation.
Status
Represents status related to the future reservation.
ProcurementStatus
Represents procurement status of the Future Reservation.
TimeWindow
Represents time window for the Future Reservation.
GcsDestination
A Cloud Storage location.
GetCapacityPlanRequest
Request for getting a capacity plan.
LocationIdentifier
Identifier for a Google Cloud Platform location.
LinkedLocation
LocationLevel
The level of the Google Cloud Platform location.
MachineShape
Machine shape details Next : 13
OperationMetadata
Represents the metadata of a long-running operation.
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: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Point
A single data point in a time series.
QueryCapacityPlanInsightsRequest
Request for capacity plan insights.
QueryCapacityPlanInsightsResponse
Response for capacity plan insights.
QueryCapacityPlansRequest
Request for querying capacity plans.
QueryCapacityPlansResponse
Response of querying capacity plans.
QueryForecastsRequest
The QueryForecasts request. Next : 14
QueryForecastsResponse
The QueryForecasts response.
QueryReservationsRequest
The QueryReservations request.
OwnershipType
Reservation ownership status to provide distinction for Capacity Planning.
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
Type of the reservation
ShareType
Possible scope in which the reservation can be shared.
QueryReservationsResponse
The QueryReservations response.
QueryUsageHistoriesRequest
The QueryUsageHistories request. Next : 16
QueryUsageHistoriesResponse
The QueryUsageHistories response.
ReservationData
Response entity for reservations data.
ResourceAttribute
An attribute of a Google Cloud Platform resource.
ResourceContainer
The resource container of Google Cloud Platform hierarchy such as a project.
Type
ResourceDemand
Capacity demand for a resource.
ResourceIdKey
The id for a Google Cloud Platform resource key.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ResourceIdentifier
The identifier for a Google Cloud Platform resource.
ResourceValue
ServiceDemand
Capacity demand for a service.
State
The state of a capacity demand.
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
The type of location that the time series is summarizing.
TimeSeriesView
TimeSeriesView contains capacity_value which has the timeseries for a given type. Each type as a single timeseries associated with it.
TimeValue
Capacity demand value for a single time point.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Unit
UsageHistory
A collection of data points that describes the historical time-varying values of a resource.
AggregationMethod
Methods for converting sampled data to time series values.
User
A user who created or updated a capacity demand.
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: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Modules
pagers
API documentation for capacityplanner_v1beta.services.capacity_planning_service.pagers module.