Compute Engine v1 API - Class ReservationSubBlocksClient (3.18.0) 

public abstract class ReservationSubBlocksClient

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

ReservationSubBlocks client wrapper, for convenient use.

Inheritance

object > ReservationSubBlocksClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The ReservationSubBlocks API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ReservationSubBlocks 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 ReservationSubBlocks scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default ReservationSubBlocks scopes are:

GrpcClient

public virtual ReservationSubBlocks.ReservationSubBlocksClient GrpcClient { get; }

The underlying gRPC ReservationSubBlocks client

Property Value
Type Description
ReservationSubBlocksReservationSubBlocksClient

PerformMaintenanceOperationsClient

public virtual OperationsClient PerformMaintenanceOperationsClient { get; }

The long-running operations client for PerformMaintenance.

Property Value
Type Description
OperationsClient

ReportFaultyOperationsClient

public virtual OperationsClient ReportFaultyOperationsClient { get; }

The long-running operations client for ReportFaulty.

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 ReservationSubBlocksClient Create()

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

Returns
Type Description
ReservationSubBlocksClient

The created ReservationSubBlocksClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskReservationSubBlocksClient

The task representing the created ReservationSubBlocksClient.

Get(GetReservationSubBlockRequest, CallSettings)

public virtual ReservationSubBlocksGetResponse Get(GetReservationSubBlockRequest request, CallSettings callSettings = null)

Retrieves information about the specified reservation subBlock.

Parameters
Name Description
request GetReservationSubBlockRequest

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
ReservationSubBlocksGetResponse

The RPC response.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = ReservationSubBlocksClient.Create();
// Initialize request argument(s)
GetReservationSubBlockRequest request = new GetReservationSubBlockRequest
{
    Zone = "",
    ReservationSubBlock = "",
    Project = "",
    ParentName = "",
};
// Make the request
ReservationSubBlocksGetResponse response = reservationSubBlocksClient.Get(request);

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

public virtual ReservationSubBlocksGetResponse Get(string project, string zone, string parentName, string reservationSubBlock, CallSettings callSettings = null)

Retrieves information about the specified reservation subBlock.

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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
reservationSubBlock string

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

If not null, applies overrides to this RPC call.
Returns
Type Description
ReservationSubBlocksGetResponse

The RPC response.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = ReservationSubBlocksClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
string reservationSubBlock = "";
// Make the request
ReservationSubBlocksGetResponse response = reservationSubBlocksClient.Get(project, zone, parentName, reservationSubBlock);

GetAsync(GetReservationSubBlockRequest, CallSettings)

public virtual Task<ReservationSubBlocksGetResponse> GetAsync(GetReservationSubBlockRequest request, CallSettings callSettings = null)

Retrieves information about the specified reservation subBlock.

Parameters
Name Description
request GetReservationSubBlockRequest

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
TaskReservationSubBlocksGetResponse

A Task containing the RPC response.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
GetReservationSubBlockRequest request = new GetReservationSubBlockRequest
{
    Zone = "",
    ReservationSubBlock = "",
    Project = "",
    ParentName = "",
};
// Make the request
ReservationSubBlocksGetResponse response = await reservationSubBlocksClient.GetAsync(request);

GetAsync(GetReservationSubBlockRequest, CancellationToken)

public virtual Task<ReservationSubBlocksGetResponse> GetAsync(GetReservationSubBlockRequest request, CancellationToken cancellationToken)

Retrieves information about the specified reservation subBlock.

Parameters
Name Description
request GetReservationSubBlockRequest

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskReservationSubBlocksGetResponse

A Task containing the RPC response.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
GetReservationSubBlockRequest request = new GetReservationSubBlockRequest
{
    Zone = "",
    ReservationSubBlock = "",
    Project = "",
    ParentName = "",
};
// Make the request
ReservationSubBlocksGetResponse response = await reservationSubBlocksClient.GetAsync(request);

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

public virtual Task<ReservationSubBlocksGetResponse> GetAsync(string project, string zone, string parentName, string reservationSubBlock, CallSettings callSettings = null)

Retrieves information about the specified reservation subBlock.

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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
reservationSubBlock string

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReservationSubBlocksGetResponse

