Cloud TPU v1 API - Class TpuClientImpl (2.3.0)

Version latest

• 2.3.0 (latest)
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

public sealed class TpuClientImpl : TpuClient

Reference documentation and code samples for the Cloud TPU v1 API class TpuClientImpl.

Tpu client wrapper implementation, for convenient use.

Inheritance

object > TpuClient > TpuClientImpl

Inherited Members

TpuClient.DefaultEndpoint

TpuClient.DefaultScopes

TpuClient.ServiceMetadata

TpuClient.CreateAsync(CancellationToken)

TpuClient.Create()

TpuClient.ShutdownDefaultChannelsAsync()

TpuClient.ListNodes(string, string, int?, CallSettings)

TpuClient.ListNodesAsync(string, string, int?, CallSettings)

TpuClient.ListNodes(LocationName, string, int?, CallSettings)

TpuClient.ListNodesAsync(LocationName, string, int?, CallSettings)

TpuClient.GetNodeAsync(GetNodeRequest, CancellationToken)

TpuClient.GetNode(string, CallSettings)

TpuClient.GetNodeAsync(string, CallSettings)

TpuClient.GetNodeAsync(string, CancellationToken)

TpuClient.GetNode(NodeName, CallSettings)

TpuClient.GetNodeAsync(NodeName, CallSettings)

TpuClient.GetNodeAsync(NodeName, CancellationToken)

TpuClient.CreateNodeAsync(CreateNodeRequest, CancellationToken)

TpuClient.PollOnceCreateNode(string, CallSettings)

TpuClient.PollOnceCreateNodeAsync(string, CallSettings)

TpuClient.CreateNode(string, Node, string, CallSettings)

TpuClient.CreateNodeAsync(string, Node, string, CallSettings)

TpuClient.CreateNodeAsync(string, Node, string, CancellationToken)

TpuClient.CreateNode(LocationName, Node, string, CallSettings)

TpuClient.CreateNodeAsync(LocationName, Node, string, CallSettings)

TpuClient.CreateNodeAsync(LocationName, Node, string, CancellationToken)

TpuClient.DeleteNodeAsync(DeleteNodeRequest, CancellationToken)

TpuClient.PollOnceDeleteNode(string, CallSettings)

TpuClient.PollOnceDeleteNodeAsync(string, CallSettings)

TpuClient.DeleteNode(string, CallSettings)

TpuClient.DeleteNodeAsync(string, CallSettings)

TpuClient.DeleteNodeAsync(string, CancellationToken)

TpuClient.DeleteNode(NodeName, CallSettings)

TpuClient.DeleteNodeAsync(NodeName, CallSettings)

TpuClient.DeleteNodeAsync(NodeName, CancellationToken)

TpuClient.ReimageNodeAsync(ReimageNodeRequest, CancellationToken)

TpuClient.PollOnceReimageNode(string, CallSettings)

TpuClient.PollOnceReimageNodeAsync(string, CallSettings)

TpuClient.StopNodeAsync(StopNodeRequest, CancellationToken)

TpuClient.PollOnceStopNode(string, CallSettings)

TpuClient.PollOnceStopNodeAsync(string, CallSettings)

TpuClient.StartNodeAsync(StartNodeRequest, CancellationToken)

TpuClient.PollOnceStartNode(string, CallSettings)

TpuClient.PollOnceStartNodeAsync(string, CallSettings)

TpuClient.ListTensorFlowVersions(string, string, int?, CallSettings)

TpuClient.ListTensorFlowVersionsAsync(string, string, int?, CallSettings)

TpuClient.ListTensorFlowVersions(TensorFlowVersionName, string, int?, CallSettings)

TpuClient.ListTensorFlowVersionsAsync(TensorFlowVersionName, string, int?, CallSettings)

TpuClient.GetTensorFlowVersionAsync(GetTensorFlowVersionRequest, CancellationToken)

TpuClient.GetTensorFlowVersion(string, CallSettings)

TpuClient.GetTensorFlowVersionAsync(string, CallSettings)

TpuClient.GetTensorFlowVersionAsync(string, CancellationToken)

TpuClient.GetTensorFlowVersion(TensorFlowVersionName, CallSettings)

TpuClient.GetTensorFlowVersionAsync(TensorFlowVersionName, CallSettings)

TpuClient.GetTensorFlowVersionAsync(TensorFlowVersionName, CancellationToken)

TpuClient.ListAcceleratorTypes(string, string, int?, CallSettings)

