Compute Engine v1 API - Class RegionOperationsClient (2.7.0)

public abstract class RegionOperationsClient

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

RegionOperations client wrapper, for convenient use.

Inheritance

object > RegionOperationsClient

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RegionOperations API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default RegionOperations scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

GrpcClient

public virtual RegionOperations.RegionOperationsClient GrpcClient { get; }

The underlying gRPC RegionOperations client

Property Value
TypeDescription
RegionOperationsRegionOperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

Methods

Create()

public static RegionOperationsClient Create()

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

Returns
TypeDescription
RegionOperationsClient

The created RegionOperationsClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskRegionOperationsClient

The task representing the created RegionOperationsClient.

Delete(DeleteRegionOperationRequest, CallSettings)

public virtual DeleteRegionOperationResponse Delete(DeleteRegionOperationRequest request, CallSettings callSettings = null)

Deletes the specified region-specific Operations resource.

Parameters
NameDescription
requestDeleteRegionOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
DeleteRegionOperationResponse

The RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = RegionOperationsClient.Create();
// Initialize request argument(s)
DeleteRegionOperationRequest request = new DeleteRegionOperationRequest
{
    Operation = "",
    Region = "",
    Project = "",
};
// Make the request
DeleteRegionOperationResponse response = regionOperationsClient.Delete(request);

Delete(string, string, string, CallSettings)

public virtual DeleteRegionOperationResponse Delete(string project, string region, string operation, CallSettings callSettings = null)

Deletes the specified region-specific Operations resource.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

operationstring

Name of the Operations resource to delete.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
DeleteRegionOperationResponse

The RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = RegionOperationsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string operation = "";
// Make the request
DeleteRegionOperationResponse response = regionOperationsClient.Delete(project, region, operation);

DeleteAsync(DeleteRegionOperationRequest, CallSettings)

public virtual Task<DeleteRegionOperationResponse> DeleteAsync(DeleteRegionOperationRequest request, CallSettings callSettings = null)

Deletes the specified region-specific Operations resource.

Parameters
NameDescription
requestDeleteRegionOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskDeleteRegionOperationResponse

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
DeleteRegionOperationRequest request = new DeleteRegionOperationRequest
{
    Operation = "",
    Region = "",
    Project = "",
};
// Make the request
DeleteRegionOperationResponse response = await regionOperationsClient.DeleteAsync(request);

DeleteAsync(DeleteRegionOperationRequest, CancellationToken)

public virtual Task<DeleteRegionOperationResponse> DeleteAsync(DeleteRegionOperationRequest request, CancellationToken cancellationToken)

Deletes the specified region-specific Operations resource.

Parameters
NameDescription
requestDeleteRegionOperationRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskDeleteRegionOperationResponse

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
DeleteRegionOperationRequest request = new DeleteRegionOperationRequest
{
    Operation = "",
    Region = "",
    Project = "",
};
// Make the request
DeleteRegionOperationResponse response = await regionOperationsClient.DeleteAsync(request);

DeleteAsync(string, string, string, CallSettings)

public virtual Task<DeleteRegionOperationResponse> DeleteAsync(string project, string region, string operation, CallSettings callSettings = null)

Deletes the specified region-specific Operations resource.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

operationstring

Name of the Operations resource to delete.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskDeleteRegionOperationResponse

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string operation = "";
// Make the request
DeleteRegionOperationResponse response = await regionOperationsClient.DeleteAsync(project, region, operation);

DeleteAsync(string, string, string, CancellationToken)

public virtual Task<DeleteRegionOperationResponse> DeleteAsync(string project, string region, string operation, CancellationToken cancellationToken)

Deletes the specified region-specific Operations resource.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

operationstring

Name of the Operations resource to delete.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskDeleteRegionOperationResponse

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string operation = "";
// Make the request
DeleteRegionOperationResponse response = await regionOperationsClient.DeleteAsync(project, region, operation);

Get(GetRegionOperationRequest, CallSettings)

public virtual Operation Get(GetRegionOperationRequest request, CallSettings callSettings = null)

Retrieves the specified region-specific Operations resource.

Parameters
NameDescription
requestGetRegionOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = RegionOperationsClient.Create();
// Initialize request argument(s)
GetRegionOperationRequest request = new GetRegionOperationRequest
{
    Operation = "",
    Region = "",
    Project = "",
};
// Make the request
Operation response = regionOperationsClient.Get(request);

Get(string, string, string, CallSettings)

public virtual Operation Get(string project, string region, string operation, CallSettings callSettings = null)

Retrieves the specified region-specific Operations resource.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

operationstring

Name of the Operations resource to return.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = RegionOperationsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string operation = "";
// Make the request
Operation response = regionOperationsClient.Get(project, region, operation);

GetAsync(GetRegionOperationRequest, CallSettings)

public virtual Task<Operation> GetAsync(GetRegionOperationRequest request, CallSettings callSettings = null)

Retrieves the specified region-specific Operations resource.

Parameters
NameDescription
requestGetRegionOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperation

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
GetRegionOperationRequest request = new GetRegionOperationRequest
{
    Operation = "",
    Region = "",
    Project = "",
};
// Make the request
Operation response = await regionOperationsClient.GetAsync(request);

GetAsync(GetRegionOperationRequest, CancellationToken)

public virtual Task<Operation> GetAsync(GetRegionOperationRequest request, CancellationToken cancellationToken)

