{ "batchPath": "batch", "version": "v1beta", "mtlsRootUrl": "https://capacityplanner.mtls.googleapis.com/", "name": "capacityplanner", "ownerDomain": "google.com", "rootUrl": "https://capacityplanner.googleapis.com/", "kind": "discovery#restDescription", "discoveryVersion": "v1", "basePath": "", "baseUrl": "https://capacityplanner.googleapis.com/", "id": "capacityplanner:v1beta", "revision": "20260327", "description": "Provides programmatic access to Capacity Planner features.", "schemas": { "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "GoogleRpcStatus": { "id": "GoogleRpcStatus", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "GoogleCloudCapacityplannerV1betaQueryUsageHistoriesRequest": { "id": "GoogleCloudCapacityplannerV1betaQueryUsageHistoriesRequest", "description": "The `QueryUsageHistories` request. Next : 17", "type": "object", "properties": { "locationLevel": { "description": "Optional. The location level of the reservations usage timeseries.", "type": "string", "enumDescriptions": [ "No location type was specified.", "Time series values represent usage aggregated at the region level.", "Time series values represent usage aggregated at the zone level." ], "enum": [ "LOCATION_TYPE_UNSPECIFIED", "REGIONAL", "ZONAL" ] }, "isSpot": { "description": "Optional. The is_spot flag is used to fetch the usage data for preemptible Resources.", "type": "boolean" }, "machineFamily": { "description": "The machine family for the `UsageHistory` values to return. Possible values include \"n1\", and \"n2d\". See https://cloud.google.com/compute/docs/machine-types for more examples. Empty machine_family will return results matching all machine families.", "type": "string" }, "machineShape": { "description": "Optional. The machine shape for the `UsageHistory` values to return.", "$ref": "GoogleCloudCapacityplannerV1betaMachineShape" }, "diskType": { "description": "Optional. The disk_type for the `UsageHistory` values to return request with persistent-disk cloud_resource_type. Empty disk_type will return results matching all disk types.", "type": "string" }, "confidentialMode": { "description": "Optional. Whether the persistent disk is in confidential mode.", "type": "boolean" }, "gpuType": { "description": "Optional. The GPU type for the `UsageHistory` values to return. Sample values are \"nvidia-tesla-t4\", and \"nvidia-tesla-a100\". See https://cloud.google.com/compute/docs/gpus for a list. Empty gpu_type will return results matching all GPUs.", "type": "string" }, "tpuType": { "description": "Optional. The TPU type for the `UsageHistory` values to return. Empty tpu_type will return results matching all TPUs.", "type": "string" }, "gcsBucketTraffic": { "description": "Optional. Cloud Storage bucket traffic resource for the `UsageHistory` values to return.", "$ref": "GoogleCloudCapacityplannerV1betaGcsBucketTraffic" }, "cloudResourceType": { "description": "Required. The resource for the `UsageHistory` values to return. Possible values include \"gce-vcpus\", \"gce-ram\", \"gce-local-ssd\", \"gce-persistent-disk\", \"gce-gpu\" and \"gce-tpu\" and \"gcs-bucket-read-throughput\".", "type": "string" }, "usageAggregationMethod": { "description": "The method that should be used to convert sampled usage data to daily usage values. AGGREGATION_METHOD_UNSPECIFIED will return results matching all the aggregation methods.", "type": "string", "enumDescriptions": [ "No aggregation method is specified.", "", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the 50th(median) percentile of the sampled values.", "Time series values represent the 75th percentile of the sampled values.", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the max of the sampled values." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "MEDIAN", "PEAK", "P50", "P75", "P99", "P100" ] }, "startDate": { "description": "Optional. The start date of reservations usage.", "$ref": "GoogleTypeDate" }, "endDate": { "description": "Optional. The end date of reservations usage.", "$ref": "GoogleTypeDate" } } }, "GoogleCloudCapacityplannerV1betaMachineShape": { "id": "GoogleCloudCapacityplannerV1betaMachineShape", "description": "Machine shape details Next : 13", "type": "object", "properties": { "machineFamily": { "description": "Optional. The VM family.", "type": "string" }, "machineType": { "description": "Optional. The characteristics of the sampled VM expressed as a string.", "type": "string" }, "machineShape": { "description": "Optional. The customer visible string representing the type of VM.", "type": "string" }, "cpuCores": { "description": "Optional. Number of CPU cores per VM.", "type": "number", "format": "double" }, "gpuType": { "description": "Optional. The type of GPU with the VM.", "type": "string" }, "gpuComputeType": { "description": "Optional. The GPU name recognized by Compute Engine APIs.", "type": "string" }, "gpuCores": { "description": "Optional. The number of GPU cores per VM.", "type": "string", "format": "int64" }, "localSsdPartitions": { "description": "Optional. The number of local SSD partitions per VM.", "type": "string", "format": "int64" }, "localSsdGb": { "description": "Optional. Total amount of local SSD storage.", "type": "number", "format": "double" }, "memoryGb": { "description": "Optional. Total amount of memory with the VM.", "type": "number", "format": "double" }, "localSsdInterface": { "description": "Optional. The local SSD interface used such as nvme or scsi", "type": "string" }, "minCpuPlatform": { "description": "Optional. The Min-cpu platform used such as icelake", "type": "string" } } }, "GoogleCloudCapacityplannerV1betaGcsBucketTraffic": { "id": "GoogleCloudCapacityplannerV1betaGcsBucketTraffic", "description": "Cloud Storage Bucket Traffic attributes for usage and forecast of read/write throughput etc.", "type": "object", "properties": { "trafficPath": { "description": "Optional. Path type for the Cloud Storage bucket traffic.", "type": "string", "enumDescriptions": [ "Unspecified traffic path.", "Traffic path through Google's network.", "Traffic path through the internet." ], "enum": [ "TRAFFIC_PATH_UNSPECIFIED", "TRAFFIC_PATH_GOOGLE", "TRAFFIC_PATH_INTERNET" ] }, "bucketLocationType": { "description": "Optional. Location type of the Cloud Storage bucket.", "type": "string", "enumDescriptions": [ "Unspecified location type.", "Single region location type.", "Dual region location type.", "Multi region location type." ], "enum": [ "LOCATION_TYPE_UNSPECIFIED", "LOCATION_TYPE_SINGLE_REGION", "LOCATION_TYPE_DUAL_REGION", "LOCATION_TYPE_MULTI_REGION" ] }, "bucketLocation": { "description": "Optional. Location of the Cloud Storage bucket e.g. us-central1 (single region), us (multi region) and eur4 - europe-north1 and europe-west4 (dual region).", "type": "string" } } }, "GoogleTypeDate": { "id": "GoogleTypeDate", "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "type": "object", "properties": { "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "type": "integer", "format": "int32" }, "month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "type": "integer", "format": "int32" }, "day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "type": "integer", "format": "int32" } } }, "GoogleCloudCapacityplannerV1betaQueryUsageHistoriesResponse": { "id": "GoogleCloudCapacityplannerV1betaQueryUsageHistoriesResponse", "description": "The `QueryUsageHistories` response.", "type": "object", "properties": { "usageHistories": { "description": "The usage histories that match the request.", "type": "array", "items": { "$ref": "GoogleCloudCapacityplannerV1betaUsageHistory" } } } }, "GoogleCloudCapacityplannerV1betaUsageHistory": { "id": "GoogleCloudCapacityplannerV1betaUsageHistory", "description": "A collection of data points that describes the historical time-varying values of a resource.", "type": "object", "properties": { "timeSeries": { "description": "The collection of data points that represent the historical values.", "$ref": "GoogleCloudCapacityplannerV1betaTimeSeries" }, "aggregationMethod": { "description": "Method used to convert sampled usage data to time series values.", "type": "string", "enumDescriptions": [ "No aggregation method is specified.", "", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the 50th(median) percentile of the sampled values.", "Time series values represent the 75th percentile of the sampled values.", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the max of the sampled values." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "MEDIAN", "PEAK", "P50", "P75", "P99", "P100" ] } } }, "GoogleCloudCapacityplannerV1betaTimeSeries": { "id": "GoogleCloudCapacityplannerV1betaTimeSeries", "description": "A collection of data points that describes the time-varying values of a resource. A time series is identified by its ID. Next : 14", "type": "object", "properties": { "locationType": { "description": "Required. The type of location that the time series is summarizing.", "type": "string", "enumDescriptions": [ "No location type was specified.", "Time series values represent usage aggregated at the region level.", "Time series values represent usage aggregated at the zone level." ], "enum": [ "LOCATION_TYPE_UNSPECIFIED", "REGIONAL", "ZONAL" ] }, "location": { "description": "Optional. The location of the usage data in time series.", "type": "string" }, "isSpot": { "description": "Optional. The location of the usage data in time series.", "type": "boolean" }, "machineFamily": { "description": "The machine family for the time series values to return. Possible values include \"n1\" and \"n2d\".", "type": "string" }, "diskType": { "description": "The disk type for the time series values to return.", "type": "string" }, "confidentialMode": { "description": "Optional. The confidential mode for disk.", "type": "boolean" }, "gpuType": { "description": "The GPU type of the time series.", "type": "string" }, "tpuType": { "description": "The TPU type of the time series.", "type": "string" }, "machineShape": { "description": "The machine shape of the time series.", "$ref": "GoogleCloudCapacityplannerV1betaMachineShape" }, "gcsBucketTraffic": { "description": "Output only. The Cloud Storage bucket traffic resource for usage time series.", "readOnly": true, "$ref": "GoogleCloudCapacityplannerV1betaGcsBucketTraffic" }, "cloudResourceType": { "description": "The resource for the time series values to return. Possible values include \"gce-vcpus\", \"gce-ram\", \"gce-local-ssd\", \"gce-persistent-disk\", \"gce-gpu\", \"gce-tpu\" and \"gce-vm\".", "type": "string" }, "points": { "description": "The data points of this time series. When listing time series, points are returned in chronological order.", "type": "array", "items": { "$ref": "GoogleCloudCapacityplannerV1betaPoint" } }, "unit": { "description": "The units in which the values are reported.", "type": "string" } } }, "GoogleCloudCapacityplannerV1betaPoint": { "id": "GoogleCloudCapacityplannerV1betaPoint", "description": "A single data point in a time series.", "type": "object", "properties": { "eventTime": { "description": "The time which the data point applies.", "type": "string", "format": "google-datetime" }, "value": { "description": "The value of the data point.", "type": "number", "format": "double" } } }, "GoogleCloudCapacityplannerV1betaQueryForecastsRequest": { "id": "GoogleCloudCapacityplannerV1betaQueryForecastsRequest", "description": "The `QueryForecasts` request. Next : 17", "type": "object", "properties": { "machineFamily": { "description": "The machine family to use to select the `Forecast` values to return. Possible values include \"n1\", and \"n2d\". Empty machine_family will return results matching all machine families.", "type": "string" }, "machineShape": { "description": "Optional. The machine shape for the time series values to return.", "$ref": "GoogleCloudCapacityplannerV1betaMachineShape" }, "diskType": { "description": "Optional. The disk_type for the `Forecast` values to return with request persistent-disk cloud_resource_type. Empty disk_type will return results matching all disk types.", "type": "string" }, "confidentialMode": { "description": "Optional. Whether the persistent disk is in confidential mode.", "type": "boolean" }, "gpuType": { "description": "Optional. The GPU type for the `Forecast` values to return. Sample values are \"nvidia-tesla-t4\", and \"nvidia-tesla-a100\". See https://cloud.google.com/compute/docs/gpus for a list. Empty gpu_type will return results matching all GPUs.", "type": "string" }, "tpuType": { "description": "Optional. The TPU type for the `Forecast` values to return. Empty tpu_type will return results matching all TPUs.", "type": "string" }, "cloudResourceType": { "description": "Required. The resource for the `Forecast` values to return. Possible values include \"gce-vcpus\", \"gce-ram\", \"gce-local-ssd\", \"gce-persistent-disk\", \"gce-gpu\" and \"gce-tpu\".", "type": "string" }, "forecastType": { "description": "The type of forecast to use to select the `Forecast` values to return. FORECAST_TYPE_UNSPECIFIED will return results matching all the forecast types.", "type": "string", "enumDescriptions": [ "No forecast type is specified.", "Statistical forecast.", "Statistical forecast that attempts to predict the seasonal affects of Black Friday and Cyber Monday.", "Yearly Seasonality model provides generic seasonality beyond BFCM." ], "enum": [ "FORECAST_TYPE_UNSPECIFIED", "STATISTICAL", "STATISTICAL_WITH_BFCM", "YEARLY_SEASONALITY" ] }, "predictionInterval": { "description": "The prediction interval to use to select the `Forecast` values to return. PREDICTION_INTERVAL_UNSPECIFIED will return results matching all prediction intervals.", "type": "string", "enumDescriptions": [ "No prediction interval is specified.", "This represents a prediction interval that has 90% confidence. For example, for a symmetric prediction interval, a `PredictionInterval` of `PREDICTION_INTERVAL_90` means that the `UPPER_BOUND` will represent the 95th precentile.", "This represents a prediction interval that has 50% confidence. For example, for a symmetric prediction interval, a `PredictionInterval` of `PREDICTION_INTERVAL_50` means that the `UPPER_BOUND` will represent the 75th precentile." ], "enum": [ "PREDICTION_INTERVAL_UNSPECIFIED", "PREDICTION_INTERVAL_90", "PREDICTION_INTERVAL_50" ] }, "aggregationMethod": { "description": "Aggregation Method of the historical usage for which the forecast is generated", "type": "string", "enumDescriptions": [ "No aggregation method is specified.", "", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the 50th(median) percentile of the sampled values.", "Time series values represent the 75th percentile of the sampled values.", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the max of the sampled values." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "MEDIAN", "PEAK", "P50", "P75", "P99", "P100" ] }, "startDate": { "description": "Optional. The start date from which you want the Forecast records to be returned (inclusive).", "$ref": "GoogleTypeDate" }, "endDate": { "description": "Optional. The last date until which you want the Forecast records to be returned (inclusive).", "$ref": "GoogleTypeDate" }, "generationDate": { "description": "Optional. If specified, this field returns the Forecast data from the latest run on or after the provided generationDate. If not specificied, this field returns the most recently generated forecast.", "$ref": "GoogleTypeDate" } } }, "GoogleCloudCapacityplannerV1betaQueryForecastsResponse": { "id": "GoogleCloudCapacityplannerV1betaQueryForecastsResponse", "description": "The `QueryForecasts` response.", "type": "object", "properties": { "forecasts": { "description": "The forecasts that match the request.", "type": "array", "items": { "$ref": "GoogleCloudCapacityplannerV1betaForecast" } } } }, "GoogleCloudCapacityplannerV1betaForecast": { "id": "GoogleCloudCapacityplannerV1betaForecast", "description": "A collection of data points that describes the predicted time-varying values of a resource.", "type": "object", "properties": { "name": { "description": "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}`", "type": "string" }, "timeSeries": { "description": "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).", "$ref": "GoogleCloudCapacityplannerV1betaTimeSeries" }, "forecastType": { "description": "The type of forecast.", "type": "string", "enumDescriptions": [ "No forecast type is specified.", "Statistical forecast.", "Statistical forecast that attempts to predict the seasonal affects of Black Friday and Cyber Monday.", "Yearly Seasonality model provides generic seasonality beyond BFCM." ], "enum": [ "FORECAST_TYPE_UNSPECIFIED", "STATISTICAL", "STATISTICAL_WITH_BFCM", "YEARLY_SEASONALITY" ] }, "bounds": { "description": "The bounds represented by this forecast time series.", "type": "string", "enumDescriptions": [ "No bounds is specified.", "The time series represents the upper bound of the forecast.", "The time series represents the median expected forecast value.", "The time series represents the lower bound of the forecast." ], "enum": [ "BOUNDS_UNSPECIFIED", "LOWER_BOUND", "MEDIAN", "UPPER_BOUND" ] }, "predictionInterval": { "description": "The prediction interval represented by the time series.", "type": "string", "enumDescriptions": [ "No prediction interval is specified.", "This represents a prediction interval that has 90% confidence. For example, for a symmetric prediction interval, a `PredictionInterval` of `PREDICTION_INTERVAL_90` means that the `UPPER_BOUND` will represent the 95th precentile.", "This represents a prediction interval that has 50% confidence. For example, for a symmetric prediction interval, a `PredictionInterval` of `PREDICTION_INTERVAL_50` means that the `UPPER_BOUND` will represent the 75th precentile." ], "enum": [ "PREDICTION_INTERVAL_UNSPECIFIED", "PREDICTION_INTERVAL_90", "PREDICTION_INTERVAL_50" ] }, "aggregationMethod": { "description": "Aggregation Method of the historical usage for which the forecast is generated", "type": "string", "enumDescriptions": [ "No aggregation method is specified.", "", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the 50th(median) percentile of the sampled values.", "Time series values represent the 75th percentile of the sampled values.", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the max of the sampled values." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "MEDIAN", "PEAK", "P50", "P75", "P99", "P100" ] } } }, "GoogleCloudCapacityplannerV1betaQueryReservationsResponse": { "id": "GoogleCloudCapacityplannerV1betaQueryReservationsResponse", "description": "The `QueryReservations` response.", "type": "object", "properties": { "reservations": { "description": "The reservations data that match the request.", "type": "array", "items": { "$ref": "GoogleCloudCapacityplannerV1betaReservationData" } } } }, "GoogleCloudCapacityplannerV1betaReservationData": { "id": "GoogleCloudCapacityplannerV1betaReservationData", "description": "Response entity for reservations data.", "type": "object", "properties": { "name": { "description": "Identifier. The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/reservations/{reservation_id}` or `organizations/{organization_id}/locations/{location_id}/reservations/{reservation_id}` or `folders/{folder_id}/locations/{location_id}/reservations/{reservation_id}`", "type": "string" }, "timeSeries": { "description": "The collection of data points that represent the aggregated reserved value for reservations filtered by the criteria.", "$ref": "GoogleCloudCapacityplannerV1betaTimeSeries" }, "usedReservationValues": { "description": "The collection of data points that represent the aggregated used value for reservations filtered by the criteria.", "$ref": "GoogleCloudCapacityplannerV1betaTimeSeries" }, "futureReservations": { "description": "Future reservations filtered by the criteria.", "type": "array", "items": { "$ref": "GoogleCloudCapacityplannerV1betaFutureReservation" } }, "allocations": { "description": "Allocations filtered by the criteria.", "type": "array", "items": { "$ref": "GoogleCloudCapacityplannerV1betaAllocation" } } } }, "GoogleCloudCapacityplannerV1betaFutureReservation": { "id": "GoogleCloudCapacityplannerV1betaFutureReservation", "description": "Repesents Future Reservation request which is part of aggregated reservations data response of \"QueryReservations\".", "type": "object", "properties": { "specificSkuProperties": { "description": "Future Reservation configuration to indicate instance properties and total count.", "$ref": "GoogleCloudCapacityplannerV1betaFutureReservationSpecificSKUProperties" }, "id": { "description": "A unique identifier for this future reservation. The server defines this identifier.", "type": "string", "format": "int64" }, "createTime": { "description": "The creation timestamp for this future reservation.", "type": "string", "format": "google-datetime" }, "zone": { "description": "URL of the Zone where this future reservation resides.", "type": "string" }, "description": { "description": "Description of the future reservation provided by user.", "type": "string" }, "futureReservation": { "description": "The future reservation resource name.", "type": "string" }, "ownerProjectId": { "type": "string" }, "timeWindow": { "description": "Time window for this Future Reservation.", "$ref": "GoogleCloudCapacityplannerV1betaFutureReservationTimeWindow" }, "shareSettings": { "description": "List of Projects/Folders to share with.", "$ref": "GoogleCloudCapacityplannerV1betaAllocationShareSettings" }, "namePrefix": { "description": "Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####.", "type": "string" }, "status": { "description": "Status of the Future Reservation", "$ref": "GoogleCloudCapacityplannerV1betaFutureReservationStatus" }, "autoCreatedReservationsDeleteTime": { "description": "Future timestamp when the FR auto-created reservations will be deleted by Compute Engine. Format of this field must be a valid RFC3339 value.", "type": "string", "format": "google-datetime" }, "autoDeleteAutoCreatedReservations": { "description": "Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.", "type": "boolean" } } }, "GoogleCloudCapacityplannerV1betaFutureReservationSpecificSKUProperties": { "id": "GoogleCloudCapacityplannerV1betaFutureReservationSpecificSKUProperties", "description": "Represents specific SKU properties for the Future Reservation.", "type": "object", "properties": { "instanceProperties": { "description": "Properties of the SKU instances being reserved.", "$ref": "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocationAllocatedInstanceProperties" }, "totalCount": { "description": "Total number of instances for which capacity assurance is requested at a future time period.", "type": "string", "format": "int64" } } }, "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocationAllocatedInstanceProperties": { "id": "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocationAllocatedInstanceProperties", "description": "Properties of the SKU instances being reserved.", "type": "object", "properties": { "machineType": { "description": "Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.", "type": "string" }, "guestAccelerator": { "description": "Specifies accelerator type and count.", "type": "array", "items": { "$ref": "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocationAllocatedInstancePropertiesAcceleratorConfig" } }, "minCpuPlatform": { "description": "Minimum cpu platform the reservation.", "type": "string" }, "localSsd": { "description": "Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.", "type": "array", "items": { "$ref": "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocationAllocatedInstancePropertiesAllocatedDisk" } } } }, "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocationAllocatedInstancePropertiesAcceleratorConfig": { "id": "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocationAllocatedInstancePropertiesAcceleratorConfig", "description": "A specification of the type and number of accelerator cards attached to the instance.", "type": "object", "properties": { "type": { "description": "Accelerator name. See https://cloud.google.com/compute/docs/gpus/#introduction for a full list of accelerator types.", "type": "string" }, "count": { "description": "The number of the guest accelerator cards exposed to this instance.", "type": "integer", "format": "int32" } } }, "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocationAllocatedInstancePropertiesAllocatedDisk": { "id": "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocationAllocatedInstancePropertiesAllocatedDisk", "description": "A specification of the interface and size of disk attached to the instance.", "type": "object", "properties": { "diskSizeGb": { "description": "Specifies the size of the disk in base-2 GB.", "type": "string", "format": "int64" }, "diskInterface": { "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "SCSI disk interface.", "NVME disk interface.", "NVDIMM disk interface.", "ISCSI disk interface." ], "enum": [ "DISK_INTERFACE_UNSPECIFIED", "SCSI", "NVME", "NVDIMM", "ISCSI" ] } } }, "GoogleCloudCapacityplannerV1betaFutureReservationTimeWindow": { "id": "GoogleCloudCapacityplannerV1betaFutureReservationTimeWindow", "description": "Represents time window for the Future Reservation.", "type": "object", "properties": { "startTime": { "description": "Start time of the Future Reservation.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "End time of the Future Reservation.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudCapacityplannerV1betaAllocationShareSettings": { "id": "GoogleCloudCapacityplannerV1betaAllocationShareSettings", "description": "The share setting for reservation.", "type": "object", "properties": { "shareType": { "description": "Type of sharing for this shared-reservation", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Shared-reservation is open to entire Organization", "Shared-reservation is open to specific projects", "Default value.", "Shared-reservation is open to direct child projects of specific folders." ], "enum": [ "SHARE_TYPE_UNSPECIFIED", "ORGANIZATION", "SPECIFIC_PROJECTS", "LOCAL", "DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS" ] }, "projects": { "description": "A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudCapacityplannerV1betaFutureReservationStatus": { "id": "GoogleCloudCapacityplannerV1betaFutureReservationStatus", "description": "Represents status related to the future reservation.", "type": "object", "properties": { "procurementStatus": { "description": "Current state of this Future Reservation", "type": "string", "enumDescriptions": [ "This is unused status value.", "Future reservation is pending approval by Google Cloud Platform.", "Future reservation is approved by Google Cloud Platform.", "Future reservation is committed by the customer.", "Future reservation is rejected by Google Cloud Platform.", "Future reservation is cancelled by the customer.", "Future reservation is being procured by Google Cloud Platform. Beyond this point, Future reservation is locked and no further modifications are allowed.", "Future reservation capacity is being provisioned. This state will be entered after start_time, while reservations are being created to provide total_count reserved instance slots. This state will not persist past start_time + 24h.", "Future reservation is fulfilled completely.", "Future reservation failed. No additional reservations were provided.", "Future reservation is partially fulfilled. Additional reservations were provided but did not reach total_count reserved instance slots.", "Related status for PlanningStatus.Draft. Transitions to PENDING_APPROVAL upon user submitting FR.", "An Amendment to the Future Reservation has been requested. If the Amendment is declined, the Future Reservation will be restored to the last known good state." ], "enum": [ "PROCUREMENT_STATUS_UNSPECIFIED", "PENDING_APPROVAL", "APPROVED", "COMMITTED", "DECLINED", "CANCELLED", "PROCURING", "PROVISIONING", "FULFILLED", "FAILED", "FAILED_PARTIALLY_FULFILLED", "DRAFTING", "PENDING_AMENDMENT_APPROVAL" ] }, "lockTime": { "description": "Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time.", "type": "string", "format": "google-datetime" }, "autoCreatedReservations": { "description": "Fully qualified urls of the automatically created reservations at start_time.", "type": "array", "items": { "type": "string" } }, "fulfilledCount": { "description": "This count indicates the fulfilled capacity so far. This is set during \"PROVISIONING\" state. This count also includes capacity delivered as part of existing matching reservations.", "type": "string", "format": "int64" } } }, "GoogleCloudCapacityplannerV1betaAllocation": { "id": "GoogleCloudCapacityplannerV1betaAllocation", "description": "Repesents Allocation which is part of aggregated reservations data response of \"QueryReservations\".", "type": "object", "properties": { "specificAllocation": { "description": "Reservation for instances with specific machine shapes.", "$ref": "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocation" }, "id": { "description": "The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "int64" }, "createTime": { "description": "The creation timestamp for this allocation.", "type": "string", "format": "google-datetime" }, "zone": { "description": "Zone in which the reservation resides.", "type": "string" }, "description": { "description": "A description while creating reservation.", "type": "string" }, "allocation": { "description": "The reservation resource name.", "type": "string" }, "ownerProjectId": { "type": "string" }, "status": { "description": "The status of the reservation.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Invalid Reservation", "Resources are being allocated for the reservation.", "Reservation has allocated all its resources.", "Reservation is currently being deleted.", "Reservation is currently being resized." ], "enum": [ "STATUS_UNSPECIFIED", "INVALID", "CREATING", "READY", "DELETING", "UPDATING" ] }, "shareSettings": { "description": "Specify share-settings to create a shared reservation.", "$ref": "GoogleCloudCapacityplannerV1betaAllocationShareSettings" }, "autoDeleteTime": { "description": "Absolute time in future when the reservation will be auto-deleted by Compute Engine.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocation": { "id": "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocation", "description": "This reservation type allows to pre allocate specific instance configuration.", "type": "object", "properties": { "instanceProperties": { "description": "The instance properties for the reservation.", "$ref": "GoogleCloudCapacityplannerV1betaAllocationSpecificSKUAllocationAllocatedInstanceProperties" }, "count": { "description": "Specifies the number of resources that are allocated.", "type": "string", "format": "int64" }, "usedCount": { "description": "Indicates how many instances are in use.", "type": "string", "format": "int64" }, "assuredCount": { "description": "Indicates how many instances are actually usable currently.", "type": "string", "format": "int64" } } }, "GoogleCloudCapacityplannerV1betaExportUsageHistoriesRequest": { "id": "GoogleCloudCapacityplannerV1betaExportUsageHistoriesRequest", "description": "The `ExportUsageHistories` request Next : 12", "type": "object", "properties": { "isSpot": { "description": "Optional. The is_spot flag is used to fetch the usage data for preemptible Resources.", "type": "boolean" }, "machineFamily": { "description": "Optional. The machine family for the `UsageHistory` values to return. Possible values include \"n1\", and \"n2d\". See https://cloud.google.com/compute/docs/machine-types for more examples.", "type": "string" }, "machineShape": { "description": "Optional. The machine shape for the time series values to export.", "$ref": "GoogleCloudCapacityplannerV1betaMachineShape" }, "diskType": { "description": "Optional. The disk_type for the `UsageHistory` values to return request with persistent-disk resource_type. Possible values include \"pd-ssd\", \"pd-standard\", \"pd-balanced\", and \"pd-extreme\".", "type": "string" }, "gpuType": { "description": "Optional. The GPU type for the `UsageHistory` values to return. Sample values are \"nvidia-tesla-t4\", and \"nvidia-tesla-a100\". See https://cloud.google.com/compute/docs/gpus for a list. Empty gpu_type will return results matching all GPUs.", "type": "string" }, "tpuType": { "description": "Optional. The TPU type for the `UsageHistory` values to return. Empty tpu_type will return results matching all TPUs.", "type": "string" }, "resourceType": { "description": "Required. The resource for the `UsageHistory` values to return. Possible values include \"gce-vcpus\", \"gce-ram\", \"gce-local-ssd\", \"gce-persistent-disk\", \"gce-gpu\" and \"gce-tpu\".", "type": "string" }, "usageAggregationMethod": { "description": "Optional. The method that should be used to convert sampled usage data to daily usage values. AGGREGATION_METHOD_UNSPECIFIED will return results matching all the aggregation methods.", "type": "string", "enumDescriptions": [ "No aggregation method is specified.", "", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the 50th(median) percentile of the sampled values.", "Time series values represent the 75th percentile of the sampled values.", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the max of the sampled values." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "MEDIAN", "PEAK", "P50", "P75", "P99", "P100" ] }, "startDate": { "description": "Optional. The start date of usage.", "$ref": "GoogleTypeDate" }, "endDate": { "description": "Optional. The end date of usage.", "$ref": "GoogleTypeDate" }, "outputConfig": { "description": "Required. Output configuration indicating where the results will be output to.", "$ref": "GoogleCloudCapacityplannerV1betaOutputConfig" } } }, "GoogleCloudCapacityplannerV1betaOutputConfig": { "id": "GoogleCloudCapacityplannerV1betaOutputConfig", "description": "Output configuration for export destination.", "type": "object", "properties": { "gcsDestination": { "description": "Destination on Cloud Storage.", "$ref": "GoogleCloudCapacityplannerV1betaGcsDestination" }, "bigqueryDestination": { "description": "Destination on BigQuery.", "$ref": "GoogleCloudCapacityplannerV1betaBigQueryDestination" } } }, "GoogleCloudCapacityplannerV1betaGcsDestination": { "id": "GoogleCloudCapacityplannerV1betaGcsDestination", "description": "A Cloud Storage location.", "type": "object", "properties": { "uri": { "description": "Optional. The path to the file in Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails.", "type": "string" }, "bucket": { "description": "Required. The bucket name to which the export will be stored.", "type": "string" }, "object": { "description": "Required. The object name to which the export will be stored.", "type": "string" }, "force": { "description": "Optional. Flag to indicate overwrite in case file already exists.", "type": "boolean" } } }, "GoogleCloudCapacityplannerV1betaBigQueryDestination": { "id": "GoogleCloudCapacityplannerV1betaBigQueryDestination", "description": "A BigQuery destination for exporting assets to.", "type": "object", "properties": { "dataset": { "description": "Required. The BigQuery dataset in format \"projects/{projectId}/datasets/{datasetId}\", to which the snapshot result should be exported. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error.", "type": "string" }, "table": { "description": "Required. The BigQuery table to which the snapshot result should be written.", "type": "string" }, "partitionKey": { "description": "Optional. The partition key for BigQuery partitioned table.", "type": "string", "enumDescriptions": [ "Unspecified partition key. Tables won't be partitioned using this option.", "The time when the request is received. If specified as partition key, the result table(s) is partitioned by the RequestTime column, an additional timestamp column representing when the request was received." ], "enum": [ "PARTITION_KEY_UNSPECIFIED", "REQUEST_TIME" ] }, "writeDisposition": { "description": "Optional. Specifies the action that occurs if the destination table or partition already exists.", "type": "string", "enumDescriptions": [ "Unspecified write disposition.", "If the table or partition already exists, BigQuery appends the data to the table or the latest partition.", "If the table or partition already exists, BigQuery overwrites the entire table or all the partitions data.", "If the table already exists and contains data, an error is returned." ], "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_APPEND", "WRITE_TRUNCATE", "WRITE_EMPTY" ] }, "createDisposition": { "description": "Optional. Specifies the action that occurs if the destination table does not exist", "type": "string", "enumDescriptions": [ "Unspecified create disposition.", "If the table does not exist, BigQuery creates the table.", "If the table does not exist, an error will be returned." ], "enum": [ "CREATE_DISPOSITION_UNSPECIFIED", "CREATE_IF_NEEDED", "CREATE_NEVER" ] }, "gcsLocation": { "description": "Optional. Specifies the Cloud Storage location. Users can choose to provide a location for Cloud Storage bucket to store the exported data. (as it is possible that some locations are restricted via org policy for that project) Temporary Cloud Storage bucket creation is an interim step for BigQuery upload. If no value is provided, the default location used will be 'US'.", "type": "string" } } }, "GoogleCloudCapacityplannerV1betaExportForecastsRequest": { "id": "GoogleCloudCapacityplannerV1betaExportForecastsRequest", "description": "The `ExportForecasts` request Next : 13", "type": "object", "properties": { "machineFamily": { "description": "Optional. The machine family to use to select the `Forecast` values to return. Possible values include \"n1\", and \"n2d\".", "type": "string" }, "machineShape": { "description": "Optional. The machine shape for the time series values to export.", "$ref": "GoogleCloudCapacityplannerV1betaMachineShape" }, "diskType": { "description": "Optional. The disk_type for the `Forecast` values to return with request persistent-disk resource_type.", "type": "string" }, "gpuType": { "description": "Optional. The GPU type for the `Forecast` values to return. Sample values are \"nvidia-tesla-t4\", and \"nvidia-tesla-a100\". See https://cloud.google.com/compute/docs/gpus for a list. Empty gpu_type will return results matching all GPUs.", "type": "string" }, "tpuType": { "description": "Optional. The TPU type for the `Forecast` values to return. Empty tpu_type will return results matching all TPUs.", "type": "string" }, "resourceType": { "description": "Required. The resource for the `Forecast` values to return. Possible values include \"gce-vcpus\", \"gce-ram\", \"gce-local-ssd\", \"gce-persistent-disk\", \"gce-gpu\" and \"gce-tpu\".", "type": "string" }, "predictionInterval": { "description": "Optional. The prediction interval to use to select the `Forecast` values to return. PREDICTION_INTERVAL_UNSPECIFIED will return results matching all prediction intervals.", "type": "string", "enumDescriptions": [ "No prediction interval is specified.", "This represents a prediction interval that has 90% confidence. For example, for a symmetric prediction interval, a `PredictionInterval` of `PREDICTION_INTERVAL_90` means that the `UPPER_BOUND` will represent the 95th precentile.", "This represents a prediction interval that has 50% confidence. For example, for a symmetric prediction interval, a `PredictionInterval` of `PREDICTION_INTERVAL_50` means that the `UPPER_BOUND` will represent the 75th precentile." ], "enum": [ "PREDICTION_INTERVAL_UNSPECIFIED", "PREDICTION_INTERVAL_90", "PREDICTION_INTERVAL_50" ] }, "aggregationMethod": { "description": "Optional. Aggregation Method of the historical usage for which the forecast is generated.", "type": "string", "enumDescriptions": [ "No aggregation method is specified.", "", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the 50th(median) percentile of the sampled values.", "Time series values represent the 75th percentile of the sampled values.", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the max of the sampled values." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "MEDIAN", "PEAK", "P50", "P75", "P99", "P100" ] }, "startDate": { "description": "Optional. The start date of forecasts.", "$ref": "GoogleTypeDate" }, "endDate": { "description": "Optional. The end date of forecasts.", "$ref": "GoogleTypeDate" }, "outputConfig": { "description": "Required. Output configuration indicating where the results will be output to.", "$ref": "GoogleCloudCapacityplannerV1betaOutputConfig" } } }, "GoogleCloudCapacityplannerV1betaExportReservationsUsageRequest": { "id": "GoogleCloudCapacityplannerV1betaExportReservationsUsageRequest", "description": "The `ExportReservationsUsage` request", "type": "object", "properties": { "machineFamily": { "description": "Optional. The machine family to query reservations and usage by. For example: n1, n2d.", "type": "string" }, "machineShape": { "description": "Optional. The machine_shape as a filter to select matching reservations and its usage.", "$ref": "GoogleCloudCapacityplannerV1betaMachineShape" }, "gpuType": { "description": "Optional. The GPU type to query reservations and usage by. For example: NVIDIA T4.", "type": "string" }, "locationLevel": { "description": "Optional. The location level of the reservations usage timeseries.", "type": "string", "enumDescriptions": [ "No location type was specified.", "Time series values represent usage aggregated at the region level.", "Time series values represent usage aggregated at the zone level." ], "enum": [ "LOCATION_TYPE_UNSPECIFIED", "REGIONAL", "ZONAL" ] }, "cloudResourceType": { "description": "Required. The resource for the `ReservationsUsage` values to return. Possible values include \"gce-vcpus\", \"gce-ram\", \"gce-local-ssd\", and \"gce-gpu\".", "type": "string" }, "usageAggregationMethod": { "description": "Required. The method that should be used to convert sampled reservations data to daily usage values.", "type": "string", "enumDescriptions": [ "No aggregation method is specified.", "", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the 50th(median) percentile of the sampled values.", "Time series values represent the 75th percentile of the sampled values.", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the max of the sampled values." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "MEDIAN", "PEAK", "P50", "P75", "P99", "P100" ] }, "shareType": { "description": "Optional. Type of share settings to filter reservations in response. If unspecified, all types are included.", "type": "string", "enumDescriptions": [ "No share type specified.", "Default value, for which reservation is open to only owner project.", "Shared-reservation is open to specific projects." ], "enum": [ "SHARE_TYPE_UNSPECIFIED", "SHARE_TYPE_LOCAL", "SHARE_TYPE_SPECIFIC_PROJECTS" ] }, "startDate": { "description": "Optional. The start date of reservations usage.", "$ref": "GoogleTypeDate" }, "endDate": { "description": "Optional. The end date of reservations usage.", "$ref": "GoogleTypeDate" }, "outputConfig": { "description": "Required. Output configuration indicating where the results will be output to.", "$ref": "GoogleCloudCapacityplannerV1betaOutputConfig" } } } }, "fullyEncodeReservedExpansion": true, "title": "Capacity Planner API", "ownerName": "Google", "servicePath": "", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/devstorage.full_control": { "description": "Manage your data and permissions in Cloud Storage and see the email address for your Google Account" } } } }, "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "version_module": true, "resources": { "projects": { "resources": { "operations": { "methods": { "get": { "id": "capacityplanner.projects.operations.get", "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." } } }, "locations": { "resources": { "usageHistories": { "methods": { "query": { "id": "capacityplanner.projects.locations.usageHistories.query", "path": "v1beta/{+parent}/usageHistories:query", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/usageHistories:query", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaQueryUsageHistoriesRequest" }, "response": { "$ref": "GoogleCloudCapacityplannerV1betaQueryUsageHistoriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Returns a list of the usage histories that are in the parent parameter and match your specified filters." }, "export": { "id": "capacityplanner.projects.locations.usageHistories.export", "path": "v1beta/{+parent}/usageHistories:export", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/usageHistories:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaExportUsageHistoriesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Exports historical usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table." } } }, "forecasts": { "methods": { "query": { "id": "capacityplanner.projects.locations.forecasts.query", "path": "v1beta/{+parent}/forecasts:query", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/forecasts:query", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaQueryForecastsRequest" }, "response": { "$ref": "GoogleCloudCapacityplannerV1betaQueryForecastsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Returns a list of the forecasts that are in the parent parameter and match your specified filters." }, "export": { "id": "capacityplanner.projects.locations.forecasts.export", "path": "v1beta/{+parent}/forecasts:export", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/forecasts:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaExportForecastsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Exports forecasted usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table." } } }, "reservations": { "methods": { "query": { "id": "capacityplanner.projects.locations.reservations.query", "path": "v1beta/{+parent}/reservations:query", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/reservations:query", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "locationLevel": { "description": "Optional. The location level of the reservations usage timeseries.", "location": "query", "type": "string", "enumDescriptions": [ "No location type was specified.", "Time series values represent usage aggregated at the region level.", "Time series values represent usage aggregated at the zone level." ], "enum": [ "LOCATION_TYPE_UNSPECIFIED", "REGIONAL", "ZONAL" ] }, "machineFamily": { "description": "Optional. The machine family to use to select the aggregate reserved values to return. Possible values include \"n1\", and \"n2d\" etc. Empty machine_family will return results matching all machine families.", "location": "query", "type": "string" }, "machineShape.machineFamily": { "description": "Optional. The VM family.", "location": "query", "type": "string" }, "machineShape.machineType": { "description": "Optional. The characteristics of the sampled VM expressed as a string.", "location": "query", "type": "string" }, "machineShape.machineShape": { "description": "Optional. The customer visible string representing the type of VM.", "location": "query", "type": "string" }, "machineShape.cpuCores": { "description": "Optional. Number of CPU cores per VM.", "location": "query", "type": "number", "format": "double" }, "machineShape.gpuType": { "description": "Optional. The type of GPU with the VM.", "location": "query", "type": "string" }, "machineShape.gpuComputeType": { "description": "Optional. The GPU name recognized by Compute Engine APIs.", "location": "query", "type": "string" }, "machineShape.gpuCores": { "description": "Optional. The number of GPU cores per VM.", "location": "query", "type": "string", "format": "int64" }, "machineShape.localSsdPartitions": { "description": "Optional. The number of local SSD partitions per VM.", "location": "query", "type": "string", "format": "int64" }, "machineShape.localSsdGb": { "description": "Optional. Total amount of local SSD storage.", "location": "query", "type": "number", "format": "double" }, "machineShape.memoryGb": { "description": "Optional. Total amount of memory with the VM.", "location": "query", "type": "number", "format": "double" }, "machineShape.localSsdInterface": { "description": "Optional. The local SSD interface used such as nvme or scsi", "location": "query", "type": "string" }, "machineShape.minCpuPlatform": { "description": "Optional. The Min-cpu platform used such as icelake", "location": "query", "type": "string" }, "gpuType": { "description": "Optional. The GPU type for the reserved values to return. Sample values are \"nvidia-tesla-t4\", and \"nvidia-tesla-a100\". See https://cloud.google.com/compute/docs/gpus for a list. Empty gpu_type will return results matching all GPUs.", "location": "query", "type": "string" }, "cloudResourceType": { "description": "Required. The resource for the reserved values to return. Possible values include \"gce-vcpus\", \"gce-ram\", \"gce-local-ssd\", \"gce-gpu\" and \"gce-vm\".", "location": "query", "type": "string" }, "reservationType": { "description": "Required. The Reservation type for example, future reservation request and allocation. If unspecified, all types are included.", "location": "query", "type": "string", "enumDescriptions": [ "No reservation type specified.", "Allocation refers to realized reservation either auto created or created by the users on demand.", "Future Reservation requests created by users.", "All reservations." ], "enum": [ "RESERVATION_TYPE_UNSPECIFIED", "RESERVATION_TYPE_ALLOCATION", "RESERVATION_TYPE_FUTURE_RESERVATION", "RESERVATION_TYPE_ALL" ] }, "shareType": { "description": "Optional. Types of share settings to filter reservations in response. If unspecified, all types are included.", "location": "query", "type": "string", "enumDescriptions": [ "No share type specified.", "Default value, for which reservation is open to only owner project.", "Shared-reservation is open to specific projects." ], "enum": [ "SHARE_TYPE_UNSPECIFIED", "SHARE_TYPE_LOCAL", "SHARE_TYPE_SPECIFIC_PROJECTS" ] }, "ownershipType": { "description": "Optional. Types of ownerships to filter reservations based on. In case of OWNED, it filters reservations which are owned by selected parent project/folder/organization. If unspecified, all types are included.", "location": "query", "type": "string", "enumDescriptions": [ "No ownership status specified.", "For the reservations owned within selected Google Cloud Platform Resource Container (project/folder/organization).", "For the reservations consumable within selected Google Cloud Platform Resource Container (project/folder/organization), but not owned by them." ], "enum": [ "OWNERSHIP_TYPE_UNSPECIFIED", "OWNERSHIP_TYPE_OWNED", "OWNERSHIP_TYPE_SHARED_BY_OTHERS" ] }, "reservationDataLevel": { "description": "Required. Reservations output data format.", "location": "query", "type": "string", "enumDescriptions": [ "No reservation data level specified.", "aggregated reservations data in a timeseries or aggregation over timeseries.", "per reservation detail which is equivalent of Arcus Future Reservation or Allocation with only limited fields which are useful for Capacity Planning." ], "enum": [ "RESERVATION_DATA_LEVEL_UNSPECIFIED", "RESERVATION_DATA_LEVEL_AGGREGATED", "RESERVATION_DATA_LEVEL_PER_RESERVATION" ] }, "includeUnapprovedReservations": { "description": "Optional. Whether to include pending for approval reservations in the response. This field is only applicable for future reservations.", "location": "query", "type": "boolean" }, "aggregationMethod": { "description": "Optional. Aggregation Method of the historical reservation usage", "location": "query", "type": "string", "enumDescriptions": [ "No aggregation method is specified.", "", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the 50th(median) percentile of the sampled values.", "Time series values represent the 75th percentile of the sampled values.", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the max of the sampled values." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "MEDIAN", "PEAK", "P50", "P75", "P99", "P100" ] }, "startDate.year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "location": "query", "type": "integer", "format": "int32" }, "startDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "location": "query", "type": "integer", "format": "int32" }, "startDate.day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "location": "query", "type": "integer", "format": "int32" }, "endDate.year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "location": "query", "type": "integer", "format": "int32" }, "endDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "location": "query", "type": "integer", "format": "int32" }, "endDate.day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudCapacityplannerV1betaQueryReservationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Returns a list of the reservations that are in the parent parameter and match your specified filters." } } }, "reservationsUsage": { "methods": { "export": { "id": "capacityplanner.projects.locations.reservationsUsage.export", "path": "v1beta/{+parent}/reservationsUsage:export", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/reservationsUsage:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location of the reservationsusage. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaExportReservationsUsageRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Exports reservations usage data requested by user into either an existing Cloud Storage bucket or a new/existing BigQuery table." } } } } } } }, "organizations": { "resources": { "locations": { "resources": { "usageHistories": { "methods": { "query": { "id": "capacityplanner.organizations.locations.usageHistories.query", "path": "v1beta/{+parent}/usageHistories:query", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/usageHistories:query", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaQueryUsageHistoriesRequest" }, "response": { "$ref": "GoogleCloudCapacityplannerV1betaQueryUsageHistoriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Returns a list of the usage histories that are in the parent parameter and match your specified filters." }, "export": { "id": "capacityplanner.organizations.locations.usageHistories.export", "path": "v1beta/{+parent}/usageHistories:export", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/usageHistories:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaExportUsageHistoriesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Exports historical usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table." } } }, "forecasts": { "methods": { "query": { "id": "capacityplanner.organizations.locations.forecasts.query", "path": "v1beta/{+parent}/forecasts:query", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/forecasts:query", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaQueryForecastsRequest" }, "response": { "$ref": "GoogleCloudCapacityplannerV1betaQueryForecastsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Returns a list of the forecasts that are in the parent parameter and match your specified filters." }, "export": { "id": "capacityplanner.organizations.locations.forecasts.export", "path": "v1beta/{+parent}/forecasts:export", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/forecasts:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaExportForecastsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Exports forecasted usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table." } } }, "reservations": { "methods": { "query": { "id": "capacityplanner.organizations.locations.reservations.query", "path": "v1beta/{+parent}/reservations:query", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/reservations:query", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "locationLevel": { "description": "Optional. The location level of the reservations usage timeseries.", "location": "query", "type": "string", "enumDescriptions": [ "No location type was specified.", "Time series values represent usage aggregated at the region level.", "Time series values represent usage aggregated at the zone level." ], "enum": [ "LOCATION_TYPE_UNSPECIFIED", "REGIONAL", "ZONAL" ] }, "machineFamily": { "description": "Optional. The machine family to use to select the aggregate reserved values to return. Possible values include \"n1\", and \"n2d\" etc. Empty machine_family will return results matching all machine families.", "location": "query", "type": "string" }, "machineShape.machineFamily": { "description": "Optional. The VM family.", "location": "query", "type": "string" }, "machineShape.machineType": { "description": "Optional. The characteristics of the sampled VM expressed as a string.", "location": "query", "type": "string" }, "machineShape.machineShape": { "description": "Optional. The customer visible string representing the type of VM.", "location": "query", "type": "string" }, "machineShape.cpuCores": { "description": "Optional. Number of CPU cores per VM.", "location": "query", "type": "number", "format": "double" }, "machineShape.gpuType": { "description": "Optional. The type of GPU with the VM.", "location": "query", "type": "string" }, "machineShape.gpuComputeType": { "description": "Optional. The GPU name recognized by Compute Engine APIs.", "location": "query", "type": "string" }, "machineShape.gpuCores": { "description": "Optional. The number of GPU cores per VM.", "location": "query", "type": "string", "format": "int64" }, "machineShape.localSsdPartitions": { "description": "Optional. The number of local SSD partitions per VM.", "location": "query", "type": "string", "format": "int64" }, "machineShape.localSsdGb": { "description": "Optional. Total amount of local SSD storage.", "location": "query", "type": "number", "format": "double" }, "machineShape.memoryGb": { "description": "Optional. Total amount of memory with the VM.", "location": "query", "type": "number", "format": "double" }, "machineShape.localSsdInterface": { "description": "Optional. The local SSD interface used such as nvme or scsi", "location": "query", "type": "string" }, "machineShape.minCpuPlatform": { "description": "Optional. The Min-cpu platform used such as icelake", "location": "query", "type": "string" }, "gpuType": { "description": "Optional. The GPU type for the reserved values to return. Sample values are \"nvidia-tesla-t4\", and \"nvidia-tesla-a100\". See https://cloud.google.com/compute/docs/gpus for a list. Empty gpu_type will return results matching all GPUs.", "location": "query", "type": "string" }, "cloudResourceType": { "description": "Required. The resource for the reserved values to return. Possible values include \"gce-vcpus\", \"gce-ram\", \"gce-local-ssd\", \"gce-gpu\" and \"gce-vm\".", "location": "query", "type": "string" }, "reservationType": { "description": "Required. The Reservation type for example, future reservation request and allocation. If unspecified, all types are included.", "location": "query", "type": "string", "enumDescriptions": [ "No reservation type specified.", "Allocation refers to realized reservation either auto created or created by the users on demand.", "Future Reservation requests created by users.", "All reservations." ], "enum": [ "RESERVATION_TYPE_UNSPECIFIED", "RESERVATION_TYPE_ALLOCATION", "RESERVATION_TYPE_FUTURE_RESERVATION", "RESERVATION_TYPE_ALL" ] }, "shareType": { "description": "Optional. Types of share settings to filter reservations in response. If unspecified, all types are included.", "location": "query", "type": "string", "enumDescriptions": [ "No share type specified.", "Default value, for which reservation is open to only owner project.", "Shared-reservation is open to specific projects." ], "enum": [ "SHARE_TYPE_UNSPECIFIED", "SHARE_TYPE_LOCAL", "SHARE_TYPE_SPECIFIC_PROJECTS" ] }, "ownershipType": { "description": "Optional. Types of ownerships to filter reservations based on. In case of OWNED, it filters reservations which are owned by selected parent project/folder/organization. If unspecified, all types are included.", "location": "query", "type": "string", "enumDescriptions": [ "No ownership status specified.", "For the reservations owned within selected Google Cloud Platform Resource Container (project/folder/organization).", "For the reservations consumable within selected Google Cloud Platform Resource Container (project/folder/organization), but not owned by them." ], "enum": [ "OWNERSHIP_TYPE_UNSPECIFIED", "OWNERSHIP_TYPE_OWNED", "OWNERSHIP_TYPE_SHARED_BY_OTHERS" ] }, "reservationDataLevel": { "description": "Required. Reservations output data format.", "location": "query", "type": "string", "enumDescriptions": [ "No reservation data level specified.", "aggregated reservations data in a timeseries or aggregation over timeseries.", "per reservation detail which is equivalent of Arcus Future Reservation or Allocation with only limited fields which are useful for Capacity Planning." ], "enum": [ "RESERVATION_DATA_LEVEL_UNSPECIFIED", "RESERVATION_DATA_LEVEL_AGGREGATED", "RESERVATION_DATA_LEVEL_PER_RESERVATION" ] }, "includeUnapprovedReservations": { "description": "Optional. Whether to include pending for approval reservations in the response. This field is only applicable for future reservations.", "location": "query", "type": "boolean" }, "aggregationMethod": { "description": "Optional. Aggregation Method of the historical reservation usage", "location": "query", "type": "string", "enumDescriptions": [ "No aggregation method is specified.", "", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the 50th(median) percentile of the sampled values.", "Time series values represent the 75th percentile of the sampled values.", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the max of the sampled values." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "MEDIAN", "PEAK", "P50", "P75", "P99", "P100" ] }, "startDate.year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "location": "query", "type": "integer", "format": "int32" }, "startDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "location": "query", "type": "integer", "format": "int32" }, "startDate.day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "location": "query", "type": "integer", "format": "int32" }, "endDate.year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "location": "query", "type": "integer", "format": "int32" }, "endDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "location": "query", "type": "integer", "format": "int32" }, "endDate.day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudCapacityplannerV1betaQueryReservationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Returns a list of the reservations that are in the parent parameter and match your specified filters." } } }, "reservationsUsage": { "methods": { "export": { "id": "capacityplanner.organizations.locations.reservationsUsage.export", "path": "v1beta/{+parent}/reservationsUsage:export", "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/reservationsUsage:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location of the reservationsusage. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaExportReservationsUsageRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Exports reservations usage data requested by user into either an existing Cloud Storage bucket or a new/existing BigQuery table." } } } } } } }, "folders": { "resources": { "locations": { "resources": { "usageHistories": { "methods": { "query": { "id": "capacityplanner.folders.locations.usageHistories.query", "path": "v1beta/{+parent}/usageHistories:query", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/usageHistories:query", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaQueryUsageHistoriesRequest" }, "response": { "$ref": "GoogleCloudCapacityplannerV1betaQueryUsageHistoriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Returns a list of the usage histories that are in the parent parameter and match your specified filters." }, "export": { "id": "capacityplanner.folders.locations.usageHistories.export", "path": "v1beta/{+parent}/usageHistories:export", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/usageHistories:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaExportUsageHistoriesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Exports historical usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table." } } }, "forecasts": { "methods": { "query": { "id": "capacityplanner.folders.locations.forecasts.query", "path": "v1beta/{+parent}/forecasts:query", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/forecasts:query", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaQueryForecastsRequest" }, "response": { "$ref": "GoogleCloudCapacityplannerV1betaQueryForecastsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Returns a list of the forecasts that are in the parent parameter and match your specified filters." }, "export": { "id": "capacityplanner.folders.locations.forecasts.export", "path": "v1beta/{+parent}/forecasts:export", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/forecasts:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaExportForecastsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Exports forecasted usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table." } } }, "reservations": { "methods": { "query": { "id": "capacityplanner.folders.locations.reservations.query", "path": "v1beta/{+parent}/reservations:query", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/reservations:query", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "locationLevel": { "description": "Optional. The location level of the reservations usage timeseries.", "location": "query", "type": "string", "enumDescriptions": [ "No location type was specified.", "Time series values represent usage aggregated at the region level.", "Time series values represent usage aggregated at the zone level." ], "enum": [ "LOCATION_TYPE_UNSPECIFIED", "REGIONAL", "ZONAL" ] }, "machineFamily": { "description": "Optional. The machine family to use to select the aggregate reserved values to return. Possible values include \"n1\", and \"n2d\" etc. Empty machine_family will return results matching all machine families.", "location": "query", "type": "string" }, "machineShape.machineFamily": { "description": "Optional. The VM family.", "location": "query", "type": "string" }, "machineShape.machineType": { "description": "Optional. The characteristics of the sampled VM expressed as a string.", "location": "query", "type": "string" }, "machineShape.machineShape": { "description": "Optional. The customer visible string representing the type of VM.", "location": "query", "type": "string" }, "machineShape.cpuCores": { "description": "Optional. Number of CPU cores per VM.", "location": "query", "type": "number", "format": "double" }, "machineShape.gpuType": { "description": "Optional. The type of GPU with the VM.", "location": "query", "type": "string" }, "machineShape.gpuComputeType": { "description": "Optional. The GPU name recognized by Compute Engine APIs.", "location": "query", "type": "string" }, "machineShape.gpuCores": { "description": "Optional. The number of GPU cores per VM.", "location": "query", "type": "string", "format": "int64" }, "machineShape.localSsdPartitions": { "description": "Optional. The number of local SSD partitions per VM.", "location": "query", "type": "string", "format": "int64" }, "machineShape.localSsdGb": { "description": "Optional. Total amount of local SSD storage.", "location": "query", "type": "number", "format": "double" }, "machineShape.memoryGb": { "description": "Optional. Total amount of memory with the VM.", "location": "query", "type": "number", "format": "double" }, "machineShape.localSsdInterface": { "description": "Optional. The local SSD interface used such as nvme or scsi", "location": "query", "type": "string" }, "machineShape.minCpuPlatform": { "description": "Optional. The Min-cpu platform used such as icelake", "location": "query", "type": "string" }, "gpuType": { "description": "Optional. The GPU type for the reserved values to return. Sample values are \"nvidia-tesla-t4\", and \"nvidia-tesla-a100\". See https://cloud.google.com/compute/docs/gpus for a list. Empty gpu_type will return results matching all GPUs.", "location": "query", "type": "string" }, "cloudResourceType": { "description": "Required. The resource for the reserved values to return. Possible values include \"gce-vcpus\", \"gce-ram\", \"gce-local-ssd\", \"gce-gpu\" and \"gce-vm\".", "location": "query", "type": "string" }, "reservationType": { "description": "Required. The Reservation type for example, future reservation request and allocation. If unspecified, all types are included.", "location": "query", "type": "string", "enumDescriptions": [ "No reservation type specified.", "Allocation refers to realized reservation either auto created or created by the users on demand.", "Future Reservation requests created by users.", "All reservations." ], "enum": [ "RESERVATION_TYPE_UNSPECIFIED", "RESERVATION_TYPE_ALLOCATION", "RESERVATION_TYPE_FUTURE_RESERVATION", "RESERVATION_TYPE_ALL" ] }, "shareType": { "description": "Optional. Types of share settings to filter reservations in response. If unspecified, all types are included.", "location": "query", "type": "string", "enumDescriptions": [ "No share type specified.", "Default value, for which reservation is open to only owner project.", "Shared-reservation is open to specific projects." ], "enum": [ "SHARE_TYPE_UNSPECIFIED", "SHARE_TYPE_LOCAL", "SHARE_TYPE_SPECIFIC_PROJECTS" ] }, "ownershipType": { "description": "Optional. Types of ownerships to filter reservations based on. In case of OWNED, it filters reservations which are owned by selected parent project/folder/organization. If unspecified, all types are included.", "location": "query", "type": "string", "enumDescriptions": [ "No ownership status specified.", "For the reservations owned within selected Google Cloud Platform Resource Container (project/folder/organization).", "For the reservations consumable within selected Google Cloud Platform Resource Container (project/folder/organization), but not owned by them." ], "enum": [ "OWNERSHIP_TYPE_UNSPECIFIED", "OWNERSHIP_TYPE_OWNED", "OWNERSHIP_TYPE_SHARED_BY_OTHERS" ] }, "reservationDataLevel": { "description": "Required. Reservations output data format.", "location": "query", "type": "string", "enumDescriptions": [ "No reservation data level specified.", "aggregated reservations data in a timeseries or aggregation over timeseries.", "per reservation detail which is equivalent of Arcus Future Reservation or Allocation with only limited fields which are useful for Capacity Planning." ], "enum": [ "RESERVATION_DATA_LEVEL_UNSPECIFIED", "RESERVATION_DATA_LEVEL_AGGREGATED", "RESERVATION_DATA_LEVEL_PER_RESERVATION" ] }, "includeUnapprovedReservations": { "description": "Optional. Whether to include pending for approval reservations in the response. This field is only applicable for future reservations.", "location": "query", "type": "boolean" }, "aggregationMethod": { "description": "Optional. Aggregation Method of the historical reservation usage", "location": "query", "type": "string", "enumDescriptions": [ "No aggregation method is specified.", "", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the 50th(median) percentile of the sampled values.", "Time series values represent the 75th percentile of the sampled values.", "Time series values represent the 99th percentile of the sampled values.", "Time series values represent the max of the sampled values." ], "enum": [ "AGGREGATION_METHOD_UNSPECIFIED", "MEDIAN", "PEAK", "P50", "P75", "P99", "P100" ] }, "startDate.year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "location": "query", "type": "integer", "format": "int32" }, "startDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "location": "query", "type": "integer", "format": "int32" }, "startDate.day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "location": "query", "type": "integer", "format": "int32" }, "endDate.year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "location": "query", "type": "integer", "format": "int32" }, "endDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "location": "query", "type": "integer", "format": "int32" }, "endDate.day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudCapacityplannerV1betaQueryReservationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Returns a list of the reservations that are in the parent parameter and match your specified filters." } } }, "reservationsUsage": { "methods": { "export": { "id": "capacityplanner.folders.locations.reservationsUsage.export", "path": "v1beta/{+parent}/reservationsUsage:export", "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/reservationsUsage:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The compute engine resource and location of the reservationsusage. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudCapacityplannerV1betaExportReservationsUsageRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ], "description": "Exports reservations usage data requested by user into either an existing Cloud Storage bucket or a new/existing BigQuery table." } } } } } } } }, "protocol": "rest", "canonicalName": "Capacity Planner", "documentationLink": "https://cloud.google.com/capacity-planner/docs" }