2026-06-20
▼ ▲ gkehub.projects.locations.rollouts.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$
Location : path
Description : Required. The name of the rollout to retrieve. projects/{project}/locations/{location}/rollouts/{rollout}
Required : Yes
Type : string
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}
Path : v1/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves a single rollout.
▼ ▲ gkehub.projects.locations.rollouts.resume
Path : v1/{+name}:resume
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Resume a paused Rollout. The rollout will be resumed and allowed to be started on clusters.
Parameter Order : name
Parameters :
name
Type : string
Location : path
Description : Required. The name of the rollout to resume. projects/{project}/locations/{location}/rollouts/{rollout}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}:resume
▼ ▲ gkehub.projects.locations.rollouts.pause
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}:pause
HTTP Method : POST
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$
Description : Required. The name of the rollout to pause. projects/{project}/locations/{location}/rollouts/{rollout}
Required : Yes
Location : path
Description : Pauses a running Rollout. The rollout will not be started on new clusters, however the rollout running on the cluster will be allowed to finish.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v1/{+name}:pause
▼ ▲ gkehub.projects.locations.rollouts.forceCompleteStage
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Force-completes a rollout stage. Only the active stage of an active rollout can be force-completed.
Path : v1/{+name}:forceCompleteStage
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}:forceCompleteStage
Parameters :
name
Location : path
Description : Required. The name of the rollout. Format: projects/{project}/locations/{location}/rollouts/{rollout}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$
Type : string
HTTP Method : POST
▼ ▲ gkehub.projects.locations.rollouts.delete
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$
Location : path
Description : Required. The name of the rollout to delete. projects/{project}/locations/{location}/rollouts/{rollout}
Required : Yes
Type : string
requestId
Location : query
Description : Optional. A 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. The server will guarantee that for at least 60 minutes after the first request. 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
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}
Path : v1/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Removes a Rollout.
▼ ▲ gkehub.projects.locations.rollouts.cancel
Parameters :
name
Type : string
Location : path
Description : Required. The name of the rollout to cancel. projects/{project}/locations/{location}/rollouts/{rollout}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}:cancel
Path : v1/{+name}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Cancels a Rollout. The rollout will not be started on new clusters, however the rollout running on the cluster will be allowed to finish.
Parameter Order : name
▼ ▲ gkehub.projects.locations.rollouts.list
HTTP Method : GET
Parameters :
parent
Location : path
Description : Required. The parent, which owns this collection of rollout. Format: projects/{project}/locations/{location}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
pageSize
Type : integer
Location : query
Format : int32
Description : The maximum number of rollout to return. The service may return fewer than this value. If unspecified, at most 50 rollouts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
filter
Type : string
Description : Optional. Lists Rollouts that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
Location : query
pageToken
Type : string
Location : query
Description : A page token, received from a previous `ListRollouts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRollouts` must match the call that provided the page token.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rollouts
Path : v1/{+parent}/rollouts
Description : Retrieves the list of all rollouts.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
▼ ▲ gkehub.projects.locations.rolloutSequences.upgrade
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rolloutSequences/{rolloutSequencesId}:upgrade
HTTP Method : POST
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/rolloutSequences/[^/]+$
Location : path
Description : Required. The name of the rollout sequence. Format: projects/{project}/locations/{location}/rolloutSequences/{rollout_sequence}
Required : Yes
Description : Upgrades a rollout sequence.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v1/{+name}:upgrade
▼ ▲ gkehub.projects.locations.rolloutSequences.list
Path : v1/{+parent}/rolloutSequences
Parameter Order : parent
Description : Retrieves the list of all rollout sequences.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
parent
Type : string
Description : Required. The parent, which owns this collection of rollout sequences. Format: projects/{project}/locations/{location}
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
pageToken
Type : string
Location : query
Description : Optional. A page token, received from a previous `ListRolloutSequences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRolloutSequences` must match the call that provided the page token.
pageSize
Type : integer
Location : query
Format : int32
Description : Optional. The maximum number of rollout sequences to return. The service may return fewer than this value. If unspecified, at most 50 rollout sequences will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
filter
Description : Optional. Lists Rollout Sequences that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
Location : query
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rolloutSequences
▼ ▲ gkehub.projects.locations.rolloutSequences.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rolloutSequences/{rolloutSequencesId}
HTTP Method : PATCH
Parameters :
updateMask
Description : Optional. The list of fields to update.
Location : query
Format : google-fieldmask
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/rolloutSequences/[^/]+$
Description : Identifier. Name of the rollout sequence in the format of: projects/{PROJECT_ID}/locations/global/rolloutSequences/{NAME}
Required : Yes
Location : path
Type : string
Description : Updates a rollout sequence.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v1/{+name}
▼ ▲ gkehub.projects.locations.rolloutSequences.get
Parameter Order : name
Description : Retrieve a single rollout sequence.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rolloutSequences/{rolloutSequencesId}
HTTP Method : GET
Parameters :
name
Type : string
Description : Required. The name of the rollout sequence to retrieve. projects/{project}/locations/{location}/rolloutSequences/{rollout_sequence}
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/rolloutSequences/[^/]+$
▼ ▲ gkehub.projects.locations.rolloutSequences.create
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent resource where this rollout sequence will be created. projects/{project}/locations/{location}
Required : Yes
Location : path
Type : string
rolloutSequenceId
Description : Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/
Location : query
Type : string
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rolloutSequences
Path : v1/{+parent}/rolloutSequences
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new rollout sequence resource.
Parameter Order : parent
▼ ▲ gkehub.projects.locations.rolloutSequences.delete
HTTP Method : DELETE
Parameters :
name
Location : path
Description : Required. The name of the rollout sequence to delete. projects/{project}/locations/{location}/rolloutSequences/{rollout_sequence}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/rolloutSequences/[^/]+$
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/rolloutSequences/{rolloutSequencesId}
Path : v1/{+name}
Parameter Order : name
Description : Removes a RolloutSequence.