Compute Engine API (compute:v1)

2022-12-05

8 new methods | 2 updated methods

Additions

    Methods
  • compute.networkAttachments.insert

      HTTP Method : POST

      Parameter Order :

    • project
    • region
    • Description : Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.

      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

          Location : path

          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). end_interface: MixerMutationRequestBuilder

          Location : query

        region

          Required : Yes

          Type : string

          Description : Name of the region of this request.

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

          Location : path

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

      Scopes :

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

  • compute.networkAttachments.aggregatedList

      Parameters :

        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

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

          Minimum : 0

          Type : integer

          Format : uint32

          Default : 500

        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.

          Location : path

          Required : Yes

          Type : string

        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

        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.

          Type : string

          Location : query

        filter

          Type : string

          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

        includeAllScopes

          Location : query

          Type : boolean

          Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

      Flat Path : projects/{project}/aggregated/networkAttachments

      Scopes :

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

      HTTP Method : GET

      Path : projects/{project}/aggregated/networkAttachments

      Description : Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.

  • compute.networkAttachments.delete

      Parameter Order :

    • project
    • region
    • networkAttachment
    • Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}

      Description : Deletes the specified NetworkAttachment in the given scope

      HTTP Method : DELETE

      Flat Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • 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])?))

          Required : Yes

          Description : Project ID for this request.

          Location : path

          Type : string

        region

          Description : Name of the region of this request.

          Location : path

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

          Type : string

          Required : Yes

        networkAttachment

          Required : Yes

          Type : string

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

          Description : Name of the NetworkAttachment resource to delete.

          Location : path

        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). end_interface: MixerMutationRequestBuilder

  • compute.networkAttachments.get

      Description : Returns the specified NetworkAttachment resource in the given scope.

      Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}

      Parameter Order :

    • project
    • region
    • networkAttachment
    • HTTP Method : GET

      Parameters :

        region

          Location : path

          Required : Yes

          Type : string

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

          Description : Name of the region of this request.

        networkAttachment

          Required : Yes

          Description : Name of the NetworkAttachment resource to return.

          Type : string

          Location : path

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

        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

      Flat Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}

      Scopes :

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

      Scopes :

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

    • project
    • region
    • resource
    • Path : projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy

      Parameters :

        project

          Description : Project ID for this request.

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

          Type : string

        region

          Type : string

          Location : path

          Description : The name of the region for this request.

          Required : Yes

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

        resource

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

          Location : path

          Type : string

          Required : Yes

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

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

      HTTP Method : POST

      Description : Sets the access control policy on the specified resource. Replaces any existing policy.

  • compute.networkAttachments.testIamPermissions

      Parameters :

        region

          Required : Yes

          Description : The name of the region for this request.

          Location : path

          Type : string

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

        resource

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

          Type : string

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

          Required : Yes

          Location : path

        project

          Required : Yes

          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

          Type : string

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

      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
    • HTTP Method : POST

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

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

  • compute.networkAttachments.getIamPolicy

      Parameter Order :

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

      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}/networkAttachments/{resource}/getIamPolicy

      HTTP Method : GET

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

      Parameters :

        region

          Description : The name of the region for this request.

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

          Location : path

          Type : string

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

          Description : Project ID for this request.

          Type : string

          Location : path

          Required : Yes

        optionsRequestedPolicyVersion

          Description : Requested IAM Policy version.

          Format : int32

          Type : integer

          Location : query

        resource

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

          Location : path

          Type : string

          Required : Yes

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

  • compute.networkAttachments.list

      HTTP Method : GET

      Parameter Order :

    • project
    • region
    • Parameters :

        orderBy

          Type : string

          Location : query

          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.

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

          Type : string

          Location : query

        maxResults

          Type : integer

          Minimum : 0

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

          Default : 500

        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

        region

          Description : Name of the region of this request.

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

          Type : string

          Required : Yes

          Location : path

        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

        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

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

      Description : Lists the NetworkAttachments for a project in the given scope.

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

      Scopes :

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

Updates

    Methods
  • compute.instances.suspend

      Parameters :

        discardLocalSsd

          Description : If true, discard the contents of any attached localSSD partitions. Default value is false.

          Type : boolean

          Location : query

  • compute.instances.stop

      Parameters :

        discardLocalSsd

          Location : query

          Description : If true, discard the contents of any attached localSSD partitions. Default value is false.

          Type : boolean

