Compute Engine v1 API - Class ReservationBlocks.ReservationBlocksClient (3.22.0)

public class ReservationBlocks.ReservationBlocksClient : ClientBase<ReservationBlocks.ReservationBlocksClient>

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

Client for ReservationBlocks

Inheritance

object > ClientBase > ClientBaseReservationBlocksReservationBlocksClient > ReservationBlocks.ReservationBlocksClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

ReservationBlocksClient()

protected ReservationBlocksClient()

Protected parameterless constructor to allow creation of test doubles.

ReservationBlocksClient(CallInvoker)

public ReservationBlocksClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

ReservationBlocksClient(ChannelBase)

public ReservationBlocksClient(ChannelBase channel)

Creates a new client for ReservationBlocks

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

ReservationBlocksClient(ClientBaseConfiguration)

protected ReservationBlocksClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateOperationsClientForZoneOperations()

public virtual Operations.OperationsClient CreateOperationsClientForZoneOperations()

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

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

Get(GetReservationBlockRequest, CallOptions)

public virtual ReservationBlocksGetResponse Get(GetReservationBlockRequest request, CallOptions options)

Retrieves information about the specified reservation block.

Parameters
Name Description
request GetReservationBlockRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ReservationBlocksGetResponse

The response received from the server.

Get(GetReservationBlockRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves information about the specified reservation block.

Parameters
Name Description
request GetReservationBlockRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
ReservationBlocksGetResponse

The response received from the server.

GetAsync(GetReservationBlockRequest, CallOptions)

public virtual AsyncUnaryCall<ReservationBlocksGetResponse> GetAsync(GetReservationBlockRequest request, CallOptions options)

Retrieves information about the specified reservation block.

Parameters
Name Description
request GetReservationBlockRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallReservationBlocksGetResponse

The call object.

GetAsync(GetReservationBlockRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves information about the specified reservation block.

Parameters
Name Description
request GetReservationBlockRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallReservationBlocksGetResponse

The call object.

GetIamPolicy(GetIamPolicyReservationBlockRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyReservationBlockRequest request, CallOptions options)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicyReservationBlockRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyReservationBlockRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyReservationBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicyReservationBlockRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
Policy

The response received from the server.

GetIamPolicyAsync(GetIamPolicyReservationBlockRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyReservationBlockRequest request, CallOptions options)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicyReservationBlockRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPolicy

The call object.

GetIamPolicyAsync(GetIamPolicyReservationBlockRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyReservationBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicyReservationBlockRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallPolicy

The call object.

List(ListReservationBlocksRequest, CallOptions)

public virtual ReservationBlocksListResponse List(ListReservationBlocksRequest request, CallOptions options)

Retrieves a list of reservation blocks under a single reservation.

Parameters
Name Description
request ListReservationBlocksRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ReservationBlocksListResponse

The response received from the server.

List(ListReservationBlocksRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of reservation blocks under a single reservation.

Parameters
Name Description
request ListReservationBlocksRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
ReservationBlocksListResponse

The response received from the server.

ListAsync(ListReservationBlocksRequest, CallOptions)

public virtual AsyncUnaryCall<ReservationBlocksListResponse> ListAsync(ListReservationBlocksRequest request, CallOptions options)

Retrieves a list of reservation blocks under a single reservation.

Parameters
Name Description
request ListReservationBlocksRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallReservationBlocksListResponse

The call object.

ListAsync(ListReservationBlocksRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of reservation blocks under a single reservation.

Parameters
Name Description
request ListReservationBlocksRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallReservationBlocksListResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override ReservationBlocks.ReservationBlocksClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
ReservationBlocksReservationBlocksClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.ReservationBlocks.ReservationBlocksClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PerformMaintenance(PerformMaintenanceReservationBlockRequest, CallOptions)

public virtual Operation PerformMaintenance(PerformMaintenanceReservationBlockRequest request, CallOptions options)

Allows customers to perform maintenance on a reservation block

Parameters
Name Description
request PerformMaintenanceReservationBlockRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

PerformMaintenance(PerformMaintenanceReservationBlockRequest, Metadata, DateTime?, CancellationToken)

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

Allows customers to perform maintenance on a reservation block

Parameters
Name Description
request PerformMaintenanceReservationBlockRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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.

PerformMaintenanceAsync(PerformMaintenanceReservationBlockRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PerformMaintenanceAsync(PerformMaintenanceReservationBlockRequest request, CallOptions options)

Allows customers to perform maintenance on a reservation block

Parameters
Name Description
request PerformMaintenanceReservationBlockRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

PerformMaintenanceAsync(PerformMaintenanceReservationBlockRequest, Metadata, DateTime?, CancellationToken)

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

Allows customers to perform maintenance on a reservation block

Parameters
Name Description
request PerformMaintenanceReservationBlockRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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.

SetIamPolicy(SetIamPolicyReservationBlockRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyReservationBlockRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicyReservationBlockRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyReservationBlockRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyReservationBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicyReservationBlockRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
Policy

The response received from the server.

SetIamPolicyAsync(SetIamPolicyReservationBlockRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyReservationBlockRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicyReservationBlockRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPolicy

The call object.

SetIamPolicyAsync(SetIamPolicyReservationBlockRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyReservationBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicyReservationBlockRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallPolicy

The call object.

TestIamPermissions(TestIamPermissionsReservationBlockRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsReservationBlockRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsReservationBlockRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
TestPermissionsResponse

The response received from the server.

TestIamPermissions(TestIamPermissionsReservationBlockRequest, Metadata, DateTime?, CancellationToken)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsReservationBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsReservationBlockRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
TestPermissionsResponse

The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsReservationBlockRequest, CallOptions)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsReservationBlockRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsReservationBlockRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallTestPermissionsResponse

The call object.

TestIamPermissionsAsync(TestIamPermissionsReservationBlockRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsReservationBlockRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsReservationBlockRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.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
AsyncUnaryCallTestPermissionsResponse

The call object.