Compute Engine API (compute:alpha)

2022-07-16

5 new methods

Additions

    Methods
  • compute.zoneQueuedResources.insert

      Path : projects/{project}/zones/{zone}/queuedResources

      HTTP Method : POST

      Flat Path : projects/{project}/zones/{zone}/queuedResources

      Description : Creates a QueuedResource.

      Parameter Order :

    • project
    • zone
    • Parameters :

        zone

          Required : Yes

          Location : path

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Description : Name of the zone for this request.

          Type : string

        project

          Required : Yes

          Location : path

          Description : Project ID for this request.

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

          Type : string

        requestId

          Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
  • compute.zoneQueuedResources.delete

      Parameters :

        requestId

          Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

        project

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

          Location : path

          Description : Project ID for this request.

          Type : string

          Required : Yes

        queuedResource

          Type : string

          Description : Name of the QueuedResource to delete.

          Required : Yes

          Location : path

        zone

          Description : Name of the zone for this request.

          Location : path

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Required : Yes

          Type : string

      HTTP Method : DELETE

      Description : Deletes a QueuedResource. For a QueuedResource in ACCEPTED state, call cancel on the resource before deleting, to make sure no VMs have been provisioned and may require cleaning up. For a QueuedResource in PROVISIONING state the request to delete is registered for execution following the provisioning.

      Path : projects/{project}/zones/{zone}/queuedResources/{queuedResource}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Parameter Order :

    • project
    • zone
    • queuedResource
    • Flat Path : projects/{project}/zones/{zone}/queuedResources/{queuedResource}

  • compute.zoneQueuedResources.cancel

      Description : Cancels a QueuedResource. Only a resource in ACCEPTED state may be cancelled.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • HTTP Method : POST

      Path : projects/{project}/zones/{zone}/queuedResources/{queuedResource}/cancel

      Parameter Order :

    • project
    • zone
    • queuedResource
    • Flat Path : projects/{project}/zones/{zone}/queuedResources/{queuedResource}/cancel

      Parameters :

        queuedResource

          Type : string

          Location : path

          Description : Name of the QueuedResource to cancel.

          Required : Yes

        requestId

          Location : query

          Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

          Type : string

        zone

          Required : Yes

          Description : Name of the zone for this request.

          Location : path

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Type : string

        project

          Type : string

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

          Description : Project ID for this request.

          Required : Yes

          Location : path

  • compute.zoneQueuedResources.get

      Parameter Order :

    • project
    • zone
    • queuedResource
    • Path : projects/{project}/zones/{zone}/queuedResources/{queuedResource}

      Description : Returns the specified QueuedResource resource.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • HTTP Method : GET

      Parameters :

        queuedResource

          Location : path

          Description : Name of the QueuedResource resource to return.

          Type : string

          Required : Yes

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

        project

          Description : Project ID for this request.

          Required : Yes

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

          Type : string

          Location : path

        zone

          Type : string

          Required : Yes

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Location : path

          Description : Name of the zone for this request.

      Flat Path : projects/{project}/zones/{zone}/queuedResources/{queuedResource}

  • compute.zoneQueuedResources.list

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Flat Path : projects/{project}/zones/{zone}/queuedResources

      Parameter Order :

    • project
    • zone
    • Description : Retrieves the list of QueuedResource resources.

      HTTP Method : GET

      Parameters :

        pageToken

          Location : query

          Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

          Type : string

        orderBy

          Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

          Location : query

          Type : string

        maxResults

          Minimum : 0

          Format : uint32

          Type : integer

          Default : 500

          Location : query

          Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

        filter

          Type : string

          Location : query

          Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.

        returnPartialSuccess

          Type : boolean

          Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

          Location : query

        zone

          Type : string

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Description : Name of the zone for this request.

          Required : Yes

          Location : path

        project

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

          Required : Yes

          Location : path

          Description : Project ID for this request.

          Type : string

      Path : projects/{project}/zones/{zone}/queuedResources