Compute Engine v1 API - Class RegionCommitmentsClientImpl (2.16.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

Inherited Members

RegionCommitmentsClient.DefaultEndpoint

RegionCommitmentsClient.DefaultScopes

RegionCommitmentsClient.ServiceMetadata

RegionCommitmentsClient.CreateAsync(CancellationToken)

RegionCommitmentsClient.Create()

RegionCommitmentsClient.ShutdownDefaultChannelsAsync()

RegionCommitmentsClient.AggregatedList(string, string, int?, CallSettings)

RegionCommitmentsClient.AggregatedListAsync(string, string, int?, CallSettings)

RegionCommitmentsClient.GetAsync(GetRegionCommitmentRequest, CancellationToken)

RegionCommitmentsClient.Get(string, string, string, CallSettings)

RegionCommitmentsClient.GetAsync(string, string, string, CallSettings)

RegionCommitmentsClient.GetAsync(string, string, string, CancellationToken)

RegionCommitmentsClient.InsertAsync(InsertRegionCommitmentRequest, CancellationToken)

RegionCommitmentsClient.PollOnceInsert(string, CallSettings)

RegionCommitmentsClient.PollOnceInsertAsync(string, CallSettings)

RegionCommitmentsClient.Insert(string, string, Commitment, CallSettings)

RegionCommitmentsClient.InsertAsync(string, string, Commitment, CallSettings)

RegionCommitmentsClient.InsertAsync(string, string, Commitment, CancellationToken)

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

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

RegionCommitmentsClient.UpdateAsync(UpdateRegionCommitmentRequest, CancellationToken)

RegionCommitmentsClient.PollOnceUpdate(string, CallSettings)

RegionCommitmentsClient.PollOnceUpdateAsync(string, CallSettings)

RegionCommitmentsClient.Update(string, string, string, Commitment, CallSettings)

RegionCommitmentsClient.UpdateAsync(string, string, string, Commitment, CallSettings)

RegionCommitmentsClient.UpdateAsync(string, string, string, Commitment, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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
Name	Description
`grpcClient`	`RegionCommitmentsRegionCommitmentsClient` The underlying gRPC client.
`settings`	`RegionCommitmentsSettings` The base RegionCommitmentsSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override RegionCommitments.RegionCommitmentsClient GrpcClient { get; }

The underlying gRPC RegionCommitments client

Property Value
Type	Description
`RegionCommitmentsRegionCommitmentsClient`

Overrides

RegionCommitmentsClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

RegionCommitmentsClient.InsertOperationsClient

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type	Description
`OperationsClient`

Overrides

RegionCommitmentsClient.UpdateOperationsClient

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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
`request`	`AggregatedListRegionCommitmentsRequest` 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
`PagedEnumerableCommitmentAggregatedListKeyValuePairstringCommitmentsScopedList`	A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

RegionCommitmentsClient.AggregatedList(AggregatedListRegionCommitmentsRequest, CallSettings)

AggregatedListAsync(AggregatedListRegionCommitmentsRequest, CallSettings)

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

Retrieves an aggregated list of commitments by region. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
`request`	`AggregatedListRegionCommitmentsRequest` 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
`PagedAsyncEnumerableCommitmentAggregatedListKeyValuePairstringCommitmentsScopedList`	A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

RegionCommitmentsClient.AggregatedListAsync(AggregatedListRegionCommitmentsRequest, CallSettings)

Get(GetRegionCommitmentRequest, CallSettings)

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

Returns the specified commitment resource.

Parameters
Name	Description
`request`	`GetRegionCommitmentRequest` 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
`Commitment`	The RPC response.

Overrides

RegionCommitmentsClient.Get(GetRegionCommitmentRequest, CallSettings)

GetAsync(GetRegionCommitmentRequest, CallSettings)

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

Returns the specified commitment resource.

Parameters
Name	Description
`request`	`GetRegionCommitmentRequest` 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
`TaskCommitment`	A Task containing the RPC response.

Overrides

RegionCommitmentsClient.GetAsync(GetRegionCommitmentRequest, CallSettings)

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
Name	Description
`request`	`InsertRegionCommitmentRequest` 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

RegionCommitmentsClient.Insert(InsertRegionCommitmentRequest, CallSettings)

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
Name	Description
`request`	`InsertRegionCommitmentRequest` 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

RegionCommitmentsClient.InsertAsync(InsertRegionCommitmentRequest, CallSettings)

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
Name	Description
`request`	`ListRegionCommitmentsRequest` 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
`PagedEnumerableCommitmentListCommitment`	A pageable sequence of Commitment resources.

Overrides

RegionCommitmentsClient.List(ListRegionCommitmentsRequest, CallSettings)

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
Name	Description
`request`	`ListRegionCommitmentsRequest` 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
`PagedAsyncEnumerableCommitmentListCommitment`	A pageable asynchronous sequence of Commitment resources.

Overrides

RegionCommitmentsClient.ListAsync(ListRegionCommitmentsRequest, CallSettings)

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
Name	Description
`request`	`UpdateRegionCommitmentRequest` 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

RegionCommitmentsClient.Update(UpdateRegionCommitmentRequest, CallSettings)

UpdateAsync(UpdateRegionCommitmentRequest, CallSettings)

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

Parameters
Name	Description
`request`	`UpdateRegionCommitmentRequest` 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

RegionCommitmentsClient.UpdateAsync(UpdateRegionCommitmentRequest, CallSettings)