2025-10-25
▼ ▲ compute.rolloutPlans.get
Description : Gets details of a single project-scoped RolloutPlan.
Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
HTTP Method : GET
Scopes :
Parameter Order :
Flat Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Parameters :
rolloutPlan
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name of the persistent rollout plan to return.
Type : string
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.
Required : Yes
Location : path
▼ ▲ compute.rolloutPlans.list
Flat Path : projects/{project}/global/rolloutPlans
Path : projects/{project}/global/rolloutPlans
Description : Lists RolloutPlans in a given project and location.
Parameters :
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
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`)
Type : integer
Format : uint32
Minimum : 0
Location : query
Default : 500
project
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])?))
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
returnPartialSuccess
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.
Location : query
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.
HTTP Method : GET
Parameter Order : project
Scopes :
▼ ▲ compute.rolloutPlans.delete
Scopes :
Parameter Order :
Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Flat Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
HTTP Method : DELETE
Description : Deletes a RolloutPlan.
Parameters :
requestId
Type : string
Location : query
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
rolloutPlan
Location : path
Description : Name of the RolloutPlan resource to delete.
Required : Yes
Type : string
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])?))
Location : path
Type : string
Required : Yes
Description : Project ID for this request.
▼ ▲ compute.rolloutPlans.insert
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
Location : path
Type : string
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])?))
Description : Creates a new RolloutPlan in a given project and location.
Path : projects/{project}/global/rolloutPlans
Parameter Order : project
Scopes :
Flat Path : projects/{project}/global/rolloutPlans
HTTP Method : POST
▼ ▲ compute.haControllers.aggregatedList
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
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`)
Default : 500
Format : uint32
Type : integer
orderBy
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.
Location : query
serviceProjectNumber
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
Location : query
project
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
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
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.
returnPartialSuccess
Type : boolean
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.
Flat Path : projects/{project}/aggregated/haControllers
Path : projects/{project}/aggregated/haControllers
Description : Retrieves an aggregated list of all of the HaControllers in the specified project across all regions.
Scopes :
Parameter Order : project
HTTP Method : GET
▼ ▲ compute.rollouts.delete
HTTP Method : DELETE
Parameters :
project
Type : string
Location : path
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required : Yes
Description : Project ID for this request.
rollout
Description : Name of the Rollout resource to delete.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
requestId
Location : query
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Parameter Order :
Flat Path : projects/{project}/global/rollouts/{rollout}
Description : Deletes a Rollout.
Path : projects/{project}/global/rollouts/{rollout}
Scopes :
▼ ▲ compute.rollouts.cancel
Description : Cancels a Rollout.
Scopes :
Path : projects/{project}/global/rollouts/{rollout}
Parameter Order :
HTTP Method : PATCH
Flat Path : projects/{project}/global/rollouts/{rollout}
Parameters :
rollout
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the Rollout resource to cancel.
Type : string
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.
Required : Yes
Location : path
requestId
Type : string
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
rollback
Type : boolean
Location : query
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.
▼ ▲ compute.rollouts.list
Scopes :
Description : Lists Rollouts in a given project and location.
Flat Path : projects/{project}/global/rollouts
HTTP Method : GET
Parameters :
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.
returnPartialSuccess
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.
Location : query
project
Required : Yes
Type : string
Description : Project ID for this request.
Location : path
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
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.
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
maxResults
Format : uint32
Type : integer
Default : 500
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`)
Location : query
Minimum : 0
Path : projects/{project}/global/rollouts
Parameter Order : project
▼ ▲ compute.rollouts.get
Parameter Order :
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.
Type : string
Location : path
rollout
Location : path
Required : Yes
Type : string
Description : Name of the persistent rollout to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Path : projects/{project}/global/rollouts/{rollout}
Flat Path : projects/{project}/global/rollouts/{rollout}
HTTP Method : GET
Scopes :
Description : Gets details of a single project-scoped Rollout.
▼ ▲ compute.subnetworks.aggregatedList
Parameters :
views
Description : Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.
Location : query
Enum :
Type : string
Enum Descriptions :
Repeated : Yes
▼ ▲ compute.globalVmExtensionPolicies.delete
Parameters :
rolloutInput.conflictBehavior
Description : Optional. [Optional] Specifies the behavior of the Rollout if a conflict is detected in a project during a Rollout. It can be one of the following values: 1) empty : don't overwrite the local value if conflict happens. This is the default behavior. 2) "overwrite" : Overwrite the local value with the rollout value. The concept of "conflict" applies to: 1) Insert action. If the zonal policy already exists when Insert happens, it's a conflict. 2) Update action. If the zonal policy was updated out of band by a zonal API, it's a conflict.
Location : query
Type : string
rolloutInput.name
Description : Optional. The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/.
Location : query
Type : string
rolloutInput.predefinedRolloutPlan
Description : Optional. Predefined rollout plan.
Location : query
Type : string
Enum Descriptions :
Enum :
rolloutInput.retryUuid
Description : Optional. The UUID of the retry action. Only set it if this is a retry for an existing resource. This is for the user re-populate the resource without changes. An error will be returned if the retry_uuid is set but the resource get modified.
Location : query
Type : string
Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy} ⟶ projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete
HTTP Method : PATCH ⟶ POST
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy} ⟶ projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete
▼ ▲ compute.globalVmExtensionPolicies.delete
Parameters :
rolloutInput.conflictBehavior
Description : Optional. [Optional] Specifies the behavior of the Rollout if a conflict is detected in a project during a Rollout. It can be one of the following values: 1) empty : don't overwrite the local value if conflict happens. This is the default behavior. 2) "overwrite" : Overwrite the local value with the rollout value. The concept of "conflict" applies to: 1) Insert action. If the zonal policy already exists when Insert happens, it's a conflict. 2) Update action. If the zonal policy was updated out of band by a zonal API, it's a conflict.
Location : query
Type : string
rolloutInput.name
Description : Optional. The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/.
Location : query
Type : string
rolloutInput.predefinedRolloutPlan
Description : Optional. Predefined rollout plan.
Location : query
Type : string
Enum Descriptions :
Enum :
rolloutInput.retryUuid
Description : Optional. The UUID of the retry action. Only set it if this is a retry for an existing resource. This is for the user re-populate the resource without changes. An error will be returned if the retry_uuid is set but the resource get modified.
Location : query
Type : string
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete ⟶ projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete ⟶ projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
HTTP Method : POST ⟶ PATCH
▼ ▲ compute.subnetworks.aggregatedList
Parameters :
views
Description : Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.
Type : string
Repeated : Yes
Location : query
Enum :
Enum Descriptions :
▼ ▲ compute.rolloutPlans.get
Parameters :
project
Location : path
Description : Project ID for this request.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required : Yes
Type : string
rolloutPlan
Required : Yes
Description : Name of the persistent rollout plan to return.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Parameter Order :
Flat Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
HTTP Method : GET
Description : Gets details of a single project-scoped RolloutPlan.
Scopes :
▼ ▲ compute.rolloutPlans.delete
Scopes :
Description : Deletes a RolloutPlan.
Parameter Order :
Parameters :
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
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).
rolloutPlan
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name of the RolloutPlan resource to delete.
Location : path
Flat Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
HTTP Method : DELETE
▼ ▲ compute.rolloutPlans.insert
Parameter Order : project
Description : Creates a new RolloutPlan in a given project and location.
HTTP Method : POST
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).
Type : string
Location : query
Scopes :
Path : projects/{project}/global/rolloutPlans
Flat Path : projects/{project}/global/rolloutPlans
▼ ▲ compute.rolloutPlans.list
Path : projects/{project}/global/rolloutPlans
Parameter Order : project
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.
maxResults
Minimum : 0
Format : uint32
Type : integer
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`)
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
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
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.
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
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/global/rolloutPlans
Description : Lists RolloutPlans in a given project and location.
▼ ▲ compute.rollouts.get
Description : Gets details of a single project-scoped Rollout.
Parameter Order :
Scopes :
HTTP Method : GET
Parameters :
project
Type : string
Description : Project ID for this request.
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])?))
rollout
Type : string
Required : Yes
Location : path
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.
Flat Path : projects/{project}/global/rollouts/{rollout}
Path : projects/{project}/global/rollouts/{rollout}
▼ ▲ compute.rollouts.delete
Description : Deletes a Rollout.
Path : projects/{project}/global/rollouts/{rollout}
Parameters :
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
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])?))
rollout
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
Description : Name of the Rollout resource to delete.
Flat Path : projects/{project}/global/rollouts/{rollout}
HTTP Method : DELETE
Scopes :
Parameter Order :
▼ ▲ compute.rollouts.cancel
HTTP Method : PATCH
Path : projects/{project}/global/rollouts/{rollout}
Parameters :
rollback
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.
Location : query
Type : boolean
rollout
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the Rollout resource to cancel.
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).
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])?))
Required : Yes
Type : string
Description : Cancels a Rollout.
Flat Path : projects/{project}/global/rollouts/{rollout}
Scopes :
Parameter Order :
▼ ▲ compute.rollouts.list
Parameters :
maxResults
Default : 500
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`)
Location : query
project
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
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
Type : string
Location : query
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.
returnPartialSuccess
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.
Location : query
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
Description : Lists Rollouts in a given project and location.
Flat Path : projects/{project}/global/rollouts
Scopes :
Parameter Order : project
HTTP Method : GET
Path : projects/{project}/global/rollouts
▼ ▲ compute.haControllers.aggregatedList
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
serviceProjectNumber
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
Location : query
includeAllScopes
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.
Location : query
maxResults
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`)
Format : uint32
Type : integer
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])?))
Location : path
Required : Yes
returnPartialSuccess
Type : boolean
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.
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
filter
Type : string
Location : query
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.
Scopes :
Flat Path : projects/{project}/aggregated/haControllers
HTTP Method : GET
Parameter Order : project
Description : Retrieves an aggregated list of all of the HaControllers in the specified project across all regions.
Path : projects/{project}/aggregated/haControllers