Compute Engine v1 API - Class Rollouts.RolloutsClient (3.28.0)

3.28.0 (latest) 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 class Rollouts.RolloutsClient : ClientBase<Rollouts.RolloutsClient>

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

Client for Rollouts

Inheritance

object > ClientBase > ClientBaseRolloutsRolloutsClient > Rollouts.RolloutsClient

Inherited Members

ClientBase<Rollouts.RolloutsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RolloutsClient()

protected RolloutsClient()

Protected parameterless constructor to allow creation of test doubles.

RolloutsClient(CallInvoker)

public RolloutsClient(CallInvoker callInvoker)

Creates a new client for Rollouts that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

RolloutsClient(ChannelBase)

public RolloutsClient(ChannelBase channel)

Creates a new client for Rollouts

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

RolloutsClient(ClientBaseConfiguration)

protected RolloutsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

Cancel(CancelRolloutRequest, CallOptions)

public virtual Operation Cancel(CancelRolloutRequest request, CallOptions options)

Cancels a Rollout.

Parameters
Name	Description
request	CancelRolloutRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Cancel(CancelRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Cancel(CancelRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels a Rollout.

Parameters
Name	Description
request	CancelRolloutRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CancelAsync(CancelRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CancelAsync(CancelRolloutRequest request, CallOptions options)

Cancels a Rollout.

Parameters
Name	Description
request	CancelRolloutRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CancelAsync(CancelRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CancelAsync(CancelRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels a Rollout.

Parameters
Name	Description
request	CancelRolloutRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to GlobalOperations.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteRolloutRequest, CallOptions)

public virtual Operation Delete(DeleteRolloutRequest request, CallOptions options)

Deletes a Rollout.

Parameters
Name	Description
request	DeleteRolloutRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Delete(DeleteRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Delete(DeleteRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Rollout.

Parameters
Name	Description
request	DeleteRolloutRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteAsync(DeleteRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteRolloutRequest request, CallOptions options)

Deletes a Rollout.

Parameters
Name	Description
request	DeleteRolloutRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Rollout.

Parameters
Name	Description
request	DeleteRolloutRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

Get(GetRolloutRequest, CallOptions)

public virtual Rollout Get(GetRolloutRequest request, CallOptions options)

Gets details of a single project-scoped Rollout.

Parameters
Name	Description
request	GetRolloutRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Rollout	The response received from the server.

Get(GetRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual Rollout Get(GetRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single project-scoped Rollout.

Parameters
Name	Description
request	GetRolloutRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Rollout	The response received from the server.

GetAsync(GetRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<Rollout> GetAsync(GetRolloutRequest request, CallOptions options)

Gets details of a single project-scoped Rollout.

Parameters
Name	Description
request	GetRolloutRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRollout	The call object.

GetAsync(GetRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Rollout> GetAsync(GetRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single project-scoped Rollout.

Parameters
Name	Description
request	GetRolloutRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRollout	The call object.

List(ListRolloutsRequest, CallOptions)

public virtual RolloutsListResponse List(ListRolloutsRequest request, CallOptions options)

Lists Rollouts in a given project and location.

Parameters
Name	Description
request	ListRolloutsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RolloutsListResponse	The response received from the server.

List(ListRolloutsRequest, Metadata, DateTime?, CancellationToken)

public virtual RolloutsListResponse List(ListRolloutsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Rollouts in a given project and location.

Parameters
Name	Description
request	ListRolloutsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RolloutsListResponse	The response received from the server.

ListAsync(ListRolloutsRequest, CallOptions)

public virtual AsyncUnaryCall<RolloutsListResponse> ListAsync(ListRolloutsRequest request, CallOptions options)

Lists Rollouts in a given project and location.

Parameters
Name	Description
request	ListRolloutsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRolloutsListResponse	The call object.

ListAsync(ListRolloutsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RolloutsListResponse> ListAsync(ListRolloutsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Rollouts in a given project and location.

Parameters
Name	Description
request	ListRolloutsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRolloutsListResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Rollouts.RolloutsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
RolloutsRolloutsClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.Rollouts.RolloutsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)