Compute Engine v1 API - Class RolloutsClientImpl (3.29.0)

3.29.0 (latest) 3.28.0 3.27.0 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0

public sealed class RolloutsClientImpl : RolloutsClient

Reference documentation and code samples for the Compute Engine v1 API class RolloutsClientImpl.

Rollouts client wrapper implementation, for convenient use.

Inheritance

object > RolloutsClient > RolloutsClientImpl

Inherited Members

RolloutsClient.DefaultEndpoint

RolloutsClient.DefaultScopes

RolloutsClient.ServiceMetadata

RolloutsClient.CreateAsync(CancellationToken)

RolloutsClient.Create()

RolloutsClient.ShutdownDefaultChannelsAsync()

RolloutsClient.AdvanceAsync(AdvanceRolloutRequest, CancellationToken)

RolloutsClient.PollOnceAdvance(string, CallSettings)

RolloutsClient.PollOnceAdvanceAsync(string, CallSettings)

RolloutsClient.Advance(string, string, CallSettings)

RolloutsClient.AdvanceAsync(string, string, CallSettings)

RolloutsClient.AdvanceAsync(string, string, CancellationToken)

RolloutsClient.CancelAsync(CancelRolloutRequest, CancellationToken)

RolloutsClient.PollOnceCancel(string, CallSettings)

RolloutsClient.PollOnceCancelAsync(string, CallSettings)

RolloutsClient.Cancel(string, string, CallSettings)

RolloutsClient.CancelAsync(string, string, CallSettings)

RolloutsClient.CancelAsync(string, string, CancellationToken)

RolloutsClient.DeleteAsync(DeleteRolloutRequest, CancellationToken)

RolloutsClient.PollOnceDelete(string, CallSettings)

RolloutsClient.PollOnceDeleteAsync(string, CallSettings)

RolloutsClient.Delete(string, string, CallSettings)

RolloutsClient.DeleteAsync(string, string, CallSettings)

RolloutsClient.DeleteAsync(string, string, CancellationToken)

RolloutsClient.GetAsync(GetRolloutRequest, CancellationToken)

RolloutsClient.Get(string, string, CallSettings)

RolloutsClient.GetAsync(string, string, CallSettings)

RolloutsClient.GetAsync(string, string, CancellationToken)

RolloutsClient.List(string, string, int?, CallSettings)

RolloutsClient.ListAsync(string, string, int?, CallSettings)

RolloutsClient.PauseAsync(PauseRolloutRequest, CancellationToken)

RolloutsClient.PollOncePause(string, CallSettings)

RolloutsClient.PollOncePauseAsync(string, CallSettings)

RolloutsClient.Pause(string, string, CallSettings)

RolloutsClient.PauseAsync(string, string, CallSettings)

RolloutsClient.PauseAsync(string, string, CancellationToken)

RolloutsClient.ResumeAsync(ResumeRolloutRequest, CancellationToken)

RolloutsClient.PollOnceResume(string, CallSettings)

RolloutsClient.PollOnceResumeAsync(string, CallSettings)

RolloutsClient.Resume(string, string, CallSettings)

RolloutsClient.ResumeAsync(string, string, CallSettings)

