Compute Engine v1 API - Class NodeTypes.NodeTypesClient (2.15.0)

public class NodeTypes.NodeTypesClient : ClientBase<NodeTypes.NodeTypesClient>

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

Client for NodeTypes

Inheritance

object > ClientBase > ClientBaseNodeTypesNodeTypesClient > NodeTypes.NodeTypesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

NodeTypesClient()

protected NodeTypesClient()

Protected parameterless constructor to allow creation of test doubles.

NodeTypesClient(CallInvoker)

public NodeTypesClient(CallInvoker callInvoker)

Creates a new client for NodeTypes that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

NodeTypesClient(ChannelBase)

public NodeTypesClient(ChannelBase channel)

Creates a new client for NodeTypes

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

NodeTypesClient(ClientBaseConfiguration)

protected NodeTypesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListNodeTypesRequest, CallOptions)

public virtual NodeTypeAggregatedList AggregatedList(AggregatedListNodeTypesRequest request, CallOptions options)

Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListNodeTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NodeTypeAggregatedList

The response received from the server.

AggregatedList(AggregatedListNodeTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual NodeTypeAggregatedList AggregatedList(AggregatedListNodeTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListNodeTypesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
NodeTypeAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListNodeTypesRequest, CallOptions)

public virtual AsyncUnaryCall<NodeTypeAggregatedList> AggregatedListAsync(AggregatedListNodeTypesRequest request, CallOptions options)

Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListNodeTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallNodeTypeAggregatedList

The call object.

AggregatedListAsync(AggregatedListNodeTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NodeTypeAggregatedList> AggregatedListAsync(AggregatedListNodeTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListNodeTypesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallNodeTypeAggregatedList

The call object.

Get(GetNodeTypeRequest, CallOptions)

public virtual NodeType Get(GetNodeTypeRequest request, CallOptions options)

Returns the specified node type.

Parameters
Name Description
request GetNodeTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NodeType

The response received from the server.

Get(GetNodeTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual NodeType Get(GetNodeTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified node type.

Parameters
Name Description
request GetNodeTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
NodeType

The response received from the server.

GetAsync(GetNodeTypeRequest, CallOptions)

public virtual AsyncUnaryCall<NodeType> GetAsync(GetNodeTypeRequest request, CallOptions options)

Returns the specified node type.

Parameters
Name Description
request GetNodeTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallNodeType

The call object.

GetAsync(GetNodeTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NodeType> GetAsync(GetNodeTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified node type.

Parameters
Name Description
request GetNodeTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallNodeType

The call object.

List(ListNodeTypesRequest, CallOptions)

public virtual NodeTypeList List(ListNodeTypesRequest request, CallOptions options)

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

Parameters
Name Description
request ListNodeTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NodeTypeList

The response received from the server.

List(ListNodeTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual NodeTypeList List(ListNodeTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListNodeTypesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
NodeTypeList

The response received from the server.

ListAsync(ListNodeTypesRequest, CallOptions)

public virtual AsyncUnaryCall<NodeTypeList> ListAsync(ListNodeTypesRequest request, CallOptions options)

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

Parameters
Name Description
request ListNodeTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallNodeTypeList

The call object.

ListAsync(ListNodeTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NodeTypeList> ListAsync(ListNodeTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListNodeTypesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallNodeTypeList

The call object.

NewInstance(ClientBaseConfiguration)

protected override NodeTypes.NodeTypesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
NodeTypesNodeTypesClient
Overrides