Compute Engine v1 API - Class RegionCommitmentsClientImpl (2.12.0) 

public sealed class RegionCommitmentsClientImpl : RegionCommitmentsClient

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

RegionCommitments client wrapper implementation, for convenient use.

Inheritance

object > RegionCommitmentsClient > RegionCommitmentsClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RegionCommitments API.

Constructors

RegionCommitmentsClientImpl(RegionCommitmentsClient, RegionCommitmentsSettings, ILogger)

public RegionCommitmentsClientImpl(RegionCommitments.RegionCommitmentsClient grpcClient, RegionCommitmentsSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientRegionCommitmentsRegionCommitmentsClient

The underlying gRPC client.

settingsRegionCommitmentsSettings

The base RegionCommitmentsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override RegionCommitments.RegionCommitmentsClient GrpcClient { get; }

The underlying gRPC RegionCommitments client

Property Value
TypeDescription
RegionCommitmentsRegionCommitmentsClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

AggregatedList(AggregatedListRegionCommitmentsRequest, CallSettings)

public override PagedEnumerable<CommitmentAggregatedList, KeyValuePair<string, CommitmentsScopedList>> AggregatedList(AggregatedListRegionCommitmentsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of commitments by region.

Parameters
NameDescription
requestAggregatedListRegionCommitmentsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableCommitmentAggregatedListKeyValuePairstringCommitmentsScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

AggregatedListAsync(AggregatedListRegionCommitmentsRequest, CallSettings)

public override PagedAsyncEnumerable<CommitmentAggregatedList, KeyValuePair<string, CommitmentsScopedList>> AggregatedListAsync(AggregatedListRegionCommitmentsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of commitments by region.

Parameters
NameDescription
requestAggregatedListRegionCommitmentsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableCommitmentAggregatedListKeyValuePairstringCommitmentsScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

Get(GetRegionCommitmentRequest, CallSettings)

public override Commitment Get(GetRegionCommitmentRequest request, CallSettings callSettings = null)

Returns the specified commitment resource.

Parameters
NameDescription
requestGetRegionCommitmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Commitment

The RPC response.

Overrides

GetAsync(GetRegionCommitmentRequest, CallSettings)

public override Task<Commitment> GetAsync(GetRegionCommitmentRequest request, CallSettings callSettings = null)

Returns the specified commitment resource.

Parameters
NameDescription
requestGetRegionCommitmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskCommitment

A Task containing the RPC response.

Overrides

Insert(InsertRegionCommitmentRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertRegionCommitmentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestInsertRegionCommitmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Overrides

InsertAsync(InsertRegionCommitmentRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertRegionCommitmentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestInsertRegionCommitmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

List(ListRegionCommitmentsRequest, CallSettings)

public override PagedEnumerable<CommitmentList, Commitment> List(ListRegionCommitmentsRequest request, CallSettings callSettings = null)

Retrieves a list of commitments contained within the specified region.

Parameters
NameDescription
requestListRegionCommitmentsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableCommitmentListCommitment

A pageable sequence of Commitment resources.

Overrides

ListAsync(ListRegionCommitmentsRequest, CallSettings)

public override PagedAsyncEnumerable<CommitmentList, Commitment> ListAsync(ListRegionCommitmentsRequest request, CallSettings callSettings = null)

Retrieves a list of commitments contained within the specified region.

Parameters
NameDescription
requestListRegionCommitmentsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableCommitmentListCommitment

A pageable asynchronous sequence of Commitment resources.

Overrides

Update(UpdateRegionCommitmentRequest, CallSettings)

public override Operation<Operation, Operation> Update(UpdateRegionCommitmentRequest request, CallSettings callSettings = null)

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
NameDescription
requestUpdateRegionCommitmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Overrides

UpdateAsync(UpdateRegionCommitmentRequest, CallSettings)

public override Task<Operation<Operation, Operation>> UpdateAsync(UpdateRegionCommitmentRequest request, CallSettings callSettings = null)

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
NameDescription
requestUpdateRegionCommitmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides