Compute Engine v1 API - Class RegionCommitments.RegionCommitmentsClient (2.4.0)

public class RegionCommitmentsClient : ClientBase<RegionCommitments.RegionCommitmentsClient>

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

Client for RegionCommitments

Inheritance

Object > ClientBase > ClientBase<RegionCommitments.RegionCommitmentsClient> > RegionCommitments.RegionCommitmentsClient

Inherited Members

ClientBase<RegionCommitments.RegionCommitmentsClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionCommitmentsClient()

protected RegionCommitmentsClient()

Protected parameterless constructor to allow creation of test doubles.

RegionCommitmentsClient(CallInvoker)

public RegionCommitmentsClient(CallInvoker callInvoker)

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

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

RegionCommitmentsClient(ChannelBase)

public RegionCommitmentsClient(ChannelBase channel)

Creates a new client for RegionCommitments

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

RegionCommitmentsClient(ClientBase.ClientBaseConfiguration)

protected RegionCommitmentsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

AggregatedList(AggregatedListRegionCommitmentsRequest, CallOptions)

public virtual CommitmentAggregatedList AggregatedList(AggregatedListRegionCommitmentsRequest request, CallOptions options)

Retrieves an aggregated list of commitments by region.

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

Returns
Type	Description
`CommitmentAggregatedList`	The response received from the server.

AggregatedList(AggregatedListRegionCommitmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual CommitmentAggregatedList AggregatedList(AggregatedListRegionCommitmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves an aggregated list of commitments by region.

Parameters
Name	Description
`request`	`AggregatedListRegionCommitmentsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`CommitmentAggregatedList`	The response received from the server.

AggregatedListAsync(AggregatedListRegionCommitmentsRequest, CallOptions)

public virtual AsyncUnaryCall<CommitmentAggregatedList> AggregatedListAsync(AggregatedListRegionCommitmentsRequest request, CallOptions options)

Retrieves an aggregated list of commitments by region.

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

Returns
Type	Description
`AsyncUnaryCall<CommitmentAggregatedList>`	The call object.

AggregatedListAsync(AggregatedListRegionCommitmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<CommitmentAggregatedList> AggregatedListAsync(AggregatedListRegionCommitmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves an aggregated list of commitments by region.

Parameters
Name	Description
`request`	`AggregatedListRegionCommitmentsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<CommitmentAggregatedList>`	The call object.

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

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

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

Get(GetRegionCommitmentRequest, CallOptions)

public virtual Commitment Get(GetRegionCommitmentRequest request, CallOptions options)

Returns the specified commitment resource. Gets a list of available commitments by making a list() request.

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

Returns
Type	Description
`Commitment`	The response received from the server.

Get(GetRegionCommitmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the specified commitment resource. Gets a list of available commitments by making a list() request.

Parameters
Name	Description
`request`	`GetRegionCommitmentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`Commitment`	The response received from the server.

GetAsync(GetRegionCommitmentRequest, CallOptions)

public virtual AsyncUnaryCall<Commitment> GetAsync(GetRegionCommitmentRequest request, CallOptions options)

Returns the specified commitment resource. Gets a list of available commitments by making a list() request.

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

Returns
Type	Description
`AsyncUnaryCall<Commitment>`	The call object.

GetAsync(GetRegionCommitmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the specified commitment resource. Gets a list of available commitments by making a list() request.

Parameters
Name	Description
`request`	`GetRegionCommitmentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<Commitment>`	The call object.

Insert(InsertRegionCommitmentRequest, CallOptions)

public virtual Operation Insert(InsertRegionCommitmentRequest request, CallOptions options)

Creates a commitment in the specified project using the data included in the request.

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

Returns
Type	Description
`Operation`	The response received from the server.

Insert(InsertRegionCommitmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a commitment in the specified project using the data included in the request.

Parameters
Name	Description
`request`	`InsertRegionCommitmentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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.

InsertAsync(InsertRegionCommitmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertRegionCommitmentRequest request, CallOptions options)

Creates a commitment in the specified project using the data included in the request.

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

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

InsertAsync(InsertRegionCommitmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a commitment in the specified project using the data included in the request.

Parameters
Name	Description
`request`	`InsertRegionCommitmentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<Operation>`	The call object.

List(ListRegionCommitmentsRequest, CallOptions)

public virtual CommitmentList List(ListRegionCommitmentsRequest request, CallOptions options)

Retrieves a list of commitments contained within the specified region.

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

Returns
Type	Description
`CommitmentList`	The response received from the server.

List(ListRegionCommitmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves a list of commitments contained within the specified region.

Parameters
Name	Description
`request`	`ListRegionCommitmentsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`CommitmentList`	The response received from the server.

ListAsync(ListRegionCommitmentsRequest, CallOptions)

public virtual AsyncUnaryCall<CommitmentList> ListAsync(ListRegionCommitmentsRequest request, CallOptions options)

Retrieves a list of commitments contained within the specified region.

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

Returns
Type	Description
`AsyncUnaryCall<CommitmentList>`	The call object.

ListAsync(ListRegionCommitmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves a list of commitments contained within the specified region.

Parameters
Name	Description
`request`	`ListRegionCommitmentsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<CommitmentList>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override RegionCommitments.RegionCommitmentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`RegionCommitments.RegionCommitmentsClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.RegionCommitments.RegionCommitmentsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Update(UpdateRegionCommitmentRequest, CallOptions)

public virtual Operation Update(UpdateRegionCommitmentRequest request, CallOptions options)

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

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

Returns
Type	Description
`Operation`	The response received from the server.

Update(UpdateRegionCommitmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Parameters
Name	Description
`request`	`UpdateRegionCommitmentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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.

UpdateAsync(UpdateRegionCommitmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateRegionCommitmentRequest request, CallOptions options)

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

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

UpdateAsync(UpdateRegionCommitmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Parameters
Name	Description
`request`	`UpdateRegionCommitmentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<Operation>`	The call object.