Package com.google.cloud.capacityplanner.v1beta (0.1.0)

GitHub Repository

Prerelease Implications

This package is a prerelease version! Use with caution.

Prerelease versions are considered unstable as they may be shut down and/or subject to breaking changes when upgrading. Use them only for testing or if you specifically need their experimental features.

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.capacityplanner.v1beta.UsageServiceClient Service Description: Provides access to historical and forecasted usage data.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.capacityplanner.v1beta.Allocation.ShareSettings

The share setting for reservation.
com.google.cloud.capacityplanner.v1beta.UsageServiceSettings Settings class to configure an instance of UsageServiceClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.capacityplanner.v1beta.Allocation Repesents Allocation which is part of aggregated reservations data response of "QueryReservations".
com.google.cloud.capacityplanner.v1beta.Allocation.Builder Repesents Allocation which is part of aggregated reservations data response of "QueryReservations".
com.google.cloud.capacityplanner.v1beta.Allocation.ShareSettings.Builder The share setting for reservation.
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation This reservation type allows to pre allocate specific instance configuration.
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties Properties of the SKU instances being reserved.
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.AcceleratorConfig A specification of the type and number of accelerator cards attached to the instance.
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.AcceleratorConfig.Builder A specification of the type and number of accelerator cards attached to the instance.
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.AllocatedDisk A specification of the interface and size of disk attached to the instance.
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.AllocatedDisk.Builder A specification of the interface and size of disk attached to the instance.
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.Builder Properties of the SKU instances being reserved.
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.Builder This reservation type allows to pre allocate specific instance configuration.
com.google.cloud.capacityplanner.v1beta.AllocationProto
com.google.cloud.capacityplanner.v1beta.BigQueryDestination A BigQuery destination for exporting assets to.
com.google.cloud.capacityplanner.v1beta.BigQueryDestination.Builder A BigQuery destination for exporting assets to.
com.google.cloud.capacityplanner.v1beta.ExportForecastsRequest The ExportForecasts request Next : 13
com.google.cloud.capacityplanner.v1beta.ExportForecastsRequest.Builder The ExportForecasts request Next : 13
com.google.cloud.capacityplanner.v1beta.ExportForecastsResponse A response message for [UsageService.ExportForecasts].
com.google.cloud.capacityplanner.v1beta.ExportForecastsResponse.Builder A response message for [UsageService.ExportForecasts].
com.google.cloud.capacityplanner.v1beta.ExportReservationsUsageRequest The ExportReservationsUsage request
com.google.cloud.capacityplanner.v1beta.ExportReservationsUsageRequest.Builder The ExportReservationsUsage request
com.google.cloud.capacityplanner.v1beta.ExportReservationsUsageResponse A response message for [UsageService.ExportReservationsUsage].
com.google.cloud.capacityplanner.v1beta.ExportReservationsUsageResponse.Builder A response message for [UsageService.ExportReservationsUsage].
com.google.cloud.capacityplanner.v1beta.ExportUsageHistoriesRequest The ExportUsageHistories request Next : 12
com.google.cloud.capacityplanner.v1beta.ExportUsageHistoriesRequest.Builder The ExportUsageHistories request Next : 12
com.google.cloud.capacityplanner.v1beta.ExportUsageHistoriesResponse A response message for [UsageService.ExportUsageHistories].
com.google.cloud.capacityplanner.v1beta.ExportUsageHistoriesResponse.Builder A response message for [UsageService.ExportUsageHistories].
com.google.cloud.capacityplanner.v1beta.Forecast A collection of data points that describes the predicted time-varying values of a resource.
com.google.cloud.capacityplanner.v1beta.Forecast.Builder A collection of data points that describes the predicted time-varying values of a resource.
com.google.cloud.capacityplanner.v1beta.FutureReservation Repesents Future Reservation request which is part of aggregated reservations data response of "QueryReservations".
com.google.cloud.capacityplanner.v1beta.FutureReservation.Builder Repesents Future Reservation request which is part of aggregated reservations data response of "QueryReservations".
com.google.cloud.capacityplanner.v1beta.FutureReservation.SpecificSKUProperties Represents specific SKU properties for the Future Reservation.
com.google.cloud.capacityplanner.v1beta.FutureReservation.SpecificSKUProperties.Builder Represents specific SKU properties for the Future Reservation.
com.google.cloud.capacityplanner.v1beta.FutureReservation.Status Represents status related to the future reservation.
com.google.cloud.capacityplanner.v1beta.FutureReservation.Status.Builder Represents status related to the future reservation.
com.google.cloud.capacityplanner.v1beta.FutureReservation.TimeWindow Represents time window for the Future Reservation.
com.google.cloud.capacityplanner.v1beta.FutureReservation.TimeWindow.Builder Represents time window for the Future Reservation.
com.google.cloud.capacityplanner.v1beta.FutureReservationProto
com.google.cloud.capacityplanner.v1beta.GcsDestination A Cloud Storage location.
com.google.cloud.capacityplanner.v1beta.GcsDestination.Builder A Cloud Storage location.
com.google.cloud.capacityplanner.v1beta.LocationIdentifier Identifier for a Google Cloud Platform location.
com.google.cloud.capacityplanner.v1beta.LocationIdentifier.Builder Identifier for a Google Cloud Platform location.
com.google.cloud.capacityplanner.v1beta.LocationIdentifier.LinkedLocation Protobuf type google.cloud.capacityplanner.v1beta.LocationIdentifier.LinkedLocation
com.google.cloud.capacityplanner.v1beta.LocationIdentifier.LinkedLocation.Builder Protobuf type google.cloud.capacityplanner.v1beta.LocationIdentifier.LinkedLocation
com.google.cloud.capacityplanner.v1beta.LocationName
com.google.cloud.capacityplanner.v1beta.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.capacityplanner.v1beta.LocationProto
com.google.cloud.capacityplanner.v1beta.MachineShape Machine shape details Next : 13
com.google.cloud.capacityplanner.v1beta.MachineShape.Builder Machine shape details Next : 13
com.google.cloud.capacityplanner.v1beta.OperationMetadata Represents the metadata of a long-running operation.
com.google.cloud.capacityplanner.v1beta.OperationMetadata.Builder Represents the metadata of a long-running operation.
com.google.cloud.capacityplanner.v1beta.OutputConfig Output configuration for export destination.
com.google.cloud.capacityplanner.v1beta.OutputConfig.Builder Output configuration for export destination.
com.google.cloud.capacityplanner.v1beta.Point A single data point in a time series.
com.google.cloud.capacityplanner.v1beta.Point.Builder A single data point in a time series.
com.google.cloud.capacityplanner.v1beta.QueryForecastsRequest The QueryForecasts request. Next : 14
com.google.cloud.capacityplanner.v1beta.QueryForecastsRequest.Builder The QueryForecasts request. Next : 14
com.google.cloud.capacityplanner.v1beta.QueryForecastsResponse The QueryForecasts response.
com.google.cloud.capacityplanner.v1beta.QueryForecastsResponse.Builder The QueryForecasts response.
com.google.cloud.capacityplanner.v1beta.QueryReservationsRequest The QueryReservations request.
com.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.Builder The QueryReservations request.
com.google.cloud.capacityplanner.v1beta.QueryReservationsResponse The QueryReservations response.
com.google.cloud.capacityplanner.v1beta.QueryReservationsResponse.Builder The QueryReservations response.
com.google.cloud.capacityplanner.v1beta.QueryUsageHistoriesRequest The QueryUsageHistories request. Next : 16
com.google.cloud.capacityplanner.v1beta.QueryUsageHistoriesRequest.Builder The QueryUsageHistories request. Next : 16
com.google.cloud.capacityplanner.v1beta.QueryUsageHistoriesResponse The QueryUsageHistories response.
com.google.cloud.capacityplanner.v1beta.QueryUsageHistoriesResponse.Builder The QueryUsageHistories response.
com.google.cloud.capacityplanner.v1beta.ReservationData Response entity for reservations data.
com.google.cloud.capacityplanner.v1beta.ReservationData.Builder Response entity for reservations data.
com.google.cloud.capacityplanner.v1beta.ResourceAttribute An attribute of a Google Cloud Platform resource.
com.google.cloud.capacityplanner.v1beta.ResourceAttribute.Builder An attribute of a Google Cloud Platform resource.
com.google.cloud.capacityplanner.v1beta.ResourceContainer The resource container of Google Cloud Platform hierarchy such as a project.
com.google.cloud.capacityplanner.v1beta.ResourceContainer.Builder The resource container of Google Cloud Platform hierarchy such as a project.
com.google.cloud.capacityplanner.v1beta.ResourceIdKey The id for a Google Cloud Platform resource key.
com.google.cloud.capacityplanner.v1beta.ResourceIdKey.Builder The id for a Google Cloud Platform resource key.
com.google.cloud.capacityplanner.v1beta.ResourceIdentifier The identifier for a Google Cloud Platform resource.
com.google.cloud.capacityplanner.v1beta.ResourceIdentifier.Builder The identifier for a Google Cloud Platform resource.
com.google.cloud.capacityplanner.v1beta.ResourceProto
com.google.cloud.capacityplanner.v1beta.ResourceValue Protobuf type google.cloud.capacityplanner.v1beta.ResourceValue
com.google.cloud.capacityplanner.v1beta.ResourceValue.Builder Protobuf type google.cloud.capacityplanner.v1beta.ResourceValue
com.google.cloud.capacityplanner.v1beta.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
com.google.cloud.capacityplanner.v1beta.TimeSeries.Builder A collection of data points that describes the time-varying values of a resource. A time series is identified by its ID. Next : 13
com.google.cloud.capacityplanner.v1beta.UsageHistory A collection of data points that describes the historical time-varying values of a resource.
com.google.cloud.capacityplanner.v1beta.UsageHistory.Builder A collection of data points that describes the historical time-varying values of a resource.
com.google.cloud.capacityplanner.v1beta.UsageServiceGrpc Provides access to historical and forecasted usage data.
com.google.cloud.capacityplanner.v1beta.UsageServiceGrpc.UsageServiceImplBase Base class for the server implementation of the service UsageService. Provides access to historical and forecasted usage data.
com.google.cloud.capacityplanner.v1beta.UsageServiceProto
com.google.cloud.capacityplanner.v1beta.UsageServiceSettings.Builder Builder for UsageServiceSettings.
com.google.cloud.capacityplanner.v1beta.Value Protobuf type google.cloud.capacityplanner.v1beta.Value
com.google.cloud.capacityplanner.v1beta.Value.Builder Protobuf type google.cloud.capacityplanner.v1beta.Value

