Package types (0.1.0)

API documentation for capacityplanner_v1beta.types package.

Classes

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

BigQueryDestination

A BigQuery destination for exporting assets to.

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

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.

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

GcsDestination

A Cloud Storage location.

GetCapacityPlanRequest

Request for getting a capacity plan.

LocationIdentifier

Identifier for a Google Cloud Platform location.

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.

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.

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

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.

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