Compute Engine API (compute:alpha)

2022-02-02

8 new methods

Additions

    Methods
  • compute.regionNetworks.insert

      Parameter Order :

    • project
    • region
    • Description : Creates a network in the specified project and region using the data included in the request.

      Flat Path : projects/{project}/regions/{region}/networks

      Parameters :

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

          Description : Project ID for this request.

          Required : Yes

          Type : string

          Location : path

        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

        region

          Description : Name of the region scoping this request.

          Required : Yes

          Type : string

          Location : path

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

      Path : projects/{project}/regions/{region}/networks

      Scopes :

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

  • compute.regionNetworks.getIamPolicy

      Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.

      Parameter Order :

    • project
    • region
    • resource
    • Parameters :

        project

          Type : string

          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

          Location : path

        resource

          Description : Name or id of the resource for this request.

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

          Location : path

          Type : string

          Required : Yes

        region

          Location : path

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

          Required : Yes

          Description : The name of the region for this request.

          Type : string

        optionsRequestedPolicyVersion

          Location : query

          Description : Requested IAM Policy version.

          Type : integer

          Format : int32

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Path : projects/{project}/regions/{region}/networks/{resource}/getIamPolicy

      Flat Path : projects/{project}/regions/{region}/networks/{resource}/getIamPolicy

  • compute.regionNetworks.testIamPermissions

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Returns permissions that a caller has on the specified resource.

      Flat Path : projects/{project}/regions/{region}/networks/{resource}/testIamPermissions

      Path : projects/{project}/regions/{region}/networks/{resource}/testIamPermissions

      Parameter Order :

    • project
    • region
    • resource
    • HTTP Method : POST

      Parameters :

        region

          Type : string

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

          Required : Yes

          Location : path

          Description : The name of the region for this request.

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

          Location : path

          Required : Yes

          Description : Project ID for this request.

        resource

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

          Type : string

          Description : Name or id of the resource for this request.

          Required : Yes

          Location : path

  • compute.regionNetworks.delete

      Path : projects/{project}/regions/{region}/networks/{network}

      Description : Deletes the specified network.

      Scopes :

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

    • project
    • region
    • network
    • Parameters :

        project

          Required : Yes

          Type : string

          Description : Project ID for this request.

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

        region

          Location : path

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

          Required : Yes

          Type : string

          Description : Name of the region scoping this request.

        requestId

          Type : string

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

        network

          Type : string

          Required : Yes

          Description : Name of the network to delete.

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

          Location : path

      Flat Path : projects/{project}/regions/{region}/networks/{network}

      HTTP Method : DELETE

  • compute.regionNetworks.list

      Path : projects/{project}/regions/{region}/networks

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Retrieves the list of networks available to the specified project in the given region.

      Parameters :

        pageToken

          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.

          Location : query

          Type : string

        filter

          Description : A filter expression that filters resources listed in the response. The 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) ```

          Type : string

          Location : query

        region

          Description : Name of the region scoping this request.

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

          Type : string

          Required : Yes

          Location : path

        maxResults

          Minimum : 0

          Location : query

          Type : integer

          Default : 500

          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

        returnPartialSuccess

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

          Location : query

          Type : boolean

        project

          Description : Project ID for this request.

          Type : string

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

          Required : Yes

        orderBy

          Type : string

          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

      Parameter Order :

    • project
    • region
    • Flat Path : projects/{project}/regions/{region}/networks

      HTTP Method : GET

  • compute.regionNetworks.get

      Parameters :

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

          Description : Project ID for this request.

          Required : Yes

        region

          Description : Name of the region scoping this request.

          Location : path

          Type : string

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

          Required : Yes

        network

          Required : Yes

          Location : path

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

          Type : string

          Description : Name of the network to return.

      Description : Returns the specified network.

      Flat Path : projects/{project}/regions/{region}/networks/{network}

      HTTP Method : GET

      Parameter Order :

    • project
    • region
    • network
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Path : projects/{project}/regions/{region}/networks/{network}

  • compute.regionNetworks.setIamPolicy

      Flat Path : projects/{project}/regions/{region}/networks/{resource}/setIamPolicy

      Path : projects/{project}/regions/{region}/networks/{resource}/setIamPolicy

      Scopes :

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

      Parameter Order :

    • project
    • region
    • resource
    • Parameters :

        resource

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

          Type : string

          Location : path

          Description : Name or id of the resource for this request.

          Required : Yes

        region

          Location : path

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

          Type : string

          Description : The name of the region for this request.

          Required : Yes

        project

          Location : path

          Description : Project ID for this request.

          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 : Sets the access control policy on the specified resource. Replaces any existing policy.

  • compute.regionTargetHttpsProxies.patch

      Scopes :

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

        region

          Required : Yes

          Type : string

          Description : Name of the region for this request.

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

          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

          Description : Project ID for this request.

          Type : string

          Location : path

        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

        targetHttpsProxy

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

          Required : Yes

          Location : path

          Description : Name of the TargetHttpsProxy resource to patch.

          Type : string

      HTTP Method : PATCH

      Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}

      Parameter Order :

    • project
    • region
    • targetHttpsProxy
    • Description : Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

      Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}