Interfaces

Interface Description
com.google.cloud.capacityplanner.v1beta.Allocation.ShareSettingsOrBuilder
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.AcceleratorConfigOrBuilder
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.AllocatedDiskOrBuilder
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.AllocatedInstancePropertiesOrBuilder
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocationOrBuilder
com.google.cloud.capacityplanner.v1beta.AllocationOrBuilder
com.google.cloud.capacityplanner.v1beta.BigQueryDestinationOrBuilder
com.google.cloud.capacityplanner.v1beta.ExportForecastsRequestOrBuilder
com.google.cloud.capacityplanner.v1beta.ExportForecastsResponseOrBuilder
com.google.cloud.capacityplanner.v1beta.ExportReservationsUsageRequestOrBuilder
com.google.cloud.capacityplanner.v1beta.ExportReservationsUsageResponseOrBuilder
com.google.cloud.capacityplanner.v1beta.ExportUsageHistoriesRequestOrBuilder
com.google.cloud.capacityplanner.v1beta.ExportUsageHistoriesResponseOrBuilder
com.google.cloud.capacityplanner.v1beta.ForecastOrBuilder
com.google.cloud.capacityplanner.v1beta.FutureReservation.SpecificSKUPropertiesOrBuilder
com.google.cloud.capacityplanner.v1beta.FutureReservation.StatusOrBuilder
com.google.cloud.capacityplanner.v1beta.FutureReservation.TimeWindowOrBuilder
com.google.cloud.capacityplanner.v1beta.FutureReservationOrBuilder
com.google.cloud.capacityplanner.v1beta.GcsDestinationOrBuilder
com.google.cloud.capacityplanner.v1beta.LocationIdentifier.LinkedLocationOrBuilder
com.google.cloud.capacityplanner.v1beta.LocationIdentifierOrBuilder
com.google.cloud.capacityplanner.v1beta.MachineShapeOrBuilder
com.google.cloud.capacityplanner.v1beta.OperationMetadataOrBuilder
com.google.cloud.capacityplanner.v1beta.OutputConfigOrBuilder
com.google.cloud.capacityplanner.v1beta.PointOrBuilder
com.google.cloud.capacityplanner.v1beta.QueryForecastsRequestOrBuilder
com.google.cloud.capacityplanner.v1beta.QueryForecastsResponseOrBuilder
com.google.cloud.capacityplanner.v1beta.QueryReservationsRequestOrBuilder
com.google.cloud.capacityplanner.v1beta.QueryReservationsResponseOrBuilder
com.google.cloud.capacityplanner.v1beta.QueryUsageHistoriesRequestOrBuilder
com.google.cloud.capacityplanner.v1beta.QueryUsageHistoriesResponseOrBuilder
com.google.cloud.capacityplanner.v1beta.ReservationDataOrBuilder
com.google.cloud.capacityplanner.v1beta.ResourceAttributeOrBuilder
com.google.cloud.capacityplanner.v1beta.ResourceContainerOrBuilder
com.google.cloud.capacityplanner.v1beta.ResourceIdKeyOrBuilder
com.google.cloud.capacityplanner.v1beta.ResourceIdentifierOrBuilder
com.google.cloud.capacityplanner.v1beta.ResourceValueOrBuilder
com.google.cloud.capacityplanner.v1beta.TimeSeriesOrBuilder
com.google.cloud.capacityplanner.v1beta.UsageHistoryOrBuilder
com.google.cloud.capacityplanner.v1beta.UsageServiceGrpc.AsyncService Provides access to historical and forecasted usage data.
com.google.cloud.capacityplanner.v1beta.ValueOrBuilder

