public abstract class DiskTypesClient
DiskTypes client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The DiskTypes API.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the DiskTypes 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 DiskTypes scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyList<String> |
The default DiskTypes scopes are:
GrpcClient
public virtual DiskTypes.DiskTypesClient GrpcClient { get; }
The underlying gRPC DiskTypes client
Property Value | |
---|---|
Type | Description |
DiskTypes.DiskTypesClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
Methods
AggregatedList(AggregatedListDiskTypesRequest, CallSettings)
public virtual PagedEnumerable<DiskTypeAggregatedList, KeyValuePair<string, DiskTypesScopedList>> AggregatedList(AggregatedListDiskTypesRequest request, CallSettings callSettings = null)
Retrieves an aggregated list of disk types.
Parameters | |
---|---|
Name | Description |
request | AggregatedListDiskTypesRequest 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<DiskTypeAggregatedList, KeyValuePair<String, DiskTypesScopedList>> | A pageable sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
DiskTypesClient diskTypesClient = DiskTypesClient.Create();
// Initialize request argument(s)
AggregatedListDiskTypesRequest request = new AggregatedListDiskTypesRequest
{
OrderBy = "",
Project = "",
Filter = "",
IncludeAllScopes = false,
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<DiskTypeAggregatedList, KeyValuePair<string, DiskTypesScopedList>> response = diskTypesClient.AggregatedList(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, DiskTypesScopedList> 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 (DiskTypeAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, DiskTypesScopedList> 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<KeyValuePair<string, DiskTypesScopedList>> 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 (KeyValuePair<string, DiskTypesScopedList> 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;
AggregatedList(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<DiskTypeAggregatedList, KeyValuePair<string, DiskTypesScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves an aggregated list of disk types.
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<DiskTypeAggregatedList, KeyValuePair<String, DiskTypesScopedList>> | A pageable sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
DiskTypesClient diskTypesClient = DiskTypesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<DiskTypeAggregatedList, KeyValuePair<string, DiskTypesScopedList>> response = diskTypesClient.AggregatedList(project);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, DiskTypesScopedList> 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 (DiskTypeAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, DiskTypesScopedList> 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<KeyValuePair<string, DiskTypesScopedList>> 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 (KeyValuePair<string, DiskTypesScopedList> 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;
AggregatedListAsync(AggregatedListDiskTypesRequest, CallSettings)
public virtual PagedAsyncEnumerable<DiskTypeAggregatedList, KeyValuePair<string, DiskTypesScopedList>> AggregatedListAsync(AggregatedListDiskTypesRequest request, CallSettings callSettings = null)
Retrieves an aggregated list of disk types.
Parameters | |
---|---|
Name | Description |
request | AggregatedListDiskTypesRequest 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<DiskTypeAggregatedList, KeyValuePair<String, DiskTypesScopedList>> | A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
DiskTypesClient diskTypesClient = await DiskTypesClient.CreateAsync();
// Initialize request argument(s)
AggregatedListDiskTypesRequest request = new AggregatedListDiskTypesRequest
{
OrderBy = "",
Project = "",
Filter = "",
IncludeAllScopes = false,
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<DiskTypeAggregatedList, KeyValuePair<string, DiskTypesScopedList>> response = diskTypesClient.AggregatedListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, DiskTypesScopedList> 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((DiskTypeAggregatedList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, DiskTypesScopedList> 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<KeyValuePair<string, DiskTypesScopedList>> 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 (KeyValuePair<string, DiskTypesScopedList> 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;
AggregatedListAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<DiskTypeAggregatedList, KeyValuePair<string, DiskTypesScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves an aggregated list of disk types.
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<DiskTypeAggregatedList, KeyValuePair<String, DiskTypesScopedList>> | A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
DiskTypesClient diskTypesClient = await DiskTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<DiskTypeAggregatedList, KeyValuePair<string, DiskTypesScopedList>> response = diskTypesClient.AggregatedListAsync(project);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, DiskTypesScopedList> 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((DiskTypeAggregatedList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, DiskTypesScopedList> 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<KeyValuePair<string, DiskTypesScopedList>> 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 (KeyValuePair<string, DiskTypesScopedList> 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;
Create()
public static DiskTypesClient Create()
Synchronously creates a DiskTypesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DiskTypesClientBuilder.
Returns | |
---|---|
Type | Description |
DiskTypesClient | The created DiskTypesClient. |
CreateAsync(CancellationToken)
public static Task<DiskTypesClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a DiskTypesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DiskTypesClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
Task<DiskTypesClient> | The task representing the created DiskTypesClient. |
Get(GetDiskTypeRequest, CallSettings)
public virtual DiskType Get(GetDiskTypeRequest request, CallSettings callSettings = null)
Returns the specified disk type. Gets a list of available disk types by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetDiskTypeRequest 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 |
DiskType | The RPC response. |
// Create client
DiskTypesClient diskTypesClient = DiskTypesClient.Create();
// Initialize request argument(s)
GetDiskTypeRequest request = new GetDiskTypeRequest
{
Zone = "",
DiskType = "",
Project = "",
};
// Make the request
DiskType response = diskTypesClient.Get(request);
Get(String, String, String, CallSettings)
public virtual DiskType Get(string project, string zone, string diskType, CallSettings callSettings = null)
Returns the specified disk type. Gets a list of available disk types by making a list() request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone for this request. |
diskType | String Name of the disk type to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DiskType | The RPC response. |
// Create client
DiskTypesClient diskTypesClient = DiskTypesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string diskType = "";
// Make the request
DiskType response = diskTypesClient.Get(project, zone, diskType);
GetAsync(GetDiskTypeRequest, CallSettings)
public virtual Task<DiskType> GetAsync(GetDiskTypeRequest request, CallSettings callSettings = null)
Returns the specified disk type. Gets a list of available disk types by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetDiskTypeRequest 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<DiskType> | A Task containing the RPC response. |
// Create client
DiskTypesClient diskTypesClient = await DiskTypesClient.CreateAsync();
// Initialize request argument(s)
GetDiskTypeRequest request = new GetDiskTypeRequest
{
Zone = "",
DiskType = "",
Project = "",
};
// Make the request
DiskType response = await diskTypesClient.GetAsync(request);
GetAsync(GetDiskTypeRequest, CancellationToken)
public virtual Task<DiskType> GetAsync(GetDiskTypeRequest request, CancellationToken cancellationToken)
Returns the specified disk type. Gets a list of available disk types by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetDiskTypeRequest 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<DiskType> | A Task containing the RPC response. |
// Create client
DiskTypesClient diskTypesClient = await DiskTypesClient.CreateAsync();
// Initialize request argument(s)
GetDiskTypeRequest request = new GetDiskTypeRequest
{
Zone = "",
DiskType = "",
Project = "",
};
// Make the request
DiskType response = await diskTypesClient.GetAsync(request);
GetAsync(String, String, String, CallSettings)
public virtual Task<DiskType> GetAsync(string project, string zone, string diskType, CallSettings callSettings = null)
Returns the specified disk type. Gets a list of available disk types by making a list() request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone for this request. |
diskType | String Name of the disk type to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<DiskType> | A Task containing the RPC response. |
// Create client
DiskTypesClient diskTypesClient = await DiskTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string diskType = "";
// Make the request
DiskType response = await diskTypesClient.GetAsync(project, zone, diskType);
GetAsync(String, String, String, CancellationToken)
public virtual Task<DiskType> GetAsync(string project, string zone, string diskType, CancellationToken cancellationToken)
Returns the specified disk type. Gets a list of available disk types by making a list() request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone for this request. |
diskType | String Name of the disk type to return. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<DiskType> | A Task containing the RPC response. |
// Create client
DiskTypesClient diskTypesClient = await DiskTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string diskType = "";
// Make the request
DiskType response = await diskTypesClient.GetAsync(project, zone, diskType);
List(ListDiskTypesRequest, CallSettings)
public virtual PagedEnumerable<DiskTypeList, DiskType> List(ListDiskTypesRequest request, CallSettings callSettings = null)
Retrieves a list of disk types available to the specified project.
Parameters | |
---|---|
Name | Description |
request | ListDiskTypesRequest 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<DiskTypeList, DiskType> | A pageable sequence of DiskType resources. |
// Create client
DiskTypesClient diskTypesClient = DiskTypesClient.Create();
// Initialize request argument(s)
ListDiskTypesRequest request = new ListDiskTypesRequest
{
Zone = "",
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<DiskTypeList, DiskType> response = diskTypesClient.List(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (DiskType 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 (DiskTypeList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (DiskType 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<DiskType> 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 (DiskType 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, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<DiskTypeList, DiskType> List(string project, string zone, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves a list of disk types available to the specified project.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone 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<DiskTypeList, DiskType> | A pageable sequence of DiskType resources. |
// Create client
DiskTypesClient diskTypesClient = DiskTypesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
PagedEnumerable<DiskTypeList, DiskType> response = diskTypesClient.List(project, zone);
// Iterate over all response items, lazily performing RPCs as required
foreach (DiskType 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 (DiskTypeList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (DiskType 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<DiskType> 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 (DiskType 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(ListDiskTypesRequest, CallSettings)
public virtual PagedAsyncEnumerable<DiskTypeList, DiskType> ListAsync(ListDiskTypesRequest request, CallSettings callSettings = null)
Retrieves a list of disk types available to the specified project.
Parameters | |
---|---|
Name | Description |
request | ListDiskTypesRequest 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<DiskTypeList, DiskType> | A pageable asynchronous sequence of DiskType resources. |
// Create client
DiskTypesClient diskTypesClient = await DiskTypesClient.CreateAsync();
// Initialize request argument(s)
ListDiskTypesRequest request = new ListDiskTypesRequest
{
Zone = "",
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<DiskTypeList, DiskType> response = diskTypesClient.ListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DiskType 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((DiskTypeList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (DiskType 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<DiskType> 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 (DiskType 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, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<DiskTypeList, DiskType> ListAsync(string project, string zone, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves a list of disk types available to the specified project.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
zone | String The name of the zone 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<DiskTypeList, DiskType> | A pageable asynchronous sequence of DiskType resources. |
// Create client
DiskTypesClient diskTypesClient = await DiskTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
PagedAsyncEnumerable<DiskTypeList, DiskType> response = diskTypesClient.ListAsync(project, zone);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DiskType 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((DiskTypeList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (DiskType 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<DiskType> 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 (DiskType 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.