RolloutsClient.ResumeAsync(string, string, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Rollouts API.

Constructors

RolloutsClientImpl(RolloutsClient, RolloutsSettings, ILogger)

public RolloutsClientImpl(Rollouts.RolloutsClient grpcClient, RolloutsSettings settings, ILogger logger)

Constructs a client wrapper for the Rollouts service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	RolloutsRolloutsClient The underlying gRPC client.
settings	RolloutsSettings The base RolloutsSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

AdvanceOperationsClient

public override OperationsClient AdvanceOperationsClient { get; }

The long-running operations client for Advance.

Property Value
Type	Description
OperationsClient

Overrides

RolloutsClient.AdvanceOperationsClient

CancelOperationsClient

public override OperationsClient CancelOperationsClient { get; }

The long-running operations client for Cancel.

Property Value
Type	Description
OperationsClient

Overrides

RolloutsClient.CancelOperationsClient

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
OperationsClient

Overrides

RolloutsClient.DeleteOperationsClient

GrpcClient

public override Rollouts.RolloutsClient GrpcClient { get; }

The underlying gRPC Rollouts client

Property Value
Type	Description
RolloutsRolloutsClient

Overrides

RolloutsClient.GrpcClient

PauseOperationsClient

public override OperationsClient PauseOperationsClient { get; }

The long-running operations client for Pause.

Property Value
Type	Description
OperationsClient

Overrides

RolloutsClient.PauseOperationsClient

ResumeOperationsClient

public override OperationsClient ResumeOperationsClient { get; }

The long-running operations client for Resume.

Property Value
Type	Description
OperationsClient

Overrides

RolloutsClient.ResumeOperationsClient

Methods

Advance(AdvanceRolloutRequest, CallSettings)

public override Operation<Operation, Operation> Advance(AdvanceRolloutRequest request, CallSettings callSettings = null)

Advances a Rollout to the next wave, or completes it if no waves remain.

Parameters
Name	Description
request	AdvanceRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

RolloutsClient.Advance(AdvanceRolloutRequest, CallSettings)

AdvanceAsync(AdvanceRolloutRequest, CallSettings)

public override Task<Operation<Operation, Operation>> AdvanceAsync(AdvanceRolloutRequest request, CallSettings callSettings = null)

Advances a Rollout to the next wave, or completes it if no waves remain.

Parameters
Name	Description
request	AdvanceRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

RolloutsClient.AdvanceAsync(AdvanceRolloutRequest, CallSettings)

Cancel(CancelRolloutRequest, CallSettings)

public override Operation<Operation, Operation> Cancel(CancelRolloutRequest request, CallSettings callSettings = null)

Cancels a Rollout.

Parameters
Name	Description
request	CancelRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

RolloutsClient.Cancel(CancelRolloutRequest, CallSettings)

CancelAsync(CancelRolloutRequest, CallSettings)

public override Task<Operation<Operation, Operation>> CancelAsync(CancelRolloutRequest request, CallSettings callSettings = null)

Cancels a Rollout.

Parameters
Name	Description
request	CancelRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

RolloutsClient.CancelAsync(CancelRolloutRequest, CallSettings)

Delete(DeleteRolloutRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteRolloutRequest request, CallSettings callSettings = null)

Deletes a Rollout.

Parameters
Name	Description
request	DeleteRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

RolloutsClient.Delete(DeleteRolloutRequest, CallSettings)

DeleteAsync(DeleteRolloutRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteRolloutRequest request, CallSettings callSettings = null)

Deletes a Rollout.

Parameters
Name	Description
request	DeleteRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

RolloutsClient.DeleteAsync(DeleteRolloutRequest, CallSettings)

Get(GetRolloutRequest, CallSettings)

public override Rollout Get(GetRolloutRequest request, CallSettings callSettings = null)

Gets details of a single project-scoped Rollout.

Parameters
Name	Description
request	GetRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Rollout	The RPC response.

Overrides

RolloutsClient.Get(GetRolloutRequest, CallSettings)

GetAsync(GetRolloutRequest, CallSettings)

public override Task<Rollout> GetAsync(GetRolloutRequest request, CallSettings callSettings = null)

Gets details of a single project-scoped Rollout.

Parameters
Name	Description
request	GetRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskRollout	A Task containing the RPC response.

Overrides

RolloutsClient.GetAsync(GetRolloutRequest, CallSettings)

List(ListRolloutsRequest, CallSettings)

public override PagedEnumerable<RolloutsListResponse, Rollout> List(ListRolloutsRequest request, CallSettings callSettings = null)

Lists Rollouts in a given project and location.

Parameters
Name	Description
request	ListRolloutsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableRolloutsListResponseRollout	A pageable sequence of Rollout resources.

Overrides

RolloutsClient.List(ListRolloutsRequest, CallSettings)

ListAsync(ListRolloutsRequest, CallSettings)

public override PagedAsyncEnumerable<RolloutsListResponse, Rollout> ListAsync(ListRolloutsRequest request, CallSettings callSettings = null)

Lists Rollouts in a given project and location.

Parameters
Name	Description
request	ListRolloutsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableRolloutsListResponseRollout	A pageable asynchronous sequence of Rollout resources.

Overrides

RolloutsClient.ListAsync(ListRolloutsRequest, CallSettings)

Pause(PauseRolloutRequest, CallSettings)

public override Operation<Operation, Operation> Pause(PauseRolloutRequest request, CallSettings callSettings = null)

Pauses a Rollout.

Parameters
Name	Description
request	PauseRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

RolloutsClient.Pause(PauseRolloutRequest, CallSettings)

PauseAsync(PauseRolloutRequest, CallSettings)

public override Task<Operation<Operation, Operation>> PauseAsync(PauseRolloutRequest request, CallSettings callSettings = null)

Pauses a Rollout.

Parameters
Name	Description
request	PauseRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

RolloutsClient.PauseAsync(PauseRolloutRequest, CallSettings)

Resume(ResumeRolloutRequest, CallSettings)

public override Operation<Operation, Operation> Resume(ResumeRolloutRequest request, CallSettings callSettings = null)

Resumes a Rollout.

Parameters
Name	Description
request	ResumeRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

RolloutsClient.Resume(ResumeRolloutRequest, CallSettings)

ResumeAsync(ResumeRolloutRequest, CallSettings)

public override Task<Operation<Operation, Operation>> ResumeAsync(ResumeRolloutRequest request, CallSettings callSettings = null)

Resumes a Rollout.

Parameters
Name	Description
request	ResumeRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

RolloutsClient.ResumeAsync(ResumeRolloutRequest, CallSettings)