Class Tpu.TpuClient (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public class TpuClient : ClientBase<Tpu.TpuClient>

Client for Tpu

Inheritance

Object > ClientBase > ClientBase<Tpu.TpuClient> > Tpu.TpuClient

Namespace

Google.Cloud.Tpu.V1

Assembly

Google.Cloud.Tpu.V1.dll

Constructors

TpuClient()

protected TpuClient()

Protected parameterless constructor to allow creation of test doubles.

TpuClient(CallInvoker)

public TpuClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

TpuClient(ChannelBase)

public TpuClient(ChannelBase channel)

Creates a new client for Tpu

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

TpuClient(ClientBase.ClientBaseConfiguration)

protected TpuClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateNode(CreateNodeRequest, CallOptions)

public virtual Operation CreateNode(CreateNodeRequest request, CallOptions options)

Creates a node.

Parameters
NameDescription
requestCreateNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateNode(CreateNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateNode(CreateNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a node.

Parameters
NameDescription
requestCreateNodeRequest

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
Operation

The response received from the server.

CreateNodeAsync(CreateNodeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateNodeAsync(CreateNodeRequest request, CallOptions options)

Creates a node.

Parameters
NameDescription
requestCreateNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateNodeAsync(CreateNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateNodeAsync(CreateNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a node.

Parameters
NameDescription
requestCreateNodeRequest

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<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

DeleteNode(DeleteNodeRequest, CallOptions)

public virtual Operation DeleteNode(DeleteNodeRequest request, CallOptions options)

Deletes a node.

Parameters
NameDescription
requestDeleteNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteNode(DeleteNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteNode(DeleteNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a node.

Parameters
NameDescription
requestDeleteNodeRequest

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
Operation

The response received from the server.

DeleteNodeAsync(DeleteNodeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteNodeAsync(DeleteNodeRequest request, CallOptions options)

Deletes a node.

Parameters
NameDescription
requestDeleteNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteNodeAsync(DeleteNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteNodeAsync(DeleteNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a node.

Parameters
NameDescription
requestDeleteNodeRequest

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<Operation>

The call object.

GetAcceleratorType(GetAcceleratorTypeRequest, CallOptions)

public virtual AcceleratorType GetAcceleratorType(GetAcceleratorTypeRequest request, CallOptions options)

Gets AcceleratorType.

Parameters
NameDescription
requestGetAcceleratorTypeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AcceleratorType

The response received from the server.

GetAcceleratorType(GetAcceleratorTypeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AcceleratorType GetAcceleratorType(GetAcceleratorTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets AcceleratorType.

Parameters
NameDescription
requestGetAcceleratorTypeRequest

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
AcceleratorType

The response received from the server.

GetAcceleratorTypeAsync(GetAcceleratorTypeRequest, CallOptions)

public virtual AsyncUnaryCall<AcceleratorType> GetAcceleratorTypeAsync(GetAcceleratorTypeRequest request, CallOptions options)

Gets AcceleratorType.

Parameters
NameDescription
requestGetAcceleratorTypeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<AcceleratorType>

The call object.

GetAcceleratorTypeAsync(GetAcceleratorTypeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<AcceleratorType> GetAcceleratorTypeAsync(GetAcceleratorTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets AcceleratorType.

Parameters
NameDescription
requestGetAcceleratorTypeRequest

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<AcceleratorType>

The call object.

GetNode(GetNodeRequest, CallOptions)

public virtual Node GetNode(GetNodeRequest request, CallOptions options)

Gets the details of a node.

Parameters
NameDescription
requestGetNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Node

The response received from the server.

GetNode(GetNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Node GetNode(GetNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the details of a node.

Parameters
NameDescription
requestGetNodeRequest

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
Node

The response received from the server.

GetNodeAsync(GetNodeRequest, CallOptions)

public virtual AsyncUnaryCall<Node> GetNodeAsync(GetNodeRequest request, CallOptions options)

Gets the details of a node.

Parameters
NameDescription
requestGetNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Node>

The call object.

GetNodeAsync(GetNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Node> GetNodeAsync(GetNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the details of a node.

Parameters
NameDescription
requestGetNodeRequest

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<Node>

The call object.

GetTensorFlowVersion(GetTensorFlowVersionRequest, CallOptions)

public virtual TensorFlowVersion GetTensorFlowVersion(GetTensorFlowVersionRequest request, CallOptions options)

Gets TensorFlow Version.

Parameters
NameDescription
requestGetTensorFlowVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TensorFlowVersion

The response received from the server.

GetTensorFlowVersion(GetTensorFlowVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual TensorFlowVersion GetTensorFlowVersion(GetTensorFlowVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets TensorFlow Version.

Parameters
NameDescription
requestGetTensorFlowVersionRequest

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
TensorFlowVersion

The response received from the server.

GetTensorFlowVersionAsync(GetTensorFlowVersionRequest, CallOptions)

public virtual AsyncUnaryCall<TensorFlowVersion> GetTensorFlowVersionAsync(GetTensorFlowVersionRequest request, CallOptions options)

Gets TensorFlow Version.

Parameters
NameDescription
requestGetTensorFlowVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TensorFlowVersion>

The call object.

GetTensorFlowVersionAsync(GetTensorFlowVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<TensorFlowVersion> GetTensorFlowVersionAsync(GetTensorFlowVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets TensorFlow Version.

Parameters
NameDescription
requestGetTensorFlowVersionRequest

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<TensorFlowVersion>

The call object.

ListAcceleratorTypes(ListAcceleratorTypesRequest, CallOptions)

public virtual ListAcceleratorTypesResponse ListAcceleratorTypes(ListAcceleratorTypesRequest request, CallOptions options)

Lists accelerator types supported by this API.

Parameters
NameDescription
requestListAcceleratorTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListAcceleratorTypesResponse

The response received from the server.

ListAcceleratorTypes(ListAcceleratorTypesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListAcceleratorTypesResponse ListAcceleratorTypes(ListAcceleratorTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists accelerator types supported by this API.

Parameters
NameDescription
requestListAcceleratorTypesRequest

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
ListAcceleratorTypesResponse

The response received from the server.

ListAcceleratorTypesAsync(ListAcceleratorTypesRequest, CallOptions)

public virtual AsyncUnaryCall<ListAcceleratorTypesResponse> ListAcceleratorTypesAsync(ListAcceleratorTypesRequest request, CallOptions options)

Lists accelerator types supported by this API.

Parameters
NameDescription
requestListAcceleratorTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListAcceleratorTypesResponse>

The call object.

ListAcceleratorTypesAsync(ListAcceleratorTypesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListAcceleratorTypesResponse> ListAcceleratorTypesAsync(ListAcceleratorTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists accelerator types supported by this API.

Parameters
NameDescription
requestListAcceleratorTypesRequest

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<ListAcceleratorTypesResponse>

The call object.

ListNodes(ListNodesRequest, CallOptions)

public virtual ListNodesResponse ListNodes(ListNodesRequest request, CallOptions options)

Lists nodes.

Parameters
NameDescription
requestListNodesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListNodesResponse

The response received from the server.

ListNodes(ListNodesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListNodesResponse ListNodes(ListNodesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists nodes.

Parameters
NameDescription
requestListNodesRequest

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
ListNodesResponse

The response received from the server.

ListNodesAsync(ListNodesRequest, CallOptions)

public virtual AsyncUnaryCall<ListNodesResponse> ListNodesAsync(ListNodesRequest request, CallOptions options)

Lists nodes.

Parameters
NameDescription
requestListNodesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListNodesResponse>

The call object.

ListNodesAsync(ListNodesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListNodesResponse> ListNodesAsync(ListNodesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists nodes.

Parameters
NameDescription
requestListNodesRequest

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<ListNodesResponse>

The call object.

ListTensorFlowVersions(ListTensorFlowVersionsRequest, CallOptions)

public virtual ListTensorFlowVersionsResponse ListTensorFlowVersions(ListTensorFlowVersionsRequest request, CallOptions options)

List TensorFlow versions supported by this API.

Parameters
NameDescription
requestListTensorFlowVersionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTensorFlowVersionsResponse

The response received from the server.

ListTensorFlowVersions(ListTensorFlowVersionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListTensorFlowVersionsResponse ListTensorFlowVersions(ListTensorFlowVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List TensorFlow versions supported by this API.

Parameters
NameDescription
requestListTensorFlowVersionsRequest

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
ListTensorFlowVersionsResponse

The response received from the server.

ListTensorFlowVersionsAsync(ListTensorFlowVersionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListTensorFlowVersionsResponse> ListTensorFlowVersionsAsync(ListTensorFlowVersionsRequest request, CallOptions options)

List TensorFlow versions supported by this API.

Parameters
NameDescription
requestListTensorFlowVersionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListTensorFlowVersionsResponse>

The call object.

ListTensorFlowVersionsAsync(ListTensorFlowVersionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListTensorFlowVersionsResponse> ListTensorFlowVersionsAsync(ListTensorFlowVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List TensorFlow versions supported by this API.

Parameters
NameDescription
requestListTensorFlowVersionsRequest

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<ListTensorFlowVersionsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Tpu.TpuClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Tpu.TpuClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Tpu.V1.Tpu.TpuClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ReimageNode(ReimageNodeRequest, CallOptions)

public virtual Operation ReimageNode(ReimageNodeRequest request, CallOptions options)

Reimages a node's OS.

Parameters
NameDescription
requestReimageNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ReimageNode(ReimageNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ReimageNode(ReimageNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Reimages a node's OS.

Parameters
NameDescription
requestReimageNodeRequest

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
Operation

The response received from the server.

ReimageNodeAsync(ReimageNodeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ReimageNodeAsync(ReimageNodeRequest request, CallOptions options)

Reimages a node's OS.

Parameters
NameDescription
requestReimageNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ReimageNodeAsync(ReimageNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ReimageNodeAsync(ReimageNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Reimages a node's OS.

Parameters
NameDescription
requestReimageNodeRequest

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<Operation>

The call object.

StartNode(StartNodeRequest, CallOptions)

public virtual Operation StartNode(StartNodeRequest request, CallOptions options)

Starts a node.

Parameters
NameDescription
requestStartNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StartNode(StartNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation StartNode(StartNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Starts a node.

Parameters
NameDescription
requestStartNodeRequest

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
Operation

The response received from the server.

StartNodeAsync(StartNodeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartNodeAsync(StartNodeRequest request, CallOptions options)

Starts a node.

Parameters
NameDescription
requestStartNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartNodeAsync(StartNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> StartNodeAsync(StartNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Starts a node.

Parameters
NameDescription
requestStartNodeRequest

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<Operation>

The call object.

StopNode(StopNodeRequest, CallOptions)

public virtual Operation StopNode(StopNodeRequest request, CallOptions options)

Stops a node.

Parameters
NameDescription
requestStopNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StopNode(StopNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation StopNode(StopNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Stops a node.

Parameters
NameDescription
requestStopNodeRequest

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
Operation

The response received from the server.

StopNodeAsync(StopNodeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StopNodeAsync(StopNodeRequest request, CallOptions options)

Stops a node.

Parameters
NameDescription
requestStopNodeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StopNodeAsync(StopNodeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> StopNodeAsync(StopNodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Stops a node.

Parameters
NameDescription
requestStopNodeRequest

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<Operation>

The call object.