Compute Engine API (compute:beta)

2022-04-18

5 new methods

Additions

    Methods
  • compute.regionTargetTcpProxies.delete

      HTTP Method: DELETE

      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

        targetTcpProxy

          Location: path

          Required: Yes

          Description: Name of the TargetTcpProxy resource to delete.

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

          Type: string

        region

          Location: path

          Type: string

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

          Required: Yes

          Description: Name of the region scoping this request.

        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

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

      Parameter Order:

    • project
    • region
    • targetTcpProxy
    • Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description: Deletes the specified TargetTcpProxy resource.

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

  • compute.regionTargetTcpProxies.insert

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

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

          Type: string

          Location: query

        region

          Type: string

          Description: Name of the region scoping this request.

          Location: path

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

          Required: Yes

        project

          Description: Project ID for this request.

          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

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

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

      HTTP Method: POST

      Scopes:

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

    • project
    • region
  • compute.regionTargetTcpProxies.list

      HTTP Method: GET

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

      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}/regions/{region}/targetTcpProxies

      Parameter Order:

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

      Parameters:

        maxResults

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

          Default: 500

          Type: integer

          Format: uint32

          Minimum: 0

        returnPartialSuccess

          Location: query

          Type: boolean

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

        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

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

          Location: query

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

          Description: Project ID for this request.

          Type: string

          Required: Yes

        region

          Type: string

          Required: Yes

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

          Location: path

          Description: Name of the region scoping this request.

        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.

  • compute.regionTargetTcpProxies.testIamPermissions

      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}/regions/{region}/targetTcpProxies/{resource}/testIamPermissions

      Parameters:

        region

          Type: string

          Required: Yes

          Location: path

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

          Description: The name of the region for this request.

        resource

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

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

          Type: string

          Required: Yes

          Location: path

        project

          Location: path

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

          Description: Project ID for this request.

          Type: string

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

      Parameter Order:

    • project
    • region
    • resource
    • HTTP Method: POST

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

  • compute.regionTargetTcpProxies.get

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

      Parameter Order:

    • project
    • region
    • targetTcpProxy
    • Description: Returns the specified TargetTcpProxy resource.

      HTTP Method: GET

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

          Description: Project ID for this request.

          Location: path

          Required: Yes

        targetTcpProxy

          Location: path

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

          Type: string

          Required: Yes

          Description: Name of the TargetTcpProxy resource to return.

        region

          Description: Name of the region scoping this request.

          Type: string

          Required: Yes

          Location: path

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