Class ProjectsResource.LocationsResource.RolloutsResource
The "rollouts" collection of methods.
Inherited Members
Namespace: Google.Apis.GKEHub.v1beta
Assembly: Google.Apis.GKEHub.v1beta.dll
Syntax
public class ProjectsResource.LocationsResource.RolloutsResource
Constructors
RolloutsResource(IClientService)
Constructs a new resource.
Declaration
public RolloutsResource(IClientService service)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Methods
Cancel(CancelRolloutRequest, string)
Cancels a paused Rollout. The rollout will not be started on new clusters, however the rollout running on the cluster will be allowed to finish. It's only valid to cancel a paused rollout, otherwise it will return a FAILED_PRECONDITION error.
Declaration
public virtual ProjectsResource.LocationsResource.RolloutsResource.CancelRequest Cancel(CancelRolloutRequest body, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| CancelRolloutRequest | body | The body of the request. |
| string | name | Required. The name of the rollout to cancel. projects/{project}/locations/{location}/rollouts/{rollout} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.RolloutsResource.CancelRequest |
ForceCompleteStage(ForceCompleteRolloutStageRequest, string)
Force-completes a rollout stage. Only the active stage of an active rollout can be force-completed.
Declaration
public virtual ProjectsResource.LocationsResource.RolloutsResource.ForceCompleteStageRequest ForceCompleteStage(ForceCompleteRolloutStageRequest body, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| ForceCompleteRolloutStageRequest | body | The body of the request. |
| string | name | Required. The name of the rollout. Format: projects/{project}/locations/{location}/rollouts/{rollout} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.RolloutsResource.ForceCompleteStageRequest |
Get(string)
Retrieves a single rollout.
Declaration
public virtual ProjectsResource.LocationsResource.RolloutsResource.GetRequest Get(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the rollout to retrieve. projects/{project}/locations/{location}/rollouts/{rollout} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.RolloutsResource.GetRequest |
List(string)
Retrieves the list of all rollouts.
Declaration
public virtual ProjectsResource.LocationsResource.RolloutsResource.ListRequest List(string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent, which owns this collection of rollout. Format: projects/{project}/locations/{location} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.RolloutsResource.ListRequest |
Pause(PauseRolloutRequest, string)
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.
Declaration
public virtual ProjectsResource.LocationsResource.RolloutsResource.PauseRequest Pause(PauseRolloutRequest body, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| PauseRolloutRequest | body | The body of the request. |
| string | name | Required. The name of the rollout to pause. projects/{project}/locations/{location}/rollouts/{rollout} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.RolloutsResource.PauseRequest |
Resume(ResumeRolloutRequest, string)
Resume a paused Rollout. The rollout will be resumed and allowed to be started on clusters.
Declaration
public virtual ProjectsResource.LocationsResource.RolloutsResource.ResumeRequest Resume(ResumeRolloutRequest body, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| ResumeRolloutRequest | body | The body of the request. |
| string | name | Required. The name of the rollout to resume. projects/{project}/locations/{location}/rollouts/{rollout} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.RolloutsResource.ResumeRequest |