Retrieves the specified region-specific Operations resource.

Parameters
NameDescription
requestGetRegionOperationRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperation

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
GetRegionOperationRequest request = new GetRegionOperationRequest
{
    Operation = "",
    Region = "",
    Project = "",
};
// Make the request
Operation response = await regionOperationsClient.GetAsync(request);

GetAsync(string, string, string, CallSettings)

public virtual Task<Operation> GetAsync(string project, string region, string operation, CallSettings callSettings = null)

Retrieves the specified region-specific Operations resource.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

operationstring

Name of the Operations resource to return.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperation

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string operation = "";
// Make the request
Operation response = await regionOperationsClient.GetAsync(project, region, operation);

GetAsync(string, string, string, CancellationToken)

public virtual Task<Operation> GetAsync(string project, string region, string operation, CancellationToken cancellationToken)

Retrieves the specified region-specific Operations resource.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

operationstring

Name of the Operations resource to return.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperation

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string operation = "";
// Make the request
Operation response = await regionOperationsClient.GetAsync(project, region, operation);

List(ListRegionOperationsRequest, CallSettings)

public virtual PagedEnumerable<OperationList, Operation> List(ListRegionOperationsRequest request, CallSettings callSettings = null)

Retrieves a list of Operation resources contained within the specified region.

Parameters
NameDescription
requestListRegionOperationsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableOperationListOperation

A pageable sequence of Operation resources.

Example
// Create client
RegionOperationsClient regionOperationsClient = RegionOperationsClient.Create();
// Initialize request argument(s)
ListRegionOperationsRequest request = new ListRegionOperationsRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<OperationList, Operation> response = regionOperationsClient.List(request);

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

public virtual PagedEnumerable<OperationList, Operation> List(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of Operation resources contained within the specified region.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

pageTokenstring

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

pageSizeint

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableOperationListOperation

A pageable sequence of Operation resources.

Example
// Create client
RegionOperationsClient regionOperationsClient = RegionOperationsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<OperationList, Operation> response = regionOperationsClient.List(project, region);

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

public virtual PagedAsyncEnumerable<OperationList, Operation> ListAsync(ListRegionOperationsRequest request, CallSettings callSettings = null)

Retrieves a list of Operation resources contained within the specified region.

Parameters
NameDescription
requestListRegionOperationsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableOperationListOperation

A pageable asynchronous sequence of Operation resources.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
ListRegionOperationsRequest request = new ListRegionOperationsRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<OperationList, Operation> response = regionOperationsClient.ListAsync(request);

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

public virtual PagedAsyncEnumerable<OperationList, Operation> ListAsync(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of Operation resources contained within the specified region.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

pageTokenstring

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

pageSizeint

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableOperationListOperation

A pageable asynchronous sequence of Operation resources.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<OperationList, Operation> response = regionOperationsClient.ListAsync(project, region);

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

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
TypeDescription
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.

Wait(WaitRegionOperationRequest, CallSettings)

public virtual Operation Wait(WaitRegionOperationRequest request, CallSettings callSettings = null)

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

Parameters
NameDescription
requestWaitRegionOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = RegionOperationsClient.Create();
// Initialize request argument(s)
WaitRegionOperationRequest request = new WaitRegionOperationRequest
{
    Operation = "",
    Region = "",
    Project = "",
};
// Make the request
Operation response = regionOperationsClient.Wait(request);

Wait(string, string, string, CallSettings)

public virtual Operation Wait(string project, string region, string operation, CallSettings callSettings = null)

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

operationstring

Name of the Operations resource to return.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = RegionOperationsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string operation = "";
// Make the request
Operation response = regionOperationsClient.Wait(project, region, operation);

WaitAsync(WaitRegionOperationRequest, CallSettings)

public virtual Task<Operation> WaitAsync(WaitRegionOperationRequest request, CallSettings callSettings = null)

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

Parameters
NameDescription
requestWaitRegionOperationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperation

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
WaitRegionOperationRequest request = new WaitRegionOperationRequest
{
    Operation = "",
    Region = "",
    Project = "",
};
// Make the request
Operation response = await regionOperationsClient.WaitAsync(request);

WaitAsync(WaitRegionOperationRequest, CancellationToken)

public virtual Task<Operation> WaitAsync(WaitRegionOperationRequest request, CancellationToken cancellationToken)

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

Parameters
NameDescription
requestWaitRegionOperationRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperation

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
WaitRegionOperationRequest request = new WaitRegionOperationRequest
{
    Operation = "",
    Region = "",
    Project = "",
};
// Make the request
Operation response = await regionOperationsClient.WaitAsync(request);

WaitAsync(string, string, string, CallSettings)

public virtual Task<Operation> WaitAsync(string project, string region, string operation, CallSettings callSettings = null)

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

operationstring

Name of the Operations resource to return.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperation

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string operation = "";
// Make the request
Operation response = await regionOperationsClient.WaitAsync(project, region, operation);

WaitAsync(string, string, string, CancellationToken)

public virtual Task<Operation> WaitAsync(string project, string region, string operation, CancellationToken cancellationToken)

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

operationstring

Name of the Operations resource to return.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperation

A Task containing the RPC response.

Example
// Create client
RegionOperationsClient regionOperationsClient = await RegionOperationsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string operation = "";
// Make the request
Operation response = await regionOperationsClient.WaitAsync(project, region, operation);