Class NodeTypesClient (1.0.0)

public abstract class NodeTypesClient

NodeTypes client wrapper, for convenient use.

Inheritance

Object > NodeTypesClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

NodeTypesClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The NodeTypes API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
`IReadOnlyList<String>`

Remarks

The default NodeTypes scopes are:

GrpcClient

public virtual NodeTypes.NodeTypesClient GrpcClient { get; }

The underlying gRPC NodeTypes client

Property Value
Type	Description
`NodeTypes.NodeTypesClient`

Methods

AggregatedList(AggregatedListNodeTypesRequest, CallSettings)

public virtual PagedEnumerable<NodeTypeAggregatedList, KeyValuePair<string, NodeTypesScopedList>> AggregatedList(AggregatedListNodeTypesRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of node types.

Parameters
Name	Description
`request`	`AggregatedListNodeTypesRequest` 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<NodeTypeAggregatedList, KeyValuePair<String, NodeTypesScopedList>>`	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
NodeTypesClient nodeTypesClient = NodeTypesClient.Create();
// Initialize request argument(s)
AggregatedListNodeTypesRequest request = new AggregatedListNodeTypesRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<NodeTypeAggregatedList, KeyValuePair<string, NodeTypesScopedList>> response = nodeTypesClient.AggregatedList(request);

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

Retrieves an aggregated list of node types.

Parameters
Name	Description
`project`	`String` Project ID 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`	`Nullable<Int32>` 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
`PagedEnumerable<NodeTypeAggregatedList, KeyValuePair<String, NodeTypesScopedList>>`	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
NodeTypesClient nodeTypesClient = NodeTypesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<NodeTypeAggregatedList, KeyValuePair<string, NodeTypesScopedList>> response = nodeTypesClient.AggregatedList(project);

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

public virtual PagedAsyncEnumerable<NodeTypeAggregatedList, KeyValuePair<string, NodeTypesScopedList>> AggregatedListAsync(AggregatedListNodeTypesRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of node types.

Parameters
Name	Description
`request`	`AggregatedListNodeTypesRequest` 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<NodeTypeAggregatedList, KeyValuePair<String, NodeTypesScopedList>>`	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
NodeTypesClient nodeTypesClient = await NodeTypesClient.CreateAsync();
// Initialize request argument(s)
AggregatedListNodeTypesRequest request = new AggregatedListNodeTypesRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<NodeTypeAggregatedList, KeyValuePair<string, NodeTypesScopedList>> response = nodeTypesClient.AggregatedListAsync(request);

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

Retrieves an aggregated list of node types.

Parameters
Name	Description
`project`	`String` Project ID 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`	`Nullable<Int32>` 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
`PagedAsyncEnumerable<NodeTypeAggregatedList, KeyValuePair<String, NodeTypesScopedList>>`	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
NodeTypesClient nodeTypesClient = await NodeTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<NodeTypeAggregatedList, KeyValuePair<string, NodeTypesScopedList>> response = nodeTypesClient.AggregatedListAsync(project);

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

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

Returns
Type	Description
`NodeTypesClient`	The created NodeTypesClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
`Task<NodeTypesClient>`	The task representing the created NodeTypesClient.

Get(GetNodeTypeRequest, CallSettings)

public virtual NodeType Get(GetNodeTypeRequest request, CallSettings callSettings = null)

Returns the specified node type. Gets a list of available node types by making a list() request.

Parameters
Name	Description
`request`	`GetNodeTypeRequest` 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
`NodeType`	The RPC response.

Example

// Create client
NodeTypesClient nodeTypesClient = NodeTypesClient.Create();
// Initialize request argument(s)
GetNodeTypeRequest request = new GetNodeTypeRequest
{
    Zone = "",
    Project = "",
    NodeType = "",
};
// Make the request
NodeType response = nodeTypesClient.Get(request);

Get(String, String, String, CallSettings)

public virtual NodeType Get(string project, string zone, string nodeType, CallSettings callSettings = null)

Returns the specified node type. Gets a list of available node 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.
`nodeType`	`String` Name of the node type to return.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`NodeType`	The RPC response.

Example

// Create client
NodeTypesClient nodeTypesClient = NodeTypesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string nodeType = "";
// Make the request
NodeType response = nodeTypesClient.Get(project, zone, nodeType);

GetAsync(GetNodeTypeRequest, CallSettings)

public virtual Task<NodeType> GetAsync(GetNodeTypeRequest request, CallSettings callSettings = null)

Returns the specified node type. Gets a list of available node types by making a list() request.

Parameters
Name	Description
`request`	`GetNodeTypeRequest` 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<NodeType>`	A Task containing the RPC response.

Example

// Create client
NodeTypesClient nodeTypesClient = await NodeTypesClient.CreateAsync();
// Initialize request argument(s)
GetNodeTypeRequest request = new GetNodeTypeRequest
{
    Zone = "",
    Project = "",
    NodeType = "",
};
// Make the request
NodeType response = await nodeTypesClient.GetAsync(request);

GetAsync(GetNodeTypeRequest, CancellationToken)

public virtual Task<NodeType> GetAsync(GetNodeTypeRequest request, CancellationToken cancellationToken)

Returns the specified node type. Gets a list of available node types by making a list() request.

Parameters
Name	Description
`request`	`GetNodeTypeRequest` 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<NodeType>`	A Task containing the RPC response.

Example

// Create client
NodeTypesClient nodeTypesClient = await NodeTypesClient.CreateAsync();
// Initialize request argument(s)
GetNodeTypeRequest request = new GetNodeTypeRequest
{
    Zone = "",
    Project = "",
    NodeType = "",
};
// Make the request
NodeType response = await nodeTypesClient.GetAsync(request);

GetAsync(String, String, String, CallSettings)

public virtual Task<NodeType> GetAsync(string project, string zone, string nodeType, CallSettings callSettings = null)

Returns the specified node type. Gets a list of available node 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.
`nodeType`	`String` Name of the node type to return.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<NodeType>`	A Task containing the RPC response.

Example

// Create client
NodeTypesClient nodeTypesClient = await NodeTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string nodeType = "";
// Make the request
NodeType response = await nodeTypesClient.GetAsync(project, zone, nodeType);

GetAsync(String, String, String, CancellationToken)

public virtual Task<NodeType> GetAsync(string project, string zone, string nodeType, CancellationToken cancellationToken)

Returns the specified node type. Gets a list of available node 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.
`nodeType`	`String` Name of the node type to return.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<NodeType>`	A Task containing the RPC response.

Example

// Create client
NodeTypesClient nodeTypesClient = await NodeTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string nodeType = "";
// Make the request
NodeType response = await nodeTypesClient.GetAsync(project, zone, nodeType);

List(ListNodeTypesRequest, CallSettings)

public virtual PagedEnumerable<NodeTypeList, NodeType> List(ListNodeTypesRequest request, CallSettings callSettings = null)

Retrieves a list of node types available to the specified project.

Parameters
Name	Description
`request`	`ListNodeTypesRequest` 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<NodeTypeList, NodeType>`	A pageable sequence of NodeType resources.

Example

// Create client
NodeTypesClient nodeTypesClient = NodeTypesClient.Create();
// Initialize request argument(s)
ListNodeTypesRequest request = new ListNodeTypesRequest
{
    Zone = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<NodeTypeList, NodeType> response = nodeTypesClient.List(request);

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

Retrieves a list of node 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 `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` 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
`PagedEnumerable<NodeTypeList, NodeType>`	A pageable sequence of NodeType resources.

Example

// Create client
NodeTypesClient nodeTypesClient = NodeTypesClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
PagedEnumerable<NodeTypeList, NodeType> response = nodeTypesClient.List(project, zone);

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

public virtual PagedAsyncEnumerable<NodeTypeList, NodeType> ListAsync(ListNodeTypesRequest request, CallSettings callSettings = null)

Retrieves a list of node types available to the specified project.

Parameters
Name	Description
`request`	`ListNodeTypesRequest` 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<NodeTypeList, NodeType>`	A pageable asynchronous sequence of NodeType resources.

Example

// Create client
NodeTypesClient nodeTypesClient = await NodeTypesClient.CreateAsync();
// Initialize request argument(s)
ListNodeTypesRequest request = new ListNodeTypesRequest
{
    Zone = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<NodeTypeList, NodeType> response = nodeTypesClient.ListAsync(request);

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

Retrieves a list of node 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 `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` 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
`PagedAsyncEnumerable<NodeTypeList, NodeType>`	A pageable asynchronous sequence of NodeType resources.

Example

// Create client
NodeTypesClient nodeTypesClient = await NodeTypesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
// Make the request
PagedAsyncEnumerable<NodeTypeList, NodeType> response = nodeTypesClient.ListAsync(project, zone);

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