2 updated methods | 8 removed methods

Updates

    Methods
  • compute.instances.stop

      Parameters :

        discardLocalSsd

          Location : query

          Description : If true, discard the contents of any attached localSSD partitions. Default value is false.

          Type : boolean

  • compute.instances.suspend

      Parameters :

        discardLocalSsd

          Description : If true, discard the contents of any attached localSSD partitions. Default value is false.

          Location : query

          Type : boolean

Deletions

    Methods
  • compute.networkAttachments.insert

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

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

      Scopes :

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

    • project
    • region
    • Parameters :

        region

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

          Description : Name of the region of this request.

          Required : Yes

          Location : path

          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). end_interface: MixerMutationRequestBuilder

          Location : query

        project

          Description : Project ID for this request.

          Location : path

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

      Description : Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.

      HTTP Method : POST

  • compute.networkAttachments.getIamPolicy

      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}/networkAttachments/{resource}/getIamPolicy

      Parameter Order :

    • project
    • region
    • resource
    • HTTP Method : GET

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

      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

        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

          Required : Yes

          Description : Project ID for this request.

        region

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

          Required : Yes

          Type : string

          Description : The name of the region for this request.

          Location : path

        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

  • compute.networkAttachments.setIamPolicy

      Parameters :

        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

          Location : path

          Required : Yes

        region

          Type : string

          Description : The name of the region for this request.

          Location : path

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

          Required : Yes

        project

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

          Description : Project ID for this request.

          Type : string

      Scopes :

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

      HTTP Method : POST

      Description : Sets the access control policy on the specified resource. Replaces any existing policy.

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

      Parameter Order :

    • project
    • region
    • resource
  • compute.networkAttachments.list

      Description : Lists the NetworkAttachments for a project in the given scope.

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

      HTTP Method : GET

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

          Required : Yes

          Type : string

          Description : Project ID for this request.

        region

          Required : Yes

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

          Location : path

          Description : Name of the region of this request.

          Type : string

        orderBy

          Location : query

          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.

          Type : string

        filter

          Location : query

          Type : string

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

        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

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

          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

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

  • compute.networkAttachments.get

      HTTP Method : GET

      Parameter Order :

    • project
    • region
    • networkAttachment
    • Parameters :

        region

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

          Location : path

          Type : string

          Description : Name of the region of this request.

          Required : Yes

        project

          Description : Project ID for this request.

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

          Type : string

          Location : path

        networkAttachment

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

          Location : path

          Description : Name of the NetworkAttachment resource to return.

          Required : Yes

          Type : string

      Flat Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}

      Description : Returns the specified NetworkAttachment resource in the given scope.

      Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}

      Scopes :

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

      Scopes :

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

      Parameters :

        returnPartialSuccess

          Type : boolean

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

          Location : query

        includeAllScopes

          Location : query

          Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

          Type : boolean

        pageToken

          Location : query

          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.

        project

          Description : Project ID for this request.

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

          Type : string

          Location : path

        maxResults

          Default : 500

          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

          Type : integer

          Minimum : 0

        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.

          Type : string

          Location : query

        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

      Description : Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.

      Flat Path : projects/{project}/aggregated/networkAttachments

      HTTP Method : GET

      Path : projects/{project}/aggregated/networkAttachments

  • compute.networkAttachments.delete

      HTTP Method : DELETE

      Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}

      Scopes :

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

      Parameters :

        project

          Required : Yes

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

          Description : Project ID for this request.

        region

          Location : path

          Description : Name of the region of this request.

          Type : string

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

          Required : Yes

        networkAttachment

          Type : string

          Description : Name of the NetworkAttachment resource to delete.

          Location : path

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

          Required : Yes

        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). end_interface: MixerMutationRequestBuilder

          Location : query

      Parameter Order :

    • project
    • region
    • networkAttachment
    • Description : Deletes the specified NetworkAttachment in the given scope

  • compute.networkAttachments.testIamPermissions

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

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

      Parameters :

        project

          Required : Yes

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

        region

          Location : path

          Required : Yes

          Description : The name of the region for this request.

          Type : string

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

        resource

          Type : string

          Location : path

          Required : Yes

          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}

      HTTP Method : POST

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

      Scopes :

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

    • project
    • region
    • resource