Compute Engine v1 API - Class ReservationBlocksClient (3.9.0)

public abstract class ReservationBlocksClient

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

ReservationBlocks client wrapper, for convenient use.

Inheritance

object > ReservationBlocksClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The ReservationBlocks API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ReservationBlocks service, which is a host of "compute.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ReservationBlocks scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

GrpcClient

public virtual ReservationBlocks.ReservationBlocksClient GrpcClient { get; }

The underlying gRPC ReservationBlocks client

Property Value
Type Description
ReservationBlocksReservationBlocksClient

PerformMaintenanceOperationsClient

public virtual OperationsClient PerformMaintenanceOperationsClient { get; }

The long-running operations client for PerformMaintenance.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static ReservationBlocksClient Create()

Synchronously creates a ReservationBlocksClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ReservationBlocksClientBuilder.

Returns
Type Description
ReservationBlocksClient

The created ReservationBlocksClient.

CreateAsync(CancellationToken)

public static Task<ReservationBlocksClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a ReservationBlocksClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ReservationBlocksClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskReservationBlocksClient

The task representing the created ReservationBlocksClient.

Get(GetReservationBlockRequest, CallSettings)

public virtual ReservationBlocksGetResponse Get(GetReservationBlockRequest request, CallSettings callSettings = null)

Retrieves information about the specified reservation block.

Parameters
Name Description
request GetReservationBlockRequest

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
ReservationBlocksGetResponse

The RPC response.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.Create();
// Initialize request argument(s)
GetReservationBlockRequest request = new GetReservationBlockRequest
{
    Zone = "",
    Reservation = "",
    Project = "",
    ReservationBlock = "",
};
// Make the request
ReservationBlocksGetResponse response = reservationBlocksClient.Get(request);

Get(string, string, string, string, CallSettings)

public virtual ReservationBlocksGetResponse Get(string project, string zone, string reservation, string reservationBlock, CallSettings callSettings = null)

Retrieves information about the specified reservation block.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request. Zone name should conform to RFC1035.

reservation string

The name of the reservation. Name should conform to RFC1035 or be a resource ID.

reservationBlock string

The name of the reservation block. Name should conform to RFC1035 or be a resource ID.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
ReservationBlocksGetResponse

The RPC response.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string reservation = "";
string reservationBlock = "";
// Make the request
ReservationBlocksGetResponse response = reservationBlocksClient.Get(project, zone, reservation, reservationBlock);

GetAsync(GetReservationBlockRequest, CallSettings)

public virtual Task<ReservationBlocksGetResponse> GetAsync(GetReservationBlockRequest request, CallSettings callSettings = null)

Retrieves information about the specified reservation block.

Parameters
Name Description
request GetReservationBlockRequest

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
TaskReservationBlocksGetResponse

A Task containing the RPC response.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = await ReservationBlocksClient.CreateAsync();
// Initialize request argument(s)
GetReservationBlockRequest request = new GetReservationBlockRequest
{
    Zone = "",
    Reservation = "",
    Project = "",
    ReservationBlock = "",
};
// Make the request
ReservationBlocksGetResponse response = await reservationBlocksClient.GetAsync(request);

GetAsync(GetReservationBlockRequest, CancellationToken)

public virtual Task<ReservationBlocksGetResponse> GetAsync(GetReservationBlockRequest request, CancellationToken cancellationToken)

Retrieves information about the specified reservation block.

Parameters
Name Description
request GetReservationBlockRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskReservationBlocksGetResponse

A Task containing the RPC response.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = await ReservationBlocksClient.CreateAsync();
// Initialize request argument(s)
GetReservationBlockRequest request = new GetReservationBlockRequest
{
    Zone = "",
    Reservation = "",
    Project = "",
    ReservationBlock = "",
};
// Make the request
ReservationBlocksGetResponse response = await reservationBlocksClient.GetAsync(request);

GetAsync(string, string, string, string, CallSettings)

public virtual Task<ReservationBlocksGetResponse> GetAsync(string project, string zone, string reservation, string reservationBlock, CallSettings callSettings = null)

Retrieves information about the specified reservation block.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request. Zone name should conform to RFC1035.

reservation string

The name of the reservation. Name should conform to RFC1035 or be a resource ID.

reservationBlock string

The name of the reservation block. Name should conform to RFC1035 or be a resource ID.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskReservationBlocksGetResponse

A Task containing the RPC response.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = await ReservationBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string reservation = "";
string reservationBlock = "";
// Make the request
ReservationBlocksGetResponse response = await reservationBlocksClient.GetAsync(project, zone, reservation, reservationBlock);

GetAsync(string, string, string, string, CancellationToken)

public virtual Task<ReservationBlocksGetResponse> GetAsync(string project, string zone, string reservation, string reservationBlock, CancellationToken cancellationToken)

Retrieves information about the specified reservation block.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request. Zone name should conform to RFC1035.

reservation string

The name of the reservation. Name should conform to RFC1035 or be a resource ID.

reservationBlock string

The name of the reservation block. Name should conform to RFC1035 or be a resource ID.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskReservationBlocksGetResponse

