Compute Engine v1 API - Class RegionZonesClient (2.17.0)

public abstract class RegionZonesClient

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

RegionZones client wrapper, for convenient use.

Inheritance

object > RegionZonesClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

RegionZonesClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RegionZones API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
`IReadOnlyListstring`

Remarks

The default RegionZones scopes are:

GrpcClient

public virtual RegionZones.RegionZonesClient GrpcClient { get; }

The underlying gRPC RegionZones client

Property Value
Type	Description
`RegionZonesRegionZonesClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

Methods

Create()

public static RegionZonesClient Create()

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

Returns
Type	Description
`RegionZonesClient`	The created RegionZonesClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`TaskRegionZonesClient`	The task representing the created RegionZonesClient.

List(ListRegionZonesRequest, CallSettings)

public virtual PagedEnumerable<ZoneList, Zone> List(ListRegionZonesRequest request, CallSettings callSettings = null)

Retrieves the list of Zone resources under the specific region available to the specified project.

Parameters
Name	Description
`request`	`ListRegionZonesRequest` 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
`PagedEnumerableZoneListZone`	A pageable sequence of Zone resources.

Example

// Create client
RegionZonesClient regionZonesClient = RegionZonesClient.Create();
// Initialize request argument(s)
ListRegionZonesRequest request = new ListRegionZonesRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<ZoneList, Zone> response = regionZonesClient.List(request);

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

Retrieves the list of Zone resources under the specific region available to the specified project.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Region for this request.
`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
`PagedEnumerableZoneListZone`	A pageable sequence of Zone resources.

Example

// Create client
RegionZonesClient regionZonesClient = RegionZonesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<ZoneList, Zone> response = regionZonesClient.List(project, region);

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

public virtual PagedAsyncEnumerable<ZoneList, Zone> ListAsync(ListRegionZonesRequest request, CallSettings callSettings = null)

Retrieves the list of Zone resources under the specific region available to the specified project.

Parameters
Name	Description
`request`	`ListRegionZonesRequest` 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
`PagedAsyncEnumerableZoneListZone`	A pageable asynchronous sequence of Zone resources.

Example

// Create client
RegionZonesClient regionZonesClient = await RegionZonesClient.CreateAsync();
// Initialize request argument(s)
ListRegionZonesRequest request = new ListRegionZonesRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<ZoneList, Zone> response = regionZonesClient.ListAsync(request);

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

Retrieves the list of Zone resources under the specific region available to the specified project.

Parameters
Name	Description
`project`	`string` Project ID for this request.
`region`	`string` Region for this request.
`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
`PagedAsyncEnumerableZoneListZone`	A pageable asynchronous sequence of Zone resources.

Example

// Create client
RegionZonesClient regionZonesClient = await RegionZonesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<ZoneList, Zone> response = regionZonesClient.ListAsync(project, region);

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