public abstract class MachineTypesClient
Reference documentation and code samples for the Compute Engine v1 API class MachineTypesClient.
MachineTypes client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The MachineTypes API.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the MachineTypes 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 MachineTypes scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default MachineTypes scopes are:
GrpcClient
public virtual MachineTypes.MachineTypesClient GrpcClient { get; }
The underlying gRPC MachineTypes client
Property Value | |
---|---|
Type | Description |
MachineTypesMachineTypesClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
Methods
AggregatedList(AggregatedListMachineTypesRequest, CallSettings)
public virtual PagedEnumerable<MachineTypeAggregatedList, KeyValuePair<string, MachineTypesScopedList>> AggregatedList(AggregatedListMachineTypesRequest request, CallSettings callSettings = null)
Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
request |
AggregatedListMachineTypesRequest 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 |
PagedEnumerableMachineTypeAggregatedListKeyValuePairstringMachineTypesScopedList |
A pageable sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
MachineTypesClient machineTypesClient = MachineTypesClient.Create();
// Initialize request argument(s)
AggregatedListMachineTypesRequest request = new AggregatedListMachineTypesRequest
{
OrderBy = "",
Project = "",
ServiceProjectNumber = 0L,
Filter = "",
IncludeAllScopes = false,
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<MachineTypeAggregatedList, KeyValuePair<string, MachineTypesScopedList>> response = machineTypesClient.AggregatedList(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, MachineTypesScopedList> 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 (MachineTypeAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, MachineTypesScopedList> 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, MachineTypesScopedList>> 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, MachineTypesScopedList> 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, int?, CallSettings)
public virtual PagedEnumerable<MachineTypeAggregatedList, KeyValuePair<string, MachineTypesScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int 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 |
PagedEnumerableMachineTypeAggregatedListKeyValuePairstringMachineTypesScopedList |
A pageable sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
MachineTypesClient machineTypesClient = MachineTypesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<MachineTypeAggregatedList, KeyValuePair<string, MachineTypesScopedList>> response = machineTypesClient.AggregatedList(project);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, MachineTypesScopedList> 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 (MachineTypeAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, MachineTypesScopedList> 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, MachineTypesScopedList>> 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, MachineTypesScopedList> 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(AggregatedListMachineTypesRequest, CallSettings)
public virtual PagedAsyncEnumerable<MachineTypeAggregatedList, KeyValuePair<string, MachineTypesScopedList>> AggregatedListAsync(AggregatedListMachineTypesRequest request, CallSettings callSettings = null)
Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
request |
AggregatedListMachineTypesRequest 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 |
PagedAsyncEnumerableMachineTypeAggregatedListKeyValuePairstringMachineTypesScopedList |
A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
MachineTypesClient machineTypesClient = await MachineTypesClient.CreateAsync();
// Initialize request argument(s)
AggregatedListMachineTypesRequest request = new AggregatedListMachineTypesRequest
{
OrderBy = "",
Project = "",
ServiceProjectNumber = 0L,
Filter = "",
IncludeAllScopes = false,
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<MachineTypeAggregatedList, KeyValuePair<string, MachineTypesScopedList>> response = machineTypesClient.AggregatedListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, MachineTypesScopedList> 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((MachineTypeAggregatedList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, MachineTypesScopedList> 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, MachineTypesScopedList>> 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, MachineTypesScopedList> 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, int?, CallSettings)
public virtual PagedAsyncEnumerable<MachineTypeAggregatedList, KeyValuePair<string, MachineTypesScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int 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 |
PagedAsyncEnumerableMachineTypeAggregatedListKeyValuePairstringMachineTypesScopedList |
A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
MachineTypesClient machineTypesClient = await MachineTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<MachineTypeAggregatedList, KeyValuePair<string, MachineTypesScopedList>> response = machineTypesClient.AggregatedListAsync(project);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, MachineTypesScopedList> 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((MachineTypeAggregatedList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, MachineTypesScopedList> 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, MachineTypesScopedList>> 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, MachineTypesScopedList> 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 MachineTypesClient Create()
Synchronously creates a MachineTypesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MachineTypesClientBuilder.
Returns | |
---|---|
Type | Description |
MachineTypesClient |
The created MachineTypesClient. |
CreateAsync(CancellationToken)
public static Task<MachineTypesClient> CreateAsync(CancellationToken cancellationToken = default)
Asynchronously creates a MachineTypesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MachineTypesClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken |
CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
TaskMachineTypesClient |
The task representing the created MachineTypesClient. |
Get(GetMachineTypeRequest, CallSettings)
public virtual MachineType Get(GetMachineTypeRequest request, CallSettings callSettings = null)
Returns the specified machine type.
Parameters | |
---|---|
Name | Description |
request |
GetMachineTypeRequest 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 |
MachineType |
The RPC response. |
// Create client
MachineTypesClient machineTypesClient = MachineTypesClient.Create();
// Initialize request argument(s)
GetMachineTypeRequest request = new GetMachineTypeRequest
{
Zone = "",
Project = "",
MachineType = "",
};
// Make the request
MachineType response = machineTypesClient.Get(request);
Get(string, string, string, CallSettings)
public virtual MachineType Get(string project, string zone, string machineType, CallSettings callSettings = null)
Returns the specified machine type.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
zone |
string The name of the zone for this request. |
machineType |
string Name of the machine type to return. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
MachineType |
The RPC response. |
// Create client
MachineTypesClient machineTypesClient = MachineTypesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string machineType = "";
// Make the request
MachineType response = machineTypesClient.Get(project, zone, machineType);
GetAsync(GetMachineTypeRequest, CallSettings)
public virtual Task<MachineType> GetAsync(GetMachineTypeRequest request, CallSettings callSettings = null)
Returns the specified machine type.
Parameters | |
---|---|
Name | Description |
request |
GetMachineTypeRequest 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 |
TaskMachineType |
A Task containing the RPC response. |
// Create client
MachineTypesClient machineTypesClient = await MachineTypesClient.CreateAsync();
// Initialize request argument(s)
GetMachineTypeRequest request = new GetMachineTypeRequest
{
Zone = "",
Project = "",
MachineType = "",
};
// Make the request
MachineType response = await machineTypesClient.GetAsync(request);
GetAsync(GetMachineTypeRequest, CancellationToken)
public virtual Task<MachineType> GetAsync(GetMachineTypeRequest request, CancellationToken cancellationToken)
Returns the specified machine type.
Parameters | |
---|---|
Name | Description |
request |
GetMachineTypeRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskMachineType |
A Task containing the RPC response. |
// Create client
MachineTypesClient machineTypesClient = await MachineTypesClient.CreateAsync();
// Initialize request argument(s)
GetMachineTypeRequest request = new GetMachineTypeRequest
{
Zone = "",
Project = "",
MachineType = "",
};
// Make the request
MachineType response = await machineTypesClient.GetAsync(request);
GetAsync(string, string, string, CallSettings)
public virtual Task<MachineType> GetAsync(string project, string zone, string machineType, CallSettings callSettings = null)
Returns the specified machine type.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
zone |
string The name of the zone for this request. |
machineType |
string Name of the machine type to return. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskMachineType |
A Task containing the RPC response. |
// Create client
MachineTypesClient machineTypesClient = await MachineTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string machineType = "";
// Make the request
MachineType response = await machineTypesClient.GetAsync(project, zone, machineType);
GetAsync(string, string, string, CancellationToken)
public virtual Task<MachineType> GetAsync(string project, string zone, string machineType, CancellationToken cancellationToken)
Returns the specified machine type.
Parameters | |
---|---|
Name | Description |
project |
string Project ID for this request. |
zone |
string The name of the zone for this request. |
machineType |
string Name of the machine type to return. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskMachineType |
A Task containing the RPC response. |
// Create client
MachineTypesClient machineTypesClient = await MachineTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string machineType = "";
// Make the request
MachineType response = await machineTypesClient.GetAsync(project, zone, machineType);
List(ListMachineTypesRequest, CallSettings)
public virtual PagedEnumerable<MachineTypeList, MachineType> List(ListMachineTypesRequest request, CallSettings callSettings = null)
Retrieves a list of machine types available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
ListMachineTypesRequest 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 |
PagedEnumerableMachineTypeListMachineType |
A pageable sequence of MachineType resources. |
// Create client
MachineTypesClient machineTypesClient = MachineTypesClient.Create();
// Initialize request argument(s)
ListMachineTypesRequest request = new ListMachineTypesRequest
{
Zone = "",
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<MachineTypeList, MachineType> response = machineTypesClient.List(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (MachineType 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 (MachineTypeList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (MachineType 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<MachineType> 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 (MachineType 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<MachineTypeList, MachineType> List(string project, string zone, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves a list of machine 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 |
int 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 |
PagedEnumerableMachineTypeListMachineType |
A pageable sequence of MachineType resources. |
// Create client
MachineTypesClient machineTypesClient = MachineTypesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
PagedEnumerable<MachineTypeList, MachineType> response = machineTypesClient.List(project, zone);
// Iterate over all response items, lazily performing RPCs as required
foreach (MachineType 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 (MachineTypeList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (MachineType 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<MachineType> 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 (MachineType 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(ListMachineTypesRequest, CallSettings)
public virtual PagedAsyncEnumerable<MachineTypeList, MachineType> ListAsync(ListMachineTypesRequest request, CallSettings callSettings = null)
Retrieves a list of machine types available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
ListMachineTypesRequest 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 |
PagedAsyncEnumerableMachineTypeListMachineType |
A pageable asynchronous sequence of MachineType resources. |
// Create client
MachineTypesClient machineTypesClient = await MachineTypesClient.CreateAsync();
// Initialize request argument(s)
ListMachineTypesRequest request = new ListMachineTypesRequest
{
Zone = "",
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<MachineTypeList, MachineType> response = machineTypesClient.ListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MachineType 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((MachineTypeList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (MachineType 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<MachineType> 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 (MachineType 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<MachineTypeList, MachineType> ListAsync(string project, string zone, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves a list of machine 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 |
int 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 |
PagedAsyncEnumerableMachineTypeListMachineType |
A pageable asynchronous sequence of MachineType resources. |
// Create client
MachineTypesClient machineTypesClient = await MachineTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
PagedAsyncEnumerable<MachineTypeList, MachineType> response = machineTypesClient.ListAsync(project, zone);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MachineType 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((MachineTypeList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (MachineType 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<MachineType> 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 (MachineType 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.