Enums

Enum Description
com.google.cloud.capacityplanner.v1beta.Allocation.ShareSettings.ShareType Possible scope in which the reservation can be shared. More granularity can be added in future.
com.google.cloud.capacityplanner.v1beta.Allocation.SpecificSKUAllocation.AllocatedInstanceProperties.AllocatedDisk.DiskInterface guest device interface options to use for the disk.
com.google.cloud.capacityplanner.v1beta.Allocation.Status The status of the reservation.
com.google.cloud.capacityplanner.v1beta.Allocation.TypeCase
com.google.cloud.capacityplanner.v1beta.BigQueryDestination.CreateDisposition Specifies the action that occurs if the destination table does not exist. By default, a new table will be created.
com.google.cloud.capacityplanner.v1beta.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
com.google.cloud.capacityplanner.v1beta.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.
com.google.cloud.capacityplanner.v1beta.ExportReservationsUsageRequest.ResourceCase
com.google.cloud.capacityplanner.v1beta.ExportReservationsUsageRequest.ShareType Possible scope in which the reservation can be shared.
com.google.cloud.capacityplanner.v1beta.Forecast.Bounds The bounds of the forecast time series.
com.google.cloud.capacityplanner.v1beta.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.
com.google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval The prediction interval represented by a forecast.
com.google.cloud.capacityplanner.v1beta.FutureReservation.Status.ProcurementStatus Represents procurement status of the Future Reservation.
com.google.cloud.capacityplanner.v1beta.FutureReservation.TypeCase
com.google.cloud.capacityplanner.v1beta.LocationLevel The level of the Google Cloud Platform location.
com.google.cloud.capacityplanner.v1beta.OutputConfig.DestinationCase
com.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.OwnershipType Reservation ownership status to provide distinction for Capacity Planning.
com.google.cloud.capacityplanner.v1beta.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.
com.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.ReservationType Type of the reservation
com.google.cloud.capacityplanner.v1beta.QueryReservationsRequest.ShareType Possible scope in which the reservation can be shared.
com.google.cloud.capacityplanner.v1beta.ResourceContainer.Type Protobuf enum google.cloud.capacityplanner.v1beta.ResourceContainer.Type
com.google.cloud.capacityplanner.v1beta.ResourceIdKey.DemandFieldsCase
com.google.cloud.capacityplanner.v1beta.TimeSeries.LocationType The type of location that the time series is summarizing.
com.google.cloud.capacityplanner.v1beta.Unit Protobuf enum google.cloud.capacityplanner.v1beta.Unit
com.google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod Methods for converting sampled data to time series values.
com.google.cloud.capacityplanner.v1beta.Value.ValueCase