A Task containing the RPC response.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
string reservationSubBlock = "";
// Make the request
ReservationSubBlocksGetResponse response = await reservationSubBlocksClient.GetAsync(project, zone, parentName, reservationSubBlock);

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

public virtual Task<ReservationSubBlocksGetResponse> GetAsync(string project, string zone, string parentName, string reservationSubBlock, CancellationToken cancellationToken)

Retrieves information about the specified reservation subBlock.

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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
reservationSubBlock string

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskReservationSubBlocksGetResponse

A Task containing the RPC response.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
string reservationSubBlock = "";
// Make the request
ReservationSubBlocksGetResponse response = await reservationSubBlocksClient.GetAsync(project, zone, parentName, reservationSubBlock);

List(ListReservationSubBlocksRequest, CallSettings)

public virtual PagedEnumerable<ReservationSubBlocksListResponse, ReservationSubBlock> List(ListReservationSubBlocksRequest request, CallSettings callSettings = null)

Retrieves a list of reservation subBlocks under a single reservation.

Parameters
Name Description
request ListReservationSubBlocksRequest

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
PagedEnumerableReservationSubBlocksListResponseReservationSubBlock

A pageable sequence of ReservationSubBlock resources.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = ReservationSubBlocksClient.Create();
// Initialize request argument(s)
ListReservationSubBlocksRequest request = new ListReservationSubBlocksRequest
{
    Zone = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ParentName = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<ReservationSubBlocksListResponse, ReservationSubBlock> response = reservationSubBlocksClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ReservationSubBlock 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 (ReservationSubBlocksListResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ReservationSubBlock 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<ReservationSubBlock> 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 (ReservationSubBlock 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<ReservationSubBlocksListResponse, ReservationSubBlock> List(string project, string zone, string parentName, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of reservation subBlocks 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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
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
PagedEnumerableReservationSubBlocksListResponseReservationSubBlock

A pageable sequence of ReservationSubBlock resources.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = ReservationSubBlocksClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
// Make the request
PagedEnumerable<ReservationSubBlocksListResponse, ReservationSubBlock> response = reservationSubBlocksClient.List(project, zone, parentName);

// Iterate over all response items, lazily performing RPCs as required
foreach (ReservationSubBlock 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 (ReservationSubBlocksListResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ReservationSubBlock 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<ReservationSubBlock> 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 (ReservationSubBlock 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(ListReservationSubBlocksRequest, CallSettings)

public virtual PagedAsyncEnumerable<ReservationSubBlocksListResponse, ReservationSubBlock> ListAsync(ListReservationSubBlocksRequest request, CallSettings callSettings = null)

Retrieves a list of reservation subBlocks under a single reservation.

Parameters
Name Description
request ListReservationSubBlocksRequest

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
PagedAsyncEnumerableReservationSubBlocksListResponseReservationSubBlock

A pageable asynchronous sequence of ReservationSubBlock resources.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
ListReservationSubBlocksRequest request = new ListReservationSubBlocksRequest
{
    Zone = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ParentName = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<ReservationSubBlocksListResponse, ReservationSubBlock> response = reservationSubBlocksClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ReservationSubBlock 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((ReservationSubBlocksListResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ReservationSubBlock 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<ReservationSubBlock> 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 (ReservationSubBlock 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<ReservationSubBlocksListResponse, ReservationSubBlock> ListAsync(string project, string zone, string parentName, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of reservation subBlocks 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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
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
PagedAsyncEnumerableReservationSubBlocksListResponseReservationSubBlock

A pageable asynchronous sequence of ReservationSubBlock resources.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
// Make the request
PagedAsyncEnumerable<ReservationSubBlocksListResponse, ReservationSubBlock> response = reservationSubBlocksClient.ListAsync(project, zone, parentName);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ReservationSubBlock 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((ReservationSubBlocksListResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ReservationSubBlock 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<ReservationSubBlock> 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 (ReservationSubBlock 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(PerformMaintenanceReservationSubBlockRequest, CallSettings)

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

Allows customers to perform maintenance on a reservation subBlock

Parameters
Name Description
request PerformMaintenanceReservationSubBlockRequest

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
ReservationSubBlocksClient reservationSubBlocksClient = ReservationSubBlocksClient.Create();
// Initialize request argument(s)
PerformMaintenanceReservationSubBlockRequest request = new PerformMaintenanceReservationSubBlockRequest
{
    Zone = "",
    ReservationSubBlock = "",
    RequestId = "",
    Project = "",
    ParentName = "",
};
// Make the request
lro::Operation<Operation, Operation> response = reservationSubBlocksClient.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 = reservationSubBlocksClient.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, CallSettings)

public virtual Operation<Operation, Operation> PerformMaintenance(string project, string zone, string parentName, string reservationSubBlock, CallSettings callSettings = null)

Allows customers to perform maintenance on a reservation subBlock

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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
reservationSubBlock string

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = ReservationSubBlocksClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
string reservationSubBlock = "";
// Make the request
lro::Operation<Operation, Operation> response = reservationSubBlocksClient.PerformMaintenance(project, zone, parentName, reservationSubBlock);

// 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 = reservationSubBlocksClient.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(PerformMaintenanceReservationSubBlockRequest, CallSettings)

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

Allows customers to perform maintenance on a reservation subBlock

Parameters
Name Description
request PerformMaintenanceReservationSubBlockRequest

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
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
PerformMaintenanceReservationSubBlockRequest request = new PerformMaintenanceReservationSubBlockRequest
{
    Zone = "",
    ReservationSubBlock = "",
    RequestId = "",
    Project = "",
    ParentName = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await reservationSubBlocksClient.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 reservationSubBlocksClient.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(PerformMaintenanceReservationSubBlockRequest, CancellationToken)

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

Allows customers to perform maintenance on a reservation subBlock

Parameters
Name Description
request PerformMaintenanceReservationSubBlockRequest

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
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
PerformMaintenanceReservationSubBlockRequest request = new PerformMaintenanceReservationSubBlockRequest
{
    Zone = "",
    ReservationSubBlock = "",
    RequestId = "",
    Project = "",
    ParentName = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await reservationSubBlocksClient.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 reservationSubBlocksClient.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, CallSettings)

public virtual Task<Operation<Operation, Operation>> PerformMaintenanceAsync(string project, string zone, string parentName, string reservationSubBlock, CallSettings callSettings = null)

Allows customers to perform maintenance on a reservation subBlock

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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
reservationSubBlock string

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
string reservationSubBlock = "";
// Make the request
lro::Operation<Operation, Operation> response = await reservationSubBlocksClient.PerformMaintenanceAsync(project, zone, parentName, reservationSubBlock);

// 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 reservationSubBlocksClient.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, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PerformMaintenanceAsync(string project, string zone, string parentName, string reservationSubBlock, CancellationToken cancellationToken)

Allows customers to perform maintenance on a reservation subBlock

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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
reservationSubBlock string

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Example 
// Create client
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
string reservationSubBlock = "";
// Make the request
lro::Operation<Operation, Operation> response = await reservationSubBlocksClient.PerformMaintenanceAsync(project, zone, parentName, reservationSubBlock);

// 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 reservationSubBlocksClient.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.

PollOnceReportFaulty(string, CallSettings)

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

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

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.

PollOnceReportFaultyAsync(string, CallSettings)

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

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

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.

ReportFaulty(ReportFaultyReservationSubBlockRequest, CallSettings)

public virtual Operation<Operation, Operation> ReportFaulty(ReportFaultyReservationSubBlockRequest request, CallSettings callSettings = null)

Allows customers to report a faulty subBlock.

Parameters
Name Description
request ReportFaultyReservationSubBlockRequest

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
ReservationSubBlocksClient reservationSubBlocksClient = ReservationSubBlocksClient.Create();
// Initialize request argument(s)
ReportFaultyReservationSubBlockRequest request = new ReportFaultyReservationSubBlockRequest
{
    Zone = "",
    ReservationSubBlock = "",
    RequestId = "",
    Project = "",
    ReservationSubBlocksReportFaultyRequestResource = new ReservationSubBlocksReportFaultyRequest(),
    ParentName = "",
};
// Make the request
lro::Operation<Operation, Operation> response = reservationSubBlocksClient.ReportFaulty(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 = reservationSubBlocksClient.PollOnceReportFaulty(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;
}

ReportFaulty(string, string, string, string, ReservationSubBlocksReportFaultyRequest, CallSettings)

public virtual Operation<Operation, Operation> ReportFaulty(string project, string zone, string parentName, string reservationSubBlock, ReservationSubBlocksReportFaultyRequest reservationSubBlocksReportFaultyRequestResource, CallSettings callSettings = null)

Allows customers to report a faulty subBlock.

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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
reservationSubBlock string

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

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
ReservationSubBlocksClient reservationSubBlocksClient = ReservationSubBlocksClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
string reservationSubBlock = "";
ReservationSubBlocksReportFaultyRequest reservationSubBlocksReportFaultyRequestResource = new ReservationSubBlocksReportFaultyRequest();
// Make the request
lro::Operation<Operation, Operation> response = reservationSubBlocksClient.ReportFaulty(project, zone, parentName, reservationSubBlock, reservationSubBlocksReportFaultyRequestResource);

// 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 = reservationSubBlocksClient.PollOnceReportFaulty(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;
}

ReportFaultyAsync(ReportFaultyReservationSubBlockRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> ReportFaultyAsync(ReportFaultyReservationSubBlockRequest request, CallSettings callSettings = null)

Allows customers to report a faulty subBlock.

Parameters
Name Description
request ReportFaultyReservationSubBlockRequest

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
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
ReportFaultyReservationSubBlockRequest request = new ReportFaultyReservationSubBlockRequest
{
    Zone = "",
    ReservationSubBlock = "",
    RequestId = "",
    Project = "",
    ReservationSubBlocksReportFaultyRequestResource = new ReservationSubBlocksReportFaultyRequest(),
    ParentName = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await reservationSubBlocksClient.ReportFaultyAsync(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 reservationSubBlocksClient.PollOnceReportFaultyAsync(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;
}

ReportFaultyAsync(ReportFaultyReservationSubBlockRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> ReportFaultyAsync(ReportFaultyReservationSubBlockRequest request, CancellationToken cancellationToken)

Allows customers to report a faulty subBlock.

Parameters
Name Description
request ReportFaultyReservationSubBlockRequest

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
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
ReportFaultyReservationSubBlockRequest request = new ReportFaultyReservationSubBlockRequest
{
    Zone = "",
    ReservationSubBlock = "",
    RequestId = "",
    Project = "",
    ReservationSubBlocksReportFaultyRequestResource = new ReservationSubBlocksReportFaultyRequest(),
    ParentName = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await reservationSubBlocksClient.ReportFaultyAsync(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 reservationSubBlocksClient.PollOnceReportFaultyAsync(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;
}

ReportFaultyAsync(string, string, string, string, ReservationSubBlocksReportFaultyRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> ReportFaultyAsync(string project, string zone, string parentName, string reservationSubBlock, ReservationSubBlocksReportFaultyRequest reservationSubBlocksReportFaultyRequestResource, CallSettings callSettings = null)

Allows customers to report a faulty subBlock.

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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
reservationSubBlock string

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

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
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
string reservationSubBlock = "";
ReservationSubBlocksReportFaultyRequest reservationSubBlocksReportFaultyRequestResource = new ReservationSubBlocksReportFaultyRequest();
// Make the request
lro::Operation<Operation, Operation> response = await reservationSubBlocksClient.ReportFaultyAsync(project, zone, parentName, reservationSubBlock, reservationSubBlocksReportFaultyRequestResource);

// 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 reservationSubBlocksClient.PollOnceReportFaultyAsync(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;
}

ReportFaultyAsync(string, string, string, string, ReservationSubBlocksReportFaultyRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> ReportFaultyAsync(string project, string zone, string parentName, string reservationSubBlock, ReservationSubBlocksReportFaultyRequest reservationSubBlocksReportFaultyRequestResource, CancellationToken cancellationToken)

Allows customers to report a faulty subBlock.

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.
parentName string

The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
reservationSubBlock string

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

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
ReservationSubBlocksClient reservationSubBlocksClient = await ReservationSubBlocksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string parentName = "";
string reservationSubBlock = "";
ReservationSubBlocksReportFaultyRequest reservationSubBlocksReportFaultyRequestResource = new ReservationSubBlocksReportFaultyRequest();
// Make the request
lro::Operation<Operation, Operation> response = await reservationSubBlocksClient.ReportFaultyAsync(project, zone, parentName, reservationSubBlock, reservationSubBlocksReportFaultyRequestResource);

// 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 reservationSubBlocksClient.PollOnceReportFaultyAsync(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;
}

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.