public class RolloutPlans.RolloutPlansClient : ClientBase<RolloutPlans.RolloutPlansClient>Reference documentation and code samples for the Compute Engine v1 API class RolloutPlans.RolloutPlansClient.
Client for RolloutPlans
Inheritance
object > ClientBase > ClientBaseRolloutPlansRolloutPlansClient > RolloutPlans.RolloutPlansClientNamespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Constructors
RolloutPlansClient()
protected RolloutPlansClient()Protected parameterless constructor to allow creation of test doubles.
RolloutPlansClient(CallInvoker)
public RolloutPlansClient(CallInvoker callInvoker)Creates a new client for RolloutPlans that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker |
CallInvokerThe callInvoker to use to make remote calls. |
RolloutPlansClient(ChannelBase)
public RolloutPlansClient(ChannelBase channel)Creates a new client for RolloutPlans
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
RolloutPlansClient(ClientBaseConfiguration)
protected RolloutPlansClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfigurationThe client configuration. |
Methods
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(DeleteRolloutPlanRequest, CallOptions)
public virtual Operation Delete(DeleteRolloutPlanRequest request, CallOptions options)Deletes a RolloutPlan.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteRolloutPlanRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
Delete(DeleteRolloutPlanRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation Delete(DeleteRolloutPlanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a RolloutPlan.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteRolloutPlanRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteAsync(DeleteRolloutPlanRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteRolloutPlanRequest request, CallOptions options)Deletes a RolloutPlan.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteRolloutPlanRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteAsync(DeleteRolloutPlanRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteRolloutPlanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a RolloutPlan.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteRolloutPlanRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
Get(GetRolloutPlanRequest, CallOptions)
public virtual RolloutPlan Get(GetRolloutPlanRequest request, CallOptions options)Gets details of a single project-scoped RolloutPlan.
| Parameters | |
|---|---|
| Name | Description |
request |
GetRolloutPlanRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
RolloutPlan |
The response received from the server. |
Get(GetRolloutPlanRequest, Metadata, DateTime?, CancellationToken)
public virtual RolloutPlan Get(GetRolloutPlanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets details of a single project-scoped RolloutPlan.
| Parameters | |
|---|---|
| Name | Description |
request |
GetRolloutPlanRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
RolloutPlan |
The response received from the server. |
GetAsync(GetRolloutPlanRequest, CallOptions)
public virtual AsyncUnaryCall<RolloutPlan> GetAsync(GetRolloutPlanRequest request, CallOptions options)Gets details of a single project-scoped RolloutPlan.
| Parameters | |
|---|---|
| Name | Description |
request |
GetRolloutPlanRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRolloutPlan |
The call object. |
GetAsync(GetRolloutPlanRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<RolloutPlan> GetAsync(GetRolloutPlanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets details of a single project-scoped RolloutPlan.
| Parameters | |
|---|---|
| Name | Description |
request |
GetRolloutPlanRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRolloutPlan |
The call object. |
Insert(InsertRolloutPlanRequest, CallOptions)
public virtual Operation Insert(InsertRolloutPlanRequest request, CallOptions options)Creates a new RolloutPlan in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
InsertRolloutPlanRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
Insert(InsertRolloutPlanRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation Insert(InsertRolloutPlanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new RolloutPlan in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
InsertRolloutPlanRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
InsertAsync(InsertRolloutPlanRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> InsertAsync(InsertRolloutPlanRequest request, CallOptions options)Creates a new RolloutPlan in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
InsertRolloutPlanRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
InsertAsync(InsertRolloutPlanRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> InsertAsync(InsertRolloutPlanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new RolloutPlan in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
InsertRolloutPlanRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
List(ListRolloutPlansRequest, CallOptions)
public virtual RolloutPlansListResponse List(ListRolloutPlansRequest request, CallOptions options)Lists RolloutPlans in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListRolloutPlansRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
RolloutPlansListResponse |
The response received from the server. |
List(ListRolloutPlansRequest, Metadata, DateTime?, CancellationToken)
public virtual RolloutPlansListResponse List(ListRolloutPlansRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists RolloutPlans in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListRolloutPlansRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
RolloutPlansListResponse |
The response received from the server. |
ListAsync(ListRolloutPlansRequest, CallOptions)
public virtual AsyncUnaryCall<RolloutPlansListResponse> ListAsync(ListRolloutPlansRequest request, CallOptions options)Lists RolloutPlans in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListRolloutPlansRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRolloutPlansListResponse |
The call object. |
ListAsync(ListRolloutPlansRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<RolloutPlansListResponse> ListAsync(ListRolloutPlansRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists RolloutPlans in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListRolloutPlansRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRolloutPlansListResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override RolloutPlans.RolloutPlansClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
RolloutPlansRolloutPlansClient |
|