2026-08-27
▼ ▲ compute.organizationSnapshotRecycleBinPolicy.get
Parameter Order : organization
Scopes :
Path : {+organization}/global/snapshotRecycleBinPolicy
Description : Returns the specified SnapshotRecycleBinPolicy.
Parameters :
organization
Location : path
Pattern : organizations/[0-9]{0,20}
Description : Organization ID for this request.
Type : string
Required : Yes
HTTP Method : GET
Flat Path : organizations/{organizationsId}/global/snapshotRecycleBinPolicy
▼ ▲ compute.organizationSnapshotRecycleBinPolicy.patch
Flat Path : organizations/{organizationsId}/global/snapshotRecycleBinPolicy
Scopes :
Description : Patches the SnapshotRecycleBinPolicy.
Parameter Order : organization
Parameters :
organization
Location : path
Type : string
Pattern : organizations/[0-9]{0,20}
Description : Organization ID for this request.
Required : Yes
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
Path : {+organization}/global/snapshotRecycleBinPolicy
HTTP Method : PATCH
▼ ▲ compute.dhcpOptionsConfigs.delete
Scopes :
Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}
Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}
Parameter Order :
Description : Deletes the specified DhcpOptionsConfig in the given location
Parameters :
region
Description : Name of the region of this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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). end_interface: MixerMutationRequestBuilder
Type : string
Location : query
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])?))
Description : Project ID for this request.
Required : Yes
dhcpOptionsConfig
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 DhcpOptionsConfig resource to delete.
Location : path
HTTP Method : DELETE
▼ ▲ compute.dhcpOptionsConfigs.patch
Parameter Order :
HTTP Method : PATCH
Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}
Parameters :
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Location : path
updateMask
Description : update_mask indicates fields to be updated as part of this request.
Format : google-fieldmask
Type : string
Location : query
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). end_interface: MixerMutationRequestBuilder
Location : query
Type : string
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
dhcpOptionsConfig
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Type : string
Description : Name of the DhcpOptionsConfig resource to patch.
Scopes :
Description : Patches the specified DhcpOptionsConfig resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}
▼ ▲ compute.dhcpOptionsConfigs.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Scopes :
Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{resource}/testIamPermissions
Parameters :
project
Type : string
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])?))
region
Type : string
Description : The name of the region for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{resource}/testIamPermissions
HTTP Method : POST
▼ ▲ compute.dhcpOptionsConfigs.list
Description : Lists the DhcpOptionsConfigs for a project in the given location.
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs
Parameters :
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Type : boolean
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. These two types of filter expressions cannot be mixed in one request. 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 `:*` 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 onresource 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 GoogleRE2 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`. You cannot combine constraints on multiple fields using regular expressions.
Type : string
Location : query
maxResults
Type : integer
Minimum : 0
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
Format : uint32
project
Description : Project ID for this request.
Location : path
Type : string
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])?))
region
Description : Name of the region of this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
pageToken
Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location : query
Type : string
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
Path : projects/{project}/regions/{region}/dhcpOptionsConfigs
Parameter Order :
Scopes :
▼ ▲ compute.dhcpOptionsConfigs.get
Scopes :
Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}
Description : Returns the specified DhcpOptionsConfig resource in the given location.
Parameter Order :
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}
Parameters :
dhcpOptionsConfig
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
Description : Name of the DhcpOptionsConfig resource to return.
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
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
Description : Project ID for this request.
Type : string
▼ ▲ compute.dhcpOptionsConfigs.insert
Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs
Description : Creates a DhcpOptionsConfig in the specified project in the given location using the parameters that are included in the request.
Path : projects/{project}/regions/{region}/dhcpOptionsConfigs
HTTP Method : POST
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
Required : Yes
Location : path
requestId
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
Location : query
Type : string
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region of this request.
Location : path
Scopes :
Parameter Order :
▼ ▲ compute.snapshots.getEffectiveRecycleBinRule
Parameters :
snapshot
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the Snapshot resource to get the effective recycle bin rule for.
Type : string
Required : Yes
project
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
Location : path
Scopes :
HTTP Method : GET
Path : projects/{project}/global/snapshots/{snapshot}/getEffectiveRecycleBinRule
Parameter Order :
Description : Returns the effective recycle bin rule for a snapshot by merging org and project level rules. If no rules are defined at org and project level, the standard default rule is returned.
Flat Path : projects/{project}/global/snapshots/{snapshot}/getEffectiveRecycleBinRule
▼ ▲ compute.reservationSlots.getHealth
Parameters :
parentName
Location : path
Description : The name of the parent reservation, parent block and parent sub-block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}
Type : string
Required : Yes
Pattern : reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})
requestId
Description : An optional request ID to identify requests.
Type : string
Location : query
project
Type : string
Required : Yes
Description : Project ID for this request.
Location : path
reservationSlot
Required : Yes
Type : string
Location : path
Description : The name of the reservation slot. Name should conform to RFC1035 or be a resource ID.
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Required : Yes
Type : string
Location : path
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getHealth
Parameter Order :
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}/getHealth
HTTP Method : POST
Description : Get health info on a reservation slot.
Scopes :
▼ ▲ compute.recoverableSnapshots.recover
Scopes :
Path : projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}/recover
Parameter Order :
HTTP Method : POST
Parameters :
project
Description : Project Id of the 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
recoverableSnapshot
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the recoverable resource to recover
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
snapshotName
Location : query
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Optional. Name of the snapshot after the recovery The name will be 1-63 characters long, and comply withRFC1035. Specifically, the name will be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character will be a lowercase letter, and all following characters can be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Description : Recovers the specified RecoverableSnapshot.
Flat Path : projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}/recover
▼ ▲ compute.recoverableSnapshots.getIamPolicy
Scopes :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
HTTP Method : GET
Parameters :
resource
Type : string
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}
Required : Yes
Location : path
project
Description : Project ID for this request.
Location : path
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type : string
Required : Yes
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Format : int32
Type : integer
Location : query
Flat Path : projects/{project}/global/recoverableSnapshots/{resource}/getIamPolicy
Path : projects/{project}/global/recoverableSnapshots/{resource}/getIamPolicy
▼ ▲ compute.recoverableSnapshots.delete
Parameters :
project
Type : string
Location : path
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])?))
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).
recoverableSnapshot
Type : string
Location : path
Required : Yes
Description : Name of the recoverable Snapshot resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order :
HTTP Method : DELETE
Path : projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}
Scopes :
Flat Path : projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}
Description : Deletes the specified RecoverableSnapshot. Deleting a recoverable snapshot will delete the underlying PD snapshot and is irreversible.
▼ ▲ compute.recoverableSnapshots.setIamPolicy
Parameter Order :
HTTP Method : POST
Parameters :
project
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
Location : path
resource
Required : Yes
Location : path
Type : string
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}
Flat Path : projects/{project}/global/recoverableSnapshots/{resource}/setIamPolicy
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Path : projects/{project}/global/recoverableSnapshots/{resource}/setIamPolicy
▼ ▲ compute.recoverableSnapshots.testIamPermissions
Path : projects/{project}/global/recoverableSnapshots/{resource}/testIamPermissions
Scopes :
Flat Path : projects/{project}/global/recoverableSnapshots/{resource}/testIamPermissions
Parameter Order :
Parameters :
resource
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name or id of the resource for this request.
project
Required : Yes
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])?))
Location : path
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
▼ ▲ compute.recoverableSnapshots.get
Parameters :
recoverableSnapshot
Type : string
Location : path
Required : Yes
Description : Name of the Snapshot resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Type : string
Location : path
Description : Project ID for this request.
Path : projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}
HTTP Method : GET
Description : Returns the specified RecoverableSnapshot resource.
Flat Path : projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}
Parameter Order :
Scopes :
▼ ▲ compute.recoverableSnapshots.list
Path : projects/{project}/global/recoverableSnapshots
Parameter Order : project
Scopes :
Flat Path : projects/{project}/global/recoverableSnapshots
HTTP Method : GET
Parameters :
maxResults
Type : integer
Format : uint32
Default : 500
Location : query
Minimum : 0
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`)
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. These two types of filter expressions cannot be mixed in one request. 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 `:*` 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 onresource 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 GoogleRE2 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`. You cannot combine constraints on multiple fields using regular expressions.
Type : string
Location : query
returnPartialSuccess
Location : query
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
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
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
Description : Project ID for 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.
Description : Retrieves a list of all of the RecoverableSnapshots in your project.
▼ ▲ compute.snapshotRecycleBinPolicy.get
Description : Returns the specified SnapshotRecycleBinPolicy.
Scopes :
Flat Path : projects/{project}/global/snapshotRecycleBinPolicy
Parameter Order : project
HTTP Method : GET
Parameters :
project
Location : path
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
Path : projects/{project}/global/snapshotRecycleBinPolicy
▼ ▲ compute.snapshotRecycleBinPolicy.patch
Scopes :
Description : Patches the SnapshotRecycleBinPolicy.
Parameters :
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).
project
Type : string
Required : Yes
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])?))
Flat Path : projects/{project}/global/snapshotRecycleBinPolicy
HTTP Method : PATCH
Path : projects/{project}/global/snapshotRecycleBinPolicy
Parameter Order : project
▼ ▲ compute.instances.listVmExtensionStates
Path : projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates
Scopes :
Parameters :
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
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. These two types of filter expressions cannot be mixed in one request. 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 `:*` 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 onresource 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 GoogleRE2 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`. You cannot combine constraints on multiple fields using regular expressions.
Location : query
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
Description : Project ID for this request.
Type : string
maxResults
Type : integer
Minimum : 0
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
Default : 500
Location : query
instance
Location : path
Description : Name of the target instance scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location : query
Type : boolean
zone
Description : Required. Name of the zone for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates
HTTP Method : GET
Description : Lists all VM extensions states for a specific instance. This is a read-only API.
Parameter Order :
▼ ▲ compute.instances.getVmExtensionState
Description : Retrieves details of a specific VM extension state. This is a read-only API.
HTTP Method : GET
Parameters :
zone
Description : Name of the zone for this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Location : path
Description : Project ID for this request.
Type : string
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])?))
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name or id of the instance resource.
Location : path
extensionName
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : The name of the extension to get the state for.
Type : string
Required : Yes
Path : projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates/{extensionName}
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates/{extensionName}
Scopes :
▼ ▲ compute.globalFrontendSettings.get
Scopes :
Flat Path : projects/{project}/global/globalFrontendSettings
Description : Gets the Global Frontend Billing Bundle Settings for a project.
HTTP Method : GET
Path : projects/{project}/global/globalFrontendSettings
Parameters :
project
Required : Yes
Location : path
Type : string
Parameter Order : project
▼ ▲ compute.globalFrontendSettings.patch
Description : Updates the Global Frontend Billing Bundle Settings for a project.
Scopes :
HTTP Method : PATCH
Parameter Order : project
Path : projects/{project}/global/globalFrontendSettings
Parameters :
project
Required : Yes
Location : path
Type : string
requestId
Type : string
Location : query
updateMask
Description : e.g., "type"
Format : google-fieldmask
Type : string
Location : query
Flat Path : projects/{project}/global/globalFrontendSettings