2026-05-05
▼ ▲ compute.rollouts.get
Flat Path : projects/{project}/global/rollouts/{rollout}
HTTP Method : GET
Description : Gets details of a single project-scoped Rollout.
Parameter Order :
Scopes :
Path : projects/{project}/global/rollouts/{rollout}
Parameters :
project
Type : string
Location : path
Required : Yes
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description : Project ID for this request.
rollout
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the persistent rollout to return.
Location : path
Required : Yes
▼ ▲ compute.rollouts.list
Flat Path : projects/{project}/global/rollouts
HTTP Method : GET
Description : Lists Rollouts in a given project and location.
Parameter Order : project
Scopes :
Path : projects/{project}/global/rollouts
Parameters :
orderBy
Location : query
Type : string
Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
pageToken
Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location : query
Type : string
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
returnPartialSuccess
Location : query
Type : boolean
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 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.
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. 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.
maxResults
Format : uint32
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`)
Default : 500
Location : query
▼ ▲ compute.rollouts.cancel
Parameter Order :
Description : Cancels a Rollout.
Path : projects/{project}/global/rollouts/{rollout}
Parameters :
rollback
Location : query
Type : boolean
Description : Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel the rollout without taking any further actions. Note that products must support at least one of these options, however, it does not need to support both.
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])?))
rollout
Type : string
Location : path
Required : Yes
Description : Name of the Rollout resource to cancel.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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).
Scopes :
Flat Path : projects/{project}/global/rollouts/{rollout}
HTTP Method : PATCH
▼ ▲ compute.rollouts.delete
Parameter Order :
Description : Deletes a Rollout.
Parameters :
project
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])?))
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).
Location : query
Type : string
rollout
Type : string
Description : Name of the Rollout resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Path : projects/{project}/global/rollouts/{rollout}
Scopes :
Flat Path : projects/{project}/global/rollouts/{rollout}
HTTP Method : DELETE
▼ ▲ compute.licenseCodes.getIamPolicy
Parameter Order :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
Path : projects/{project}/global/licenseCodes/{resource}/getIamPolicy
Parameters :
project
Type : string
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description : Project ID for this request.
Location : path
Required : Yes
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}
optionsRequestedPolicyVersion
Location : query
Type : integer
Description : Requested IAM Policy version.
Format : int32
Scopes :
Flat Path : projects/{project}/global/licenseCodes/{resource}/getIamPolicy
HTTP Method : GET
▼ ▲ compute.licenseCodes.setIamPolicy
HTTP Method : POST
Flat Path : projects/{project}/global/licenseCodes/{resource}/setIamPolicy
Parameters :
project
Location : path
Required : Yes
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description : Project ID for this request.
Type : string
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}
Location : path
Required : Yes
Type : string
Path : projects/{project}/global/licenseCodes/{resource}/setIamPolicy
Scopes :
Parameter Order :
Description : Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
▼ ▲ compute.networks.cancelRequestRemovePeering
Flat Path : projects/{project}/global/networks/{network}/cancelRequestRemovePeering
HTTP Method : POST
Description : Cancel requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. Cancels a request to remove a peering from the specified network.
Parameter Order :
Scopes :
Path : projects/{project}/global/networks/{network}/cancelRequestRemovePeering
Parameters :
project
Type : string
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description : Project ID for this request.
Location : path
Required : Yes
network
Description : Name of the network resource to remove peering from.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Type : string
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).
▼ ▲ compute.globalVmExtensionPolicies.get
HTTP Method : GET
Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
Scopes :
Parameters :
globalVmExtensionPolicy
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the GlobalVmExtensionPolicy resource to return.
Location : path
Required : Yes
project
Type : string
Location : path
Required : Yes
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description : Project ID for this request.
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
Description : Gets details of a global VM extension policy.
Parameter Order :
▼ ▲ compute.globalVmExtensionPolicies.delete
HTTP Method : POST
Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete
Scopes :
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete
Parameters :
globalVmExtensionPolicy
Location : path
Required : Yes
Type : string
Description : Name of the global VM extension policy to purge scoped resources for.
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
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).
Description : Purge scoped resources (zonal policies) from a global VM extension policy, and then delete the global VM extension policy. Purge of the scoped resources is a pre-condition of the global VM extension policy deletion. The deletion of the global VM extension policy happens after the purge rollout is done, so it's not a part of the LRO. It's an automatic process that triggers in the backend.
Parameter Order :
▼ ▲ compute.globalVmExtensionPolicies.aggregatedList
Scopes :
Path : projects/{project}/aggregated/vmExtensionPolicies
Parameters :
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.
Location : query
Type : string
maxResults
Format : uint32
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`)
Default : 500
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.
project
Description : Name of the project scoping 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
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
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
serviceProjectNumber
Location : query
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
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
Description : Retrieves the list of all VM Extension Policy resources available to the specified project. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
HTTP Method : GET
Flat Path : projects/{project}/aggregated/vmExtensionPolicies
▼ ▲ compute.globalVmExtensionPolicies.insert
Path : projects/{project}/global/vmExtensionPolicies
Parameters :
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
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
Scopes :
Parameter Order : project
Description : Creates a new project level GlobalVmExtensionPolicy.
HTTP Method : POST
Flat Path : projects/{project}/global/vmExtensionPolicies
▼ ▲ compute.globalVmExtensionPolicies.list
Path : projects/{project}/global/vmExtensionPolicies
Parameters :
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
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.
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.
Location : query
Type : string
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`)
Minimum : 0
Type : integer
Format : uint32
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
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
Scopes :
Parameter Order : project
Description : Lists global VM extension policies.
HTTP Method : GET
Flat Path : projects/{project}/global/vmExtensionPolicies
▼ ▲ compute.globalVmExtensionPolicies.update
Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
HTTP Method : PATCH
Description : Updates a global VM extension policy.
Parameter Order :
Scopes :
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).
globalVmExtensionPolicy
Description : Name of the global VM extension policy to update.
Location : path
Required : Yes
Type : string
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])?))
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
▼ ▲ compute.rolloutPlans.delete
Scopes :
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])?))
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
rolloutPlan
Description : Name of the RolloutPlan resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
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).
Location : query
Type : string
Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Description : Deletes a RolloutPlan.
Parameter Order :
HTTP Method : DELETE
Flat Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
▼ ▲ compute.rolloutPlans.get
Scopes :
Parameters :
project
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])?))
Type : string
rolloutPlan
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the persistent rollout plan to return.
Location : path
Required : Yes
Type : string
Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Description : Gets details of a single project-scoped RolloutPlan.
Parameter Order :
HTTP Method : GET
Flat Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
▼ ▲ compute.rolloutPlans.list
Scopes :
Parameters :
orderBy
Location : query
Type : string
Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
pageToken
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
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])?))
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
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.
Location : query
Type : string
maxResults
Format : uint32
Minimum : 0
Type : integer
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
Location : query
Path : projects/{project}/global/rolloutPlans
Description : Lists RolloutPlans in a given project and location.
Parameter Order : project
HTTP Method : GET
Flat Path : projects/{project}/global/rolloutPlans
▼ ▲ compute.rolloutPlans.insert
Description : Creates a new RolloutPlan in a given project and location.
Parameter Order : project
Scopes :
Path : projects/{project}/global/rolloutPlans
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
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
Flat Path : projects/{project}/global/rolloutPlans
HTTP Method : POST