Compute Engine API (compute:beta)

2022-04-26

5 new methods

Additions

    Methods
  • compute.regionTargetTcpProxies.list

      Parameters :

        orderBy

          Location : query

          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.

        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

        returnPartialSuccess

          Type : boolean

          Location : query

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

        region

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

          Required : Yes

          Location : path

          Type : string

          Description : Name of the region scoping this request.

        filter

          Location : query

          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

        maxResults

          Type : integer

          Minimum : 0

          Default : 500

          Location : query

          Format : uint32

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

        project

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

          Type : string

          Required : Yes

      Description : Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.

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

      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}/targetTcpProxies

      Parameter Order :

    • project
    • region
  • compute.regionTargetTcpProxies.get

      Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}

      Parameters :

        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

          Description : Project ID for this request.

          Required : Yes

        targetTcpProxy

          Location : path

          Description : Name of the TargetTcpProxy resource to return.

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

          Required : Yes

          Type : string

        region

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

          Description : Name of the region scoping this request.

          Type : string

          Required : Yes

          Location : path

      Description : Returns the specified TargetTcpProxy resource.

      HTTP Method : GET

      Parameter Order :

    • project
    • region
    • targetTcpProxy
    • Flat Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}

      Scopes :

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

      Parameters :

        region

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

          Description : The name of the region for this request.

          Required : Yes

          Location : path

          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

        resource

          Required : Yes

          Type : string

          Location : path

          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}

      Description : Returns permissions that a caller has on the specified resource.

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

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

      HTTP Method : POST

      Parameter Order :

    • project
    • region
    • resource
    • Scopes :

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

      Parameter Order :

    • project
    • region
    • targetTcpProxy
    • HTTP Method : DELETE

      Parameters :

        targetTcpProxy

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

          Required : Yes

          Description : Name of the TargetTcpProxy resource to delete.

          Location : path

          Type : string

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

          Required : Yes

          Type : string

          Description : Project ID for this request.

        region

          Required : Yes

          Type : string

          Location : path

          Description : Name of the region scoping this request.

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

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

      Description : Deletes the specified TargetTcpProxy resource.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Flat Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}

      Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}

  • compute.regionTargetTcpProxies.insert

      Parameter Order :

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

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

      HTTP Method : POST

      Scopes :

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

        region

          Location : path

          Required : Yes

          Type : string

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

          Description : Name of the region scoping this request.

        project

          Location : path

          Description : Project ID for this request.

          Required : Yes

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

        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

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