/

Console

• English
• Deutsch
• Español – América Latina
• Français
• Português – Brasil
• 中文 – 简体
• 日本語
• 한국어

Sign in

• Compute Engine

Start free

Method: advice.calendarMode

{
  "futureResourcesSpecs": {
    string: {
      "locationPolicy": {
        "locations": {
          string: {
            "preference": enum
          },
          ...
        }
      },
      "timeRangeSpec": {
        "startTimeNotEarlierThan": string,
        "startTimeNotLaterThan": string,
        "endTimeNotEarlierThan": string,
        "endTimeNotLaterThan": string,
        "minDuration": string,
        "maxDuration": string
      },
      "targetResources": {

        // Union field specification_type can be only one of the following:
        "specificSkuResources": {
          "machineType": string,
          "localSsdPartitions": [
            {
              "diskInterface": enum,
              "diskSizeGb": string
            }
          ],
          "instanceCount": string
        },
        "aggregateResources": {
          "vmFamily": enum,
          "workloadType": enum,
          "acceleratorCount": string
        }
        // End of list of possible types for union field specification_type.
      },
      "deploymentType": enum
    },
    ...
  }
}

map (key: string, value: object)

Specification of resources to create in the future. The key of the map is an arbitrary string specified by the caller. Value of the map is a specification of required resources and their constraints. Currently only one value is allowed in this map.

object

Optional location policy allowing to exclude some zone(s) in which the resources must not be created.

map (key: string, value: object)

enum

Preference for this location.

object

Specification of a time range in which the resources may be created. The time range specifies start of resource use and planned end of resource use.

string (Timestamp format)

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

string (Timestamp format)

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

string (Timestamp format)

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

string (Timestamp format)

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

string (Duration format)

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

string (Duration format)

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

object

Specification of the reserved resources.

object

string

The machine type to use for instances that will use the reservation. This field only accepts machine type names. e.g. n2-standard-4 and does not accept machine type full or partial url. e.g. projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4. Use for GPU reservations.

object

Local SSD partitions. You do not have to include SSD partitions that are built in the machine type.

enum

Disk interface. Defaults to SCSI.

string (int64 format)

The size of the disk in GB.

string (int64 format)

Size of the request, in instance count.

object

enum

The VM family that all instances scheduled against this reservation must belong to. Use for TPU reservations.

enum

Workload type. Use for TPU reservations.

string (int64 format)

Size of the request, in accelerator (chip) count.

enum

Indicates if the reservation allocation strategy is static (DENSE) or dynamic (STANDARD). Defaults to DENSE.

Response body

{
  "recommendations": [
    {
      "recommendationsPerSpec": {
        string: {
          "recommendationId": string,
          "recommendationType": enum,
          "startTime": string,
          "endTime": string,
          "location": string,
          "otherLocations": {
            string: {
              "status": enum,
              "details": string
            },
            ...
          }
        },
        ...
      }
    }
  ]
}

object

Recommendations where, how and when to create the requested resources in order to maximize their obtainability and minimize cost.

map (key: string, value: object)

Recommendations for every future resource specification passed in CalendarModeAdviceRequest. Keys of the map correspond to keys specified in the request.

string

Unique id of the recommendation, a UUID string generated by the API.

enum

Type of recommendation. Currently only FUTURE_RESERVATION is supported.

string (Timestamp format)

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

string (Timestamp format)

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

string

map (key: string, value: object)

enum

Status of recommendation in this location.

string

Details (human readable) describing the situation. For example, if status is CONDITION_NOT_MET, then details contain information about the parameters of the time window that did not meet the required conditions.