public sealed class RegionCommitmentsClientImpl : RegionCommitmentsClientReference documentation and code samples for the Compute Engine v1 API class RegionCommitmentsClientImpl.
RegionCommitments client wrapper implementation, for convenient use.
Namespace
GoogleCloudGoogle.Cloud.ComputeV1Assembly
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 | RegionCommitmentsRegionCommitmentsClientThe underlying gRPC client. |
settings | RegionCommitmentsSettingsThe base RegionCommitmentsSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override RegionCommitments.RegionCommitmentsClient GrpcClient { get; }The underlying gRPC RegionCommitments client
| Property Value | |
|---|---|
| Type | Description |
RegionCommitmentsRegionCommitmentsClient | |
InsertOperationsClient
public override OperationsClient InsertOperationsClient { get; }The long-running operations client for Insert.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateOperationsClient
public override OperationsClient UpdateOperationsClient { get; }The long-running operations client for Update.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 | |
|---|---|
| Name | Description |
request | AggregatedListRegionCommitmentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableCommitmentAggregatedListKeyValuePairstringCommitmentsScopedList | A pageable sequence of KeyValuePair<TKey,TValue> resources. |
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 | |
|---|---|
| Name | Description |
request | AggregatedListRegionCommitmentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableCommitmentAggregatedListKeyValuePairstringCommitmentsScopedList | A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources. |
Get(GetRegionCommitmentRequest, CallSettings)
public override Commitment Get(GetRegionCommitmentRequest request, CallSettings callSettings = null)Returns the specified commitment resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetRegionCommitmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Commitment | The RPC response. |
GetAsync(GetRegionCommitmentRequest, CallSettings)
public override Task<Commitment> GetAsync(GetRegionCommitmentRequest request, CallSettings callSettings = null)Returns the specified commitment resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetRegionCommitmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCommitment | A Task containing the RPC response. |
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 | InsertRegionCommitmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | InsertRegionCommitmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | ListRegionCommitmentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableCommitmentListCommitment | A pageable sequence of Commitment resources. |
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 | ListRegionCommitmentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableCommitmentListCommitment | A pageable asynchronous sequence of Commitment resources. |
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 | UpdateRegionCommitmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | UpdateRegionCommitmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |