Compute Engine API (compute:alpha)

2022-02-28

1 new method | 1 updated method | 11 removed methods

Additions

    Methods

  • ▼ ▲ compute.regionSslPolicies.getIamPolicy

      Scopes:

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

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

      Parameters:

        optionsRequestedPolicyVersion

          Description: Requested IAM Policy version.

          Location: query

          Format: int32

          Type: integer

        region

          Required: Yes

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

          Location: path

          Description: The name of the region for this request.

          Type: string

        resource

          Type: string

          Location: path

          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.

          Required: Yes

        project

          Type: string

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

      Path: projects/{project}/regions/{region}/sslPolicies/{resource}/getIamPolicy

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

      HTTP Method: GET

      Parameter Order:

    • project
    • region
    • resource

Updates

    Methods

  • ▼ ▲ compute.instances.simulateMaintenanceEvent

      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

Deletions

    Methods

  • ▼ ▲ compute.regionTargetTcpProxies.delete

      Scopes:

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

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

      Description: Deletes the specified TargetTcpProxy resource.

      HTTP Method: DELETE

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

      Parameters:

        project

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

          Location: path

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

        region

          Location: path

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

          Description: Name of the region scoping this request.

          Type: string

          Required: Yes

        targetTcpProxy

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

          Type: string

          Description: Name of the TargetTcpProxy resource to delete.

          Required: Yes

          Location: path

      Parameter Order:

    • project
    • region
    • targetTcpProxy

  • ▼ ▲ compute.regionTargetTcpProxies.get

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

      HTTP Method: GET

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

      Description: Returns the specified TargetTcpProxy resource.

      Parameter Order:

    • project
    • region
    • targetTcpProxy

      • Parameters:

        region

          Location: path

          Description: Name of the region scoping this request.

          Required: Yes

          Type: string

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

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

          Type: string

          Description: Project ID for this request.

          Required: Yes

        targetTcpProxy

          Type: string

          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

      Scopes:

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

  • ▼ ▲ compute.regionTargetTcpProxies.list

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

      Parameter Order:

    • project
    • region

      • 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:

        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

        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

          Required: Yes

          Type: string

          Description: Project ID for this request.

        region

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

          Type: string

          Description: Name of the region scoping this request.

          Location: path

          Required: Yes

        filter

          Type: string

          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

        pageToken

          Type: string

          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

        maxResults

          Default: 500

          Type: integer

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

          Format: uint32

          Minimum: 0

        returnPartialSuccess

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

          Type: boolean

          Location: query

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

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

  • ▼ ▲ compute.regionTargetTcpProxies.insert

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

      Parameters:

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

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

          Location: path

          Required: Yes

        region

          Location: path

          Type: string

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

          Description: Name of the region scoping this request.

          Required: Yes

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

      Scopes:

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

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

      HTTP Method: POST

      Parameter Order:

    • project
    • region

  • ▼ ▲ compute.regionTargetTcpProxies.testIamPermissions

      Path: projects/{project}/regions/{region}/targetTcpProxies/{resource}/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.

      HTTP Method: POST

      Parameters:

        region

          Type: string

          Required: Yes

          Location: path

          Description: The name of the region for this request.

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

        resource

          Location: path

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

          Required: Yes

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

          Type: string

        project

          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

          Description: Project ID for this request.

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

      Parameter Order:

    • project
    • region
    • resource

  • ▼ ▲ compute.disks.startAsyncReplication

      Parameter Order:

    • project
    • zone
    • disk

      • Parameters:

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

        disk

          Description: The name of the persistent disk.

          Required: Yes

          Location: path

          Type: string

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

        project

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

          Required: Yes

        zone

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

          Required: Yes

          Type: string

          Description: The name of the zone for this request.

          Location: path

      Flat Path: projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication

      Scopes:

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

      • Path: projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication

      HTTP Method: POST

      Description: Starts asynchronous replication. Must be invoked on the primary disk.

  • ▼ ▲ compute.disks.stopGroupAsyncReplication

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

          Type: string

          Location: path

          Required: Yes

        zone

          Type: string

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

          Location: path

          Description: The name of the zone for this request. This must be the zone of the primary or secondary disks in the consistency group.

          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

      Scopes:

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

      • HTTP Method: POST

      Path: projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication

      Flat Path: projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication

      Parameter Order:

    • project
    • zone

      • Description: Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.

  • ▼ ▲ compute.disks.stopAsyncReplication

      Scopes:

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

      • Description: Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.

      HTTP Method: POST

      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

        project

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

          Location: path

        disk

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

          Required: Yes

          Type: string

          Description: The name of the persistent disk.

          Location: path

        zone

          Location: path

          Description: The name of the zone for this request.

          Required: Yes

          Type: string

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

      Path: projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication

      Parameter Order:

    • project
    • zone
    • disk

      • Flat Path: projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication

  • ▼ ▲ compute.regionDisks.stopAsyncReplication

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

          Type: string

          Location: path

          Description: Project ID for this request.

          Required: Yes

        disk

          Required: Yes

          Type: string

          Location: path

          Description: The name of the persistent disk.

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

        region

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

          Required: Yes

          Location: path

          Description: The name of the region for this request.

          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

      Description: Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.

      Path: projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication

      Flat Path: projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication

      HTTP Method: POST

      Parameter Order:

    • project
    • region
    • disk

      • Scopes:

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

  • ▼ ▲ compute.regionDisks.stopGroupAsyncReplication

      Description: Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.

      Scopes:

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

      • Parameter Order:

    • project
    • region

      • Parameters:

        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

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

          Required: Yes

          Type: string

          Location: path

          Description: The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group.

        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

      HTTP Method: POST

      Path: projects/{project}/regions/{region}/disks/stopGroupAsyncReplication

      Flat Path: projects/{project}/regions/{region}/disks/stopGroupAsyncReplication

  • ▼ ▲ compute.regionDisks.startAsyncReplication

      Parameter Order:

    • project
    • region
    • disk

      • Parameters:

        project

          Location: path

          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

        requestId

          Location: query

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

        region

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

          Location: path

          Description: The name of the region for this request.

          Required: Yes

          Type: string

        disk

          Required: Yes

          Type: string

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

          Location: path

          Description: The name of the persistent disk.

      Path: projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication

      Flat Path: projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication

      Scopes:

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

      • Description: Starts asynchronous replication. Must be invoked on the primary disk.

      HTTP Method: POST

