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

public class NodeTypesClient : ClientBase<NodeTypes.NodeTypesClient>

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

Client for NodeTypes

Inheritance

Object > ClientBase > ClientBase<NodeTypes.NodeTypesClient> > 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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

NodeTypesClient(ChannelBase)

public NodeTypesClient(ChannelBase channel)

Creates a new client for NodeTypes

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

NodeTypesClient(ClientBase.ClientBaseConfiguration)

protected NodeTypesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListNodeTypesRequest, CallOptions)

public virtual NodeTypeAggregatedList AggregatedList(AggregatedListNodeTypesRequest request, CallOptions options)

Retrieves an aggregated list of node types.

Parameters
NameDescription
requestAggregatedListNodeTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
NodeTypeAggregatedList

The response received from the server.

AggregatedList(AggregatedListNodeTypesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves an aggregated list of node types.

Parameters
NameDescription
requestAggregatedListNodeTypesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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.

Parameters
NameDescription
requestAggregatedListNodeTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<NodeTypeAggregatedList>

The call object.

AggregatedListAsync(AggregatedListNodeTypesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves an aggregated list of node types.

Parameters
NameDescription
requestAggregatedListNodeTypesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<NodeTypeAggregatedList>

The call object.

Get(GetNodeTypeRequest, CallOptions)

public virtual NodeType Get(GetNodeTypeRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetNodeTypeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
NodeType

The response received from the server.

Get(GetNodeTypeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetNodeTypeRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
NodeType

The response received from the server.

GetAsync(GetNodeTypeRequest, CallOptions)

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

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

Parameters
NameDescription
requestGetNodeTypeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<NodeType>

The call object.

GetAsync(GetNodeTypeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetNodeTypeRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<NodeType>

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
NameDescription
requestListNodeTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
NodeTypeList

The response received from the server.

List(ListNodeTypesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListNodeTypesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListNodeTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<NodeTypeList>

The call object.

ListAsync(ListNodeTypesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListNodeTypesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<NodeTypeList>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
NodeTypes.NodeTypesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.NodeTypes.NodeTypesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)