public class RegionCommitments.RegionCommitmentsClient : ClientBase<RegionCommitments.RegionCommitmentsClient>
Reference documentation and code samples for the Compute Engine v1 API class RegionCommitments.RegionCommitmentsClient.
Client for RegionCommitments
Inheritance
object > ClientBase > ClientBaseRegionCommitmentsRegionCommitmentsClient > RegionCommitments.RegionCommitmentsClientNamespace
Google.Cloud.Compute.V1Assembly
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(ClientBaseConfiguration)
protected RegionCommitmentsClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration The client configuration. |
Methods
AggregatedList(AggregatedListRegionCommitmentsRequest, CallOptions)
public virtual CommitmentAggregatedList AggregatedList(AggregatedListRegionCommitmentsRequest request, CallOptions options)
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 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, DateTime?, CancellationToken)
public virtual CommitmentAggregatedList AggregatedList(AggregatedListRegionCommitmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
request |
AggregatedListRegionCommitmentsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallCommitmentAggregatedList |
The call object. |
AggregatedListAsync(AggregatedListRegionCommitmentsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<CommitmentAggregatedList> AggregatedListAsync(AggregatedListRegionCommitmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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 |
AsyncUnaryCallCommitmentAggregatedList |
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 |
OperationsOperationsClient |
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.
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, DateTime?, CancellationToken)
public virtual Commitment Get(GetRegionCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the specified commitment resource.
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 |
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.
Parameters | |
---|---|
Name | Description |
request |
GetRegionCommitmentRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallCommitment |
The call object. |
GetAsync(GetRegionCommitmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Commitment> GetAsync(GetRegionCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the specified commitment resource.
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 |
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 |
AsyncUnaryCallCommitment |
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, DateTime?, CancellationToken)
public virtual Operation Insert(InsertRegionCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
The call object. |
InsertAsync(InsertRegionCommitmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> InsertAsync(InsertRegionCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallOperation |
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, DateTime?, CancellationToken)
public virtual CommitmentList List(ListRegionCommitmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallCommitmentList |
The call object. |
ListAsync(ListRegionCommitmentsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<CommitmentList> ListAsync(ListRegionCommitmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 |
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 |
AsyncUnaryCallCommitmentList |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override RegionCommitments.RegionCommitmentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
RegionCommitmentsRegionCommitmentsClient |
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, DateTime?, CancellationToken)
public virtual Operation Update(UpdateRegionCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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)
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 |
AsyncUnaryCallOperation |
The call object. |
UpdateAsync(UpdateRegionCommitmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateRegionCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
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 |
AsyncUnaryCallOperation |
The call object. |