TpuClient.ListAcceleratorTypesAsync(string, string, int?, CallSettings)

TpuClient.ListAcceleratorTypes(AcceleratorTypeName, string, int?, CallSettings)

TpuClient.ListAcceleratorTypesAsync(AcceleratorTypeName, string, int?, CallSettings)

TpuClient.GetAcceleratorTypeAsync(GetAcceleratorTypeRequest, CancellationToken)

TpuClient.GetAcceleratorType(string, CallSettings)

TpuClient.GetAcceleratorTypeAsync(string, CallSettings)

TpuClient.GetAcceleratorTypeAsync(string, CancellationToken)

TpuClient.GetAcceleratorType(AcceleratorTypeName, CallSettings)

TpuClient.GetAcceleratorTypeAsync(AcceleratorTypeName, CallSettings)

TpuClient.GetAcceleratorTypeAsync(AcceleratorTypeName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Tpu.V1

Assembly

Google.Cloud.Tpu.V1.dll

Remarks

Manages TPU nodes and other resources

TPU API v1

Constructors

TpuClientImpl(TpuClient, TpuSettings, ILogger)

public TpuClientImpl(Tpu.TpuClient grpcClient, TpuSettings settings, ILogger logger)

Constructs a client wrapper for the Tpu service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	TpuTpuClient The underlying gRPC client.
settings	TpuSettings The base TpuSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

CreateNodeOperationsClient

public override OperationsClient CreateNodeOperationsClient { get; }

The long-running operations client for CreateNode.

Property Value
Type	Description
OperationsClient

Overrides

TpuClient.CreateNodeOperationsClient

DeleteNodeOperationsClient

public override OperationsClient DeleteNodeOperationsClient { get; }

The long-running operations client for DeleteNode.

Property Value
Type	Description
OperationsClient

Overrides

TpuClient.DeleteNodeOperationsClient

GrpcClient

public override Tpu.TpuClient GrpcClient { get; }

The underlying gRPC Tpu client

Property Value
Type	Description
TpuTpuClient

Overrides

TpuClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

TpuClient.LocationsClient

ReimageNodeOperationsClient

public override OperationsClient ReimageNodeOperationsClient { get; }

The long-running operations client for ReimageNode.

Property Value
Type	Description
OperationsClient

Overrides

TpuClient.ReimageNodeOperationsClient

StartNodeOperationsClient

public override OperationsClient StartNodeOperationsClient { get; }

The long-running operations client for StartNode.

Property Value
Type	Description
OperationsClient

Overrides

TpuClient.StartNodeOperationsClient

StopNodeOperationsClient

public override OperationsClient StopNodeOperationsClient { get; }

The long-running operations client for StopNode.

Property Value
Type	Description
OperationsClient

Overrides

TpuClient.StopNodeOperationsClient

Methods

CreateNode(CreateNodeRequest, CallSettings)

public override Operation<Node, OperationMetadata> CreateNode(CreateNodeRequest request, CallSettings callSettings = null)

Creates a node.

Parameters
Name	Description
request	CreateNodeRequest 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
OperationNodeOperationMetadata	The RPC response.

Overrides

TpuClient.CreateNode(CreateNodeRequest, CallSettings)

CreateNodeAsync(CreateNodeRequest, CallSettings)

public override Task<Operation<Node, OperationMetadata>> CreateNodeAsync(CreateNodeRequest request, CallSettings callSettings = null)

Creates a node.

Parameters
Name	Description
request	CreateNodeRequest 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
TaskOperationNodeOperationMetadata	A Task containing the RPC response.

Overrides

TpuClient.CreateNodeAsync(CreateNodeRequest, CallSettings)

DeleteNode(DeleteNodeRequest, CallSettings)

public override Operation<Node, OperationMetadata> DeleteNode(DeleteNodeRequest request, CallSettings callSettings = null)

Deletes a node.

Parameters
Name	Description
request	DeleteNodeRequest 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
OperationNodeOperationMetadata	The RPC response.

Overrides

TpuClient.DeleteNode(DeleteNodeRequest, CallSettings)

DeleteNodeAsync(DeleteNodeRequest, CallSettings)

public override Task<Operation<Node, OperationMetadata>> DeleteNodeAsync(DeleteNodeRequest request, CallSettings callSettings = null)

Deletes a node.

Parameters
Name	Description
request	DeleteNodeRequest 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
TaskOperationNodeOperationMetadata	A Task containing the RPC response.

Overrides

TpuClient.DeleteNodeAsync(DeleteNodeRequest, CallSettings)

GetAcceleratorType(GetAcceleratorTypeRequest, CallSettings)

public override AcceleratorType GetAcceleratorType(GetAcceleratorTypeRequest request, CallSettings callSettings = null)

Gets AcceleratorType.

Parameters
Name	Description
request	GetAcceleratorTypeRequest 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
AcceleratorType	The RPC response.

Overrides

TpuClient.GetAcceleratorType(GetAcceleratorTypeRequest, CallSettings)

GetAcceleratorTypeAsync(GetAcceleratorTypeRequest, CallSettings)

public override Task<AcceleratorType> GetAcceleratorTypeAsync(GetAcceleratorTypeRequest request, CallSettings callSettings = null)

Gets AcceleratorType.

Parameters
Name	Description
request	GetAcceleratorTypeRequest 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
TaskAcceleratorType	A Task containing the RPC response.

Overrides

TpuClient.GetAcceleratorTypeAsync(GetAcceleratorTypeRequest, CallSettings)

GetNode(GetNodeRequest, CallSettings)

public override Node GetNode(GetNodeRequest request, CallSettings callSettings = null)

Gets the details of a node.

Parameters
Name	Description
request	GetNodeRequest 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
Node	The RPC response.

Overrides

TpuClient.GetNode(GetNodeRequest, CallSettings)

GetNodeAsync(GetNodeRequest, CallSettings)

public override Task<Node> GetNodeAsync(GetNodeRequest request, CallSettings callSettings = null)

Gets the details of a node.

Parameters
Name	Description
request	GetNodeRequest 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
TaskNode	A Task containing the RPC response.

Overrides

TpuClient.GetNodeAsync(GetNodeRequest, CallSettings)

GetTensorFlowVersion(GetTensorFlowVersionRequest, CallSettings)

public override TensorFlowVersion GetTensorFlowVersion(GetTensorFlowVersionRequest request, CallSettings callSettings = null)

Gets TensorFlow Version.

Parameters
Name	Description
request	GetTensorFlowVersionRequest 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
TensorFlowVersion	The RPC response.

Overrides

TpuClient.GetTensorFlowVersion(GetTensorFlowVersionRequest, CallSettings)

GetTensorFlowVersionAsync(GetTensorFlowVersionRequest, CallSettings)

public override Task<TensorFlowVersion> GetTensorFlowVersionAsync(GetTensorFlowVersionRequest request, CallSettings callSettings = null)

Gets TensorFlow Version.

Parameters
Name	Description
request	GetTensorFlowVersionRequest 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
TaskTensorFlowVersion	A Task containing the RPC response.

Overrides

TpuClient.GetTensorFlowVersionAsync(GetTensorFlowVersionRequest, CallSettings)

ListAcceleratorTypes(ListAcceleratorTypesRequest, CallSettings)

public override PagedEnumerable<ListAcceleratorTypesResponse, AcceleratorType> ListAcceleratorTypes(ListAcceleratorTypesRequest request, CallSettings callSettings = null)

Lists accelerator types supported by this API.

Parameters
Name	Description
request	ListAcceleratorTypesRequest 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
PagedEnumerableListAcceleratorTypesResponseAcceleratorType	A pageable sequence of AcceleratorType resources.

Overrides

TpuClient.ListAcceleratorTypes(ListAcceleratorTypesRequest, CallSettings)

ListAcceleratorTypesAsync(ListAcceleratorTypesRequest, CallSettings)

public override PagedAsyncEnumerable<ListAcceleratorTypesResponse, AcceleratorType> ListAcceleratorTypesAsync(ListAcceleratorTypesRequest request, CallSettings callSettings = null)

Lists accelerator types supported by this API.

Parameters
Name	Description
request	ListAcceleratorTypesRequest 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
PagedAsyncEnumerableListAcceleratorTypesResponseAcceleratorType	A pageable asynchronous sequence of AcceleratorType resources.

Overrides

TpuClient.ListAcceleratorTypesAsync(ListAcceleratorTypesRequest, CallSettings)

ListNodes(ListNodesRequest, CallSettings)

public override PagedEnumerable<ListNodesResponse, Node> ListNodes(ListNodesRequest request, CallSettings callSettings = null)

Lists nodes.

Parameters
Name	Description
request	ListNodesRequest 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
PagedEnumerableListNodesResponseNode	A pageable sequence of Node resources.

Overrides

TpuClient.ListNodes(ListNodesRequest, CallSettings)

ListNodesAsync(ListNodesRequest, CallSettings)

public override PagedAsyncEnumerable<ListNodesResponse, Node> ListNodesAsync(ListNodesRequest request, CallSettings callSettings = null)

Lists nodes.

Parameters
Name	Description
request	ListNodesRequest 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
PagedAsyncEnumerableListNodesResponseNode	A pageable asynchronous sequence of Node resources.

Overrides

TpuClient.ListNodesAsync(ListNodesRequest, CallSettings)

ListTensorFlowVersions(ListTensorFlowVersionsRequest, CallSettings)

public override PagedEnumerable<ListTensorFlowVersionsResponse, TensorFlowVersion> ListTensorFlowVersions(ListTensorFlowVersionsRequest request, CallSettings callSettings = null)

List TensorFlow versions supported by this API.

Parameters
Name	Description
request	ListTensorFlowVersionsRequest 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
PagedEnumerableListTensorFlowVersionsResponseTensorFlowVersion	A pageable sequence of TensorFlowVersion resources.

Overrides

TpuClient.ListTensorFlowVersions(ListTensorFlowVersionsRequest, CallSettings)

ListTensorFlowVersionsAsync(ListTensorFlowVersionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTensorFlowVersionsResponse, TensorFlowVersion> ListTensorFlowVersionsAsync(ListTensorFlowVersionsRequest request, CallSettings callSettings = null)

List TensorFlow versions supported by this API.

Parameters
Name	Description
request	ListTensorFlowVersionsRequest 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
PagedAsyncEnumerableListTensorFlowVersionsResponseTensorFlowVersion	A pageable asynchronous sequence of TensorFlowVersion resources.

Overrides

TpuClient.ListTensorFlowVersionsAsync(ListTensorFlowVersionsRequest, CallSettings)

ReimageNode(ReimageNodeRequest, CallSettings)

public override Operation<Node, OperationMetadata> ReimageNode(ReimageNodeRequest request, CallSettings callSettings = null)

Reimages a node's OS.

Parameters
Name	Description
request	ReimageNodeRequest 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
OperationNodeOperationMetadata	The RPC response.

Overrides

TpuClient.ReimageNode(ReimageNodeRequest, CallSettings)

ReimageNodeAsync(ReimageNodeRequest, CallSettings)

public override Task<Operation<Node, OperationMetadata>> ReimageNodeAsync(ReimageNodeRequest request, CallSettings callSettings = null)

Reimages a node's OS.

Parameters
Name	Description
request	ReimageNodeRequest 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
TaskOperationNodeOperationMetadata	A Task containing the RPC response.

Overrides

TpuClient.ReimageNodeAsync(ReimageNodeRequest, CallSettings)

StartNode(StartNodeRequest, CallSettings)

public override Operation<Node, OperationMetadata> StartNode(StartNodeRequest request, CallSettings callSettings = null)

Starts a node.

Parameters
Name	Description
request	StartNodeRequest 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
OperationNodeOperationMetadata	The RPC response.

Overrides

TpuClient.StartNode(StartNodeRequest, CallSettings)

StartNodeAsync(StartNodeRequest, CallSettings)

public override Task<Operation<Node, OperationMetadata>> StartNodeAsync(StartNodeRequest request, CallSettings callSettings = null)

Starts a node.

Parameters
Name	Description
request	StartNodeRequest 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
TaskOperationNodeOperationMetadata	A Task containing the RPC response.

Overrides

TpuClient.StartNodeAsync(StartNodeRequest, CallSettings)

StopNode(StopNodeRequest, CallSettings)

public override Operation<Node, OperationMetadata> StopNode(StopNodeRequest request, CallSettings callSettings = null)

Stops a node, this operation is only available with single TPU nodes.

Parameters
Name	Description
request	StopNodeRequest 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
OperationNodeOperationMetadata	The RPC response.

Overrides

TpuClient.StopNode(StopNodeRequest, CallSettings)

StopNodeAsync(StopNodeRequest, CallSettings)

public override Task<Operation<Node, OperationMetadata>> StopNodeAsync(StopNodeRequest request, CallSettings callSettings = null)

Stops a node, this operation is only available with single TPU nodes.

Parameters
Name	Description
request	StopNodeRequest 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
TaskOperationNodeOperationMetadata	A Task containing the RPC response.

Overrides

TpuClient.StopNodeAsync(StopNodeRequest, CallSettings)