Compute Engine API (compute:alpha)

2022-06-16

4 removed methods

Deletions

    Methods
  • compute.instanceGroupManagerResizeRequests.insert

      Parameters:

        project

          Description: Project ID for this request.

          Required: Yes

          Location: path

          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).

          Type: string

          Location: query

        instanceGroupManager

          Required: Yes

          Description: The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID.

          Type: string

          Location: path

        zone

          Required: Yes

          Type: string

          Location: path

          Description: The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035.

      Parameter Order:

    • project
    • zone
    • instanceGroupManager
    • HTTP Method: POST

      Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests

      Description: Creates a new resize request that starts provisioning VMs immediately or queues VM creation.

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests

  • compute.instanceGroupManagerResizeRequests.get

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Parameters:

        resizeRequest

          Type: string

          Required: Yes

          Location: path

          Description: The name of the resize request. Name should conform to RFC1035 or be a resource ID.

        project

          Location: path

          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.

          Type: string

          Required: Yes

        instanceGroupManager

          Description: The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.

          Type: string

          Required: Yes

          Location: path

        zone

          Required: Yes

          Location: path

          Type: string

          Description: The name of the zone where the managed instance group and the resize request are located. Name should conform to RFC1035.

      HTTP Method: GET

      Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}

      Description: Returns all of the details about the specified resize request.

      Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}

      Parameter Order:

    • project
    • zone
    • instanceGroupManager
    • resizeRequest
  • compute.instanceGroupManagerResizeRequests.list

      Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Parameters:

        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

        zone

          Type: string

          Description: The name of the zone where the managed instance group is located. The name should conform to RFC1035.

          Location: path

          Required: Yes

        instanceGroupManager

          Type: string

          Required: Yes

          Location: path

          Description: The name of the managed instance group. The name should conform to RFC1035.

        pageToken

          Type: string

          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.

        filter

          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`.

          Location: query

          Type: string

        maxResults

          Default: 500

          Minimum: 0

          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`)

          Format: uint32

          Type: integer

          Location: query

        project

          Location: path

          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])?))

          Required: Yes

          Description: Project ID for this request.

        returnPartialSuccess

          Location: query

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

          Type: boolean

      Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests

      Parameter Order:

    • project
    • zone
    • instanceGroupManager
    • Description: Retrieves a list of resize requests that are contained in the managed instance group.

      HTTP Method: GET

  • compute.instanceGroupManagerResizeRequests.delete

      Parameter Order:

    • project
    • zone
    • instanceGroupManager
    • resizeRequest
    • Description: Deletes the specified resize request.

      HTTP Method: DELETE

      Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}

      Parameters:

        project

          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])?))

          Required: Yes

          Type: string

          Location: path

        resizeRequest

          Location: path

          Required: Yes

          Description: The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.

          Type: string

        requestId

          Type: string

          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

        instanceGroupManager

          Description: The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.

          Type: string

          Location: path

          Required: Yes

        zone

          Location: path

          Type: string

          Required: Yes

          Description: The name of the zone where the managed instance group is located. The name should conform to RFC1035.

      Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
4 new methods

Additions

    Methods
  • compute.instanceGroupManagerResizeRequests.insert

      Parameters:

        project

          Description: Project ID for this request.

          Required: Yes

          Location: path

          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).

          Type: string

          Location: query

        instanceGroupManager

          Required: Yes

          Description: The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID.

          Type: string

          Location: path

        zone

          Required: Yes

          Type: string

          Location: path

          Description: The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035.

      Parameter Order:

    • project
    • zone
    • instanceGroupManager
    • HTTP Method: POST

      Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests

      Description: Creates a new resize request that starts provisioning VMs immediately or queues VM creation.

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests

  • compute.instanceGroupManagerResizeRequests.get

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Parameters:

        resizeRequest

          Type: string

          Required: Yes

          Location: path

          Description: The name of the resize request. Name should conform to RFC1035 or be a resource ID.

        project

          Location: path

          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.

          Type: string

          Required: Yes

        instanceGroupManager

          Description: The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.

          Type: string

          Required: Yes

          Location: path

        zone

          Required: Yes

          Location: path

          Type: string

          Description: The name of the zone where the managed instance group and the resize request are located. Name should conform to RFC1035.

      HTTP Method: GET

      Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}

      Description: Returns all of the details about the specified resize request.

      Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}

      Parameter Order:

    • project
    • zone
    • instanceGroupManager
    • resizeRequest
  • compute.instanceGroupManagerResizeRequests.list

      Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Parameters:

        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

        zone

          Type: string

          Description: The name of the zone where the managed instance group is located. The name should conform to RFC1035.

          Location: path

          Required: Yes

        instanceGroupManager

          Type: string

          Required: Yes

          Location: path

          Description: The name of the managed instance group. The name should conform to RFC1035.

        pageToken

          Type: string

          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.

        filter

          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`.

          Location: query

          Type: string

        maxResults

          Default: 500

          Minimum: 0

          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`)

          Format: uint32

          Type: integer

          Location: query

        project

          Location: path

          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])?))

          Required: Yes

          Description: Project ID for this request.

        returnPartialSuccess

          Location: query

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

          Type: boolean

      Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests

      Parameter Order:

    • project
    • zone
    • instanceGroupManager
    • Description: Retrieves a list of resize requests that are contained in the managed instance group.

      HTTP Method: GET

  • compute.instanceGroupManagerResizeRequests.delete

      Parameter Order:

    • project
    • zone
    • instanceGroupManager
    • resizeRequest
    • Description: Deletes the specified resize request.

      HTTP Method: DELETE

      Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}

      Parameters:

        project

          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])?))

          Required: Yes

          Type: string

          Location: path

        resizeRequest

          Location: path

          Required: Yes

          Description: The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.

          Type: string

        requestId

          Type: string

          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

        instanceGroupManager

          Description: The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.

          Type: string

          Location: path

          Required: Yes

        zone

          Location: path

          Type: string

          Required: Yes

          Description: The name of the zone where the managed instance group is located. The name should conform to RFC1035.

      Flat Path: projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}

      Scopes:

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