11 new methods | 1 updated method | 1 removed method

Additions

    Methods

  • ▼ ▲ compute.regionTargetTcpProxies.delete

      Scopes:

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

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

      Description: Deletes the specified TargetTcpProxy resource.

      HTTP Method: DELETE

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

      Parameters:

        project

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

          Location: path

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

        region

          Location: path

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

          Description: Name of the region scoping this request.

          Type: string

          Required: Yes

        targetTcpProxy

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

          Type: string

          Description: Name of the TargetTcpProxy resource to delete.

          Required: Yes

          Location: path

      Parameter Order:

    • project
    • region
    • targetTcpProxy

  • ▼ ▲ compute.regionTargetTcpProxies.get

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

      HTTP Method: GET

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

      Description: Returns the specified TargetTcpProxy resource.

      Parameter Order:

    • project
    • region
    • targetTcpProxy

      • Parameters:

        region

          Location: path

          Description: Name of the region scoping this request.

          Required: Yes

          Type: string

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

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

          Type: string

          Description: Project ID for this request.

          Required: Yes

        targetTcpProxy

          Type: string

          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

      Scopes:

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

  • ▼ ▲ compute.regionTargetTcpProxies.list

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

      Parameter Order:

    • project
    • region

      • 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:

        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

        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

          Required: Yes

          Type: string

          Description: Project ID for this request.

        region

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

          Type: string

          Description: Name of the region scoping this request.

          Location: path

          Required: Yes

        filter

          Type: string

          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

        pageToken

          Type: string

          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

        maxResults

          Default: 500

          Type: integer

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

          Format: uint32

          Minimum: 0

        returnPartialSuccess

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

          Type: boolean

          Location: query

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

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

  • ▼ ▲ compute.regionTargetTcpProxies.insert

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

      Parameters:

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

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

          Location: path

          Required: Yes

        region

          Location: path

          Type: string

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

          Description: Name of the region scoping this request.

          Required: Yes

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

      Scopes:

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

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

      HTTP Method: POST

      Parameter Order:

    • project
    • region

  • ▼ ▲ compute.regionTargetTcpProxies.testIamPermissions

      Path: projects/{project}/regions/{region}/targetTcpProxies/{resource}/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.

      HTTP Method: POST

      Parameters:

        region

          Type: string

          Required: Yes

          Location: path

          Description: The name of the region for this request.

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

        resource

          Location: path

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

          Required: Yes

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

          Type: string

        project

          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

          Description: Project ID for this request.

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

      Parameter Order:

    • project
    • region
    • resource

  • ▼ ▲ compute.disks.startAsyncReplication

      Parameter Order:

    • project
    • zone
    • disk

      • Parameters:

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

        disk

          Description: The name of the persistent disk.

          Required: Yes

          Location: path

          Type: string

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

        project

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

          Required: Yes

        zone

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

          Required: Yes

          Type: string

          Description: The name of the zone for this request.

          Location: path

      Flat Path: projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication

      Scopes:

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

      • Path: projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication

      HTTP Method: POST

      Description: Starts asynchronous replication. Must be invoked on the primary disk.

  • ▼ ▲ compute.disks.stopGroupAsyncReplication

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

          Type: string

          Location: path

          Required: Yes

        zone

          Type: string

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

          Location: path

          Description: The name of the zone for this request. This must be the zone of the primary or secondary disks in the consistency group.

          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

      Scopes:

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

      • HTTP Method: POST

      Path: projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication

      Flat Path: projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication

      Parameter Order:

    • project
    • zone

      • Description: Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.

  • ▼ ▲ compute.disks.stopAsyncReplication

      Scopes:

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

      • Description: Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.

      HTTP Method: POST

      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

        project

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

          Location: path

        disk

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

          Required: Yes

          Type: string

          Description: The name of the persistent disk.

          Location: path

        zone

          Location: path

          Description: The name of the zone for this request.

          Required: Yes

          Type: string

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

      Path: projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication

      Parameter Order:

    • project
    • zone
    • disk

      • Flat Path: projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication

  • ▼ ▲ compute.regionDisks.stopAsyncReplication

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

          Type: string

          Location: path

          Description: Project ID for this request.

          Required: Yes

        disk

          Required: Yes

          Type: string

          Location: path

          Description: The name of the persistent disk.

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

        region

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

          Required: Yes

          Location: path

          Description: The name of the region for this request.

          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

      Description: Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.

      Path: projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication

      Flat Path: projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication

      HTTP Method: POST

      Parameter Order:

    • project
    • region
    • disk

      • Scopes:

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

  • ▼ ▲ compute.regionDisks.stopGroupAsyncReplication

      Description: Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.

      Scopes:

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

      • Parameter Order:

    • project
    • region

      • Parameters:

        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

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

          Required: Yes

          Type: string

          Location: path

          Description: The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group.

        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

      HTTP Method: POST

      Path: projects/{project}/regions/{region}/disks/stopGroupAsyncReplication

      Flat Path: projects/{project}/regions/{region}/disks/stopGroupAsyncReplication

  • ▼ ▲ compute.regionDisks.startAsyncReplication

      Parameter Order:

    • project
    • region
    • disk

      • Parameters:

        project

          Location: path

          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

        requestId

          Location: query

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

        region

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

          Location: path

          Description: The name of the region for this request.

          Required: Yes

          Type: string

        disk

          Required: Yes

          Type: string

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

          Location: path

          Description: The name of the persistent disk.

      Path: projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication

      Flat Path: projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication

      Scopes:

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

      • Description: Starts asynchronous replication. Must be invoked on the primary disk.

      HTTP Method: POST

Updates

    Methods

  • ▼ ▲ compute.instances.simulateMaintenanceEvent

      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

Deletions

    Methods

  • ▼ ▲ compute.regionSslPolicies.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:

        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}

          Type: string

          Location: path

          Required: Yes

        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

          Type: string

          Description: Project ID for this request.

        region

          Type: string

          Description: The name of the region for this request.

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

          Location: path

          Required: Yes

        optionsRequestedPolicyVersion

          Type: integer

          Location: query

          Format: int32

          Description: Requested IAM Policy version.

      Path: projects/{project}/regions/{region}/sslPolicies/{resource}/getIamPolicy

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

      Scopes:

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

      • HTTP Method: GET