public abstract class ZonesClient
Zones client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The Zones API.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the Zones 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 Zones scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyList<String> |
The default Zones scopes are:
GrpcClient
public virtual Zones.ZonesClient GrpcClient { get; }
The underlying gRPC Zones client
Property Value | |
---|---|
Type | Description |
Zones.ZonesClient |
Methods
Create()
public static ZonesClient Create()
Synchronously creates a ZonesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ZonesClientBuilder.
Returns | |
---|---|
Type | Description |
ZonesClient | The created ZonesClient. |
CreateAsync(CancellationToken)
public static Task<ZonesClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a ZonesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ZonesClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
Task<ZonesClient> | The task representing the created ZonesClient. |
Get(GetZoneRequest, CallSettings)
public virtual Zone Get(GetZoneRequest request, CallSettings callSettings = null)
Returns the specified Zone resource. Gets a list of available zones by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetZoneRequest 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 |
Zone | The RPC response. |
// Create client
ZonesClient zonesClient = ZonesClient.Create();
// Initialize request argument(s)
GetZoneRequest request = new GetZoneRequest
{
Zone = "",
Project = "",
};
// Make the request
Zone response = zonesClient.Get(request);
Get(String, String, CallSettings)
public virtual Zone Get(string project, string zone, CallSettings callSettings = null)
Returns the specified Zone resource. Gets a list of available zones by making a list() request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone resource to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Zone | The RPC response. |
// Create client
ZonesClient zonesClient = ZonesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
Zone response = zonesClient.Get(project, zone);
GetAsync(GetZoneRequest, CallSettings)
public virtual Task<Zone> GetAsync(GetZoneRequest request, CallSettings callSettings = null)
Returns the specified Zone resource. Gets a list of available zones by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetZoneRequest 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 |
Task<Zone> | A Task containing the RPC response. |
// Create client
ZonesClient zonesClient = await ZonesClient.CreateAsync();
// Initialize request argument(s)
GetZoneRequest request = new GetZoneRequest
{
Zone = "",
Project = "",
};
// Make the request
Zone response = await zonesClient.GetAsync(request);
GetAsync(GetZoneRequest, CancellationToken)
public virtual Task<Zone> GetAsync(GetZoneRequest request, CancellationToken cancellationToken)
Returns the specified Zone resource. Gets a list of available zones by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetZoneRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Zone> | A Task containing the RPC response. |
// Create client
ZonesClient zonesClient = await ZonesClient.CreateAsync();
// Initialize request argument(s)
GetZoneRequest request = new GetZoneRequest
{
Zone = "",
Project = "",
};
// Make the request
Zone response = await zonesClient.GetAsync(request);
GetAsync(String, String, CallSettings)
public virtual Task<Zone> GetAsync(string project, string zone, CallSettings callSettings = null)
Returns the specified Zone resource. Gets a list of available zones by making a list() request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone resource to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Zone> | A Task containing the RPC response. |
// Create client
ZonesClient zonesClient = await ZonesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
Zone response = await zonesClient.GetAsync(project, zone);
GetAsync(String, String, CancellationToken)
public virtual Task<Zone> GetAsync(string project, string zone, CancellationToken cancellationToken)
Returns the specified Zone resource. Gets a list of available zones by making a list() request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone resource to return. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Zone> | A Task containing the RPC response. |
// Create client
ZonesClient zonesClient = await ZonesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
Zone response = await zonesClient.GetAsync(project, zone);
List(ListZonesRequest, CallSettings)
public virtual PagedEnumerable<ZoneList, Zone> List(ListZonesRequest request, CallSettings callSettings = null)
Retrieves the list of Zone resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request | ListZonesRequest 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 |
PagedEnumerable<ZoneList, Zone> | A pageable sequence of Zone resources. |
// Create client
ZonesClient zonesClient = ZonesClient.Create();
// Initialize request argument(s)
ListZonesRequest request = new ListZonesRequest
{
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<ZoneList, Zone> response = zonesClient.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, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ZoneList, Zone> List(string project, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Retrieves the list of Zone resources available to the specified project.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ZoneList, Zone> | A pageable sequence of Zone resources. |
// Create client
ZonesClient zonesClient = ZonesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<ZoneList, Zone> response = zonesClient.List(project);
// 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(ListZonesRequest, CallSettings)
public virtual PagedAsyncEnumerable<ZoneList, Zone> ListAsync(ListZonesRequest request, CallSettings callSettings = null)
Retrieves the list of Zone resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request | ListZonesRequest 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 |
PagedAsyncEnumerable<ZoneList, Zone> | A pageable asynchronous sequence of Zone resources. |
// Create client
ZonesClient zonesClient = await ZonesClient.CreateAsync();
// Initialize request argument(s)
ListZonesRequest request = new ListZonesRequest
{
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<ZoneList, Zone> response = zonesClient.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, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ZoneList, Zone> ListAsync(string project, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Retrieves the list of Zone resources available to the specified project.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ZoneList, Zone> | A pageable asynchronous sequence of Zone resources. |
// Create client
ZonesClient zonesClient = await ZonesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<ZoneList, Zone> response = zonesClient.ListAsync(project);
// 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. |
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.