A Task containing the RPC response.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = await ReservationBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string reservation = "";
string reservationBlock = "";
// Make the request
ReservationBlocksGetResponse response = await reservationBlocksClient.GetAsync(project, zone, reservation, reservationBlock);

List(ListReservationBlocksRequest, CallSettings)

public virtual PagedEnumerable<ReservationBlocksListResponse, ReservationBlock> List(ListReservationBlocksRequest request, CallSettings callSettings = null)

Retrieves a list of reservation blocks under a single reservation.

Parameters
Name Description
request ListReservationBlocksRequest

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
PagedEnumerableReservationBlocksListResponseReservationBlock

A pageable sequence of ReservationBlock resources.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.Create();
// Initialize request argument(s)
ListReservationBlocksRequest request = new ListReservationBlocksRequest
{
    Zone = "",
    Reservation = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<ReservationBlocksListResponse, ReservationBlock> response = reservationBlocksClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ReservationBlock item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ReservationBlocksListResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ReservationBlock item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ReservationBlock> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ReservationBlock item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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

public virtual PagedEnumerable<ReservationBlocksListResponse, ReservationBlock> List(string project, string zone, string reservation, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of reservation blocks under a single reservation.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request. Zone name should conform to RFC1035.

reservation string

The name of the reservation. Name should conform to RFC1035 or be a resource ID.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableReservationBlocksListResponseReservationBlock

A pageable sequence of ReservationBlock resources.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string reservation = "";
// Make the request
PagedEnumerable<ReservationBlocksListResponse, ReservationBlock> response = reservationBlocksClient.List(project, zone, reservation);

// Iterate over all response items, lazily performing RPCs as required
foreach (ReservationBlock item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ReservationBlocksListResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ReservationBlock item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ReservationBlock> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ReservationBlock item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAsync(ListReservationBlocksRequest, CallSettings)

public virtual PagedAsyncEnumerable<ReservationBlocksListResponse, ReservationBlock> ListAsync(ListReservationBlocksRequest request, CallSettings callSettings = null)

Retrieves a list of reservation blocks under a single reservation.

Parameters
Name Description
request ListReservationBlocksRequest

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
PagedAsyncEnumerableReservationBlocksListResponseReservationBlock

A pageable asynchronous sequence of ReservationBlock resources.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = await ReservationBlocksClient.CreateAsync();
// Initialize request argument(s)
ListReservationBlocksRequest request = new ListReservationBlocksRequest
{
    Zone = "",
    Reservation = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<ReservationBlocksListResponse, ReservationBlock> response = reservationBlocksClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ReservationBlock item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ReservationBlocksListResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ReservationBlock item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ReservationBlock> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ReservationBlock item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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

public virtual PagedAsyncEnumerable<ReservationBlocksListResponse, ReservationBlock> ListAsync(string project, string zone, string reservation, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of reservation blocks under a single reservation.

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request. Zone name should conform to RFC1035.

reservation string

The name of the reservation. Name should conform to RFC1035 or be a resource ID.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableReservationBlocksListResponseReservationBlock

A pageable asynchronous sequence of ReservationBlock resources.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = await ReservationBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string reservation = "";
// Make the request
PagedAsyncEnumerable<ReservationBlocksListResponse, ReservationBlock> response = reservationBlocksClient.ListAsync(project, zone, reservation);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ReservationBlock item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ReservationBlocksListResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ReservationBlock item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ReservationBlock> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ReservationBlock item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PerformMaintenance(PerformMaintenanceReservationBlockRequest, CallSettings)

public virtual Operation<Operation, Operation> PerformMaintenance(PerformMaintenanceReservationBlockRequest request, CallSettings callSettings = null)

Allows customers to perform maintenance on a reservation block

Parameters
Name Description
request PerformMaintenanceReservationBlockRequest

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.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.Create();
// Initialize request argument(s)
PerformMaintenanceReservationBlockRequest request = new PerformMaintenanceReservationBlockRequest
{
    Zone = "",
    RequestId = "",
    Reservation = "",
    Project = "",
    ReservationsBlocksPerformMaintenanceRequestResource = new ReservationsBlocksPerformMaintenanceRequest(),
    ReservationBlock = "",
};
// Make the request
lro::Operation<Operation, Operation> response = reservationBlocksClient.PerformMaintenance(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = reservationBlocksClient.PollOncePerformMaintenance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PerformMaintenance(string, string, string, string, ReservationsBlocksPerformMaintenanceRequest, CallSettings)

public virtual Operation<Operation, Operation> PerformMaintenance(string project, string zone, string reservation, string reservationBlock, ReservationsBlocksPerformMaintenanceRequest reservationsBlocksPerformMaintenanceRequestResource, CallSettings callSettings = null)

Allows customers to perform maintenance on a reservation block

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request. Zone name should conform to RFC1035.

reservation string

The name of the reservation. Name should conform to RFC1035 or be a resource ID.

reservationBlock string

The name of the reservation block. Name should conform to RFC1035 or be a resource ID.

reservationsBlocksPerformMaintenanceRequestResource ReservationsBlocksPerformMaintenanceRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = ReservationBlocksClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string reservation = "";
string reservationBlock = "";
ReservationsBlocksPerformMaintenanceRequest reservationsBlocksPerformMaintenanceRequestResource = new ReservationsBlocksPerformMaintenanceRequest();
// Make the request
lro::Operation<Operation, Operation> response = reservationBlocksClient.PerformMaintenance(project, zone, reservation, reservationBlock, reservationsBlocksPerformMaintenanceRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = reservationBlocksClient.PollOncePerformMaintenance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PerformMaintenanceAsync(PerformMaintenanceReservationBlockRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> PerformMaintenanceAsync(PerformMaintenanceReservationBlockRequest request, CallSettings callSettings = null)

Allows customers to perform maintenance on a reservation block

Parameters
Name Description
request PerformMaintenanceReservationBlockRequest

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.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = await ReservationBlocksClient.CreateAsync();
// Initialize request argument(s)
PerformMaintenanceReservationBlockRequest request = new PerformMaintenanceReservationBlockRequest
{
    Zone = "",
    RequestId = "",
    Reservation = "",
    Project = "",
    ReservationsBlocksPerformMaintenanceRequestResource = new ReservationsBlocksPerformMaintenanceRequest(),
    ReservationBlock = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await reservationBlocksClient.PerformMaintenanceAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await reservationBlocksClient.PollOncePerformMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PerformMaintenanceAsync(PerformMaintenanceReservationBlockRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PerformMaintenanceAsync(PerformMaintenanceReservationBlockRequest request, CancellationToken cancellationToken)

Allows customers to perform maintenance on a reservation block

Parameters
Name Description
request PerformMaintenanceReservationBlockRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = await ReservationBlocksClient.CreateAsync();
// Initialize request argument(s)
PerformMaintenanceReservationBlockRequest request = new PerformMaintenanceReservationBlockRequest
{
    Zone = "",
    RequestId = "",
    Reservation = "",
    Project = "",
    ReservationsBlocksPerformMaintenanceRequestResource = new ReservationsBlocksPerformMaintenanceRequest(),
    ReservationBlock = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await reservationBlocksClient.PerformMaintenanceAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await reservationBlocksClient.PollOncePerformMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PerformMaintenanceAsync(string, string, string, string, ReservationsBlocksPerformMaintenanceRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> PerformMaintenanceAsync(string project, string zone, string reservation, string reservationBlock, ReservationsBlocksPerformMaintenanceRequest reservationsBlocksPerformMaintenanceRequestResource, CallSettings callSettings = null)

Allows customers to perform maintenance on a reservation block

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request. Zone name should conform to RFC1035.

reservation string

The name of the reservation. Name should conform to RFC1035 or be a resource ID.

reservationBlock string

The name of the reservation block. Name should conform to RFC1035 or be a resource ID.

reservationsBlocksPerformMaintenanceRequestResource ReservationsBlocksPerformMaintenanceRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = await ReservationBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string reservation = "";
string reservationBlock = "";
ReservationsBlocksPerformMaintenanceRequest reservationsBlocksPerformMaintenanceRequestResource = new ReservationsBlocksPerformMaintenanceRequest();
// Make the request
lro::Operation<Operation, Operation> response = await reservationBlocksClient.PerformMaintenanceAsync(project, zone, reservation, reservationBlock, reservationsBlocksPerformMaintenanceRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await reservationBlocksClient.PollOncePerformMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PerformMaintenanceAsync(string, string, string, string, ReservationsBlocksPerformMaintenanceRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PerformMaintenanceAsync(string project, string zone, string reservation, string reservationBlock, ReservationsBlocksPerformMaintenanceRequest reservationsBlocksPerformMaintenanceRequestResource, CancellationToken cancellationToken)

Allows customers to perform maintenance on a reservation block

Parameters
Name Description
project string

Project ID for this request.

zone string

Name of the zone for this request. Zone name should conform to RFC1035.

reservation string

The name of the reservation. Name should conform to RFC1035 or be a resource ID.

reservationBlock string

The name of the reservation block. Name should conform to RFC1035 or be a resource ID.

reservationsBlocksPerformMaintenanceRequestResource ReservationsBlocksPerformMaintenanceRequest

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ReservationBlocksClient reservationBlocksClient = await ReservationBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string reservation = "";
string reservationBlock = "";
ReservationsBlocksPerformMaintenanceRequest reservationsBlocksPerformMaintenanceRequestResource = new ReservationsBlocksPerformMaintenanceRequest();
// Make the request
lro::Operation<Operation, Operation> response = await reservationBlocksClient.PerformMaintenanceAsync(project, zone, reservation, reservationBlock, reservationsBlocksPerformMaintenanceRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await reservationBlocksClient.PollOncePerformMaintenanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PollOncePerformMaintenance(string, CallSettings)

public virtual Operation<Operation, Operation> PollOncePerformMaintenance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of PerformMaintenance .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOncePerformMaintenanceAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOncePerformMaintenanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of PerformMaintenance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.