Package cloud.google.com/go/tpu/apiv1

Package tpu is an auto-generated package for the Cloud TPU API.

TPU API provides customers with access to Google TPU technology.

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .

Functions

func DefaultAuthScopes

 func DefaultAuthScopes() [] string 
 

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

AcceleratorTypeIterator

 type AcceleratorTypeIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int 
, pageToken string 
) (results []* tpupb 
. AcceleratorType 
, nextPageToken string 
, err error 
)
	// contains filtered or unexported fields
} 

AcceleratorTypeIterator manages a stream of *tpupb.AcceleratorType.

func (*AcceleratorTypeIterator) Next

 func (it * AcceleratorTypeIterator 
) Next() (* tpupb 
. AcceleratorType 
, error 
) 

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*AcceleratorTypeIterator) PageInfo

 func (it * AcceleratorTypeIterator 
) PageInfo() * iterator 
. PageInfo 
 

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

CallOptions

 type CallOptions struct {
	ListNodes              [] gax 
. CallOption 
GetNode                [] gax 
. CallOption 
CreateNode             [] gax 
. CallOption 
DeleteNode             [] gax 
. CallOption 
ReimageNode            [] gax 
. CallOption 
StopNode               [] gax 
. CallOption 
StartNode              [] gax 
. CallOption 
ListTensorFlowVersions [] gax 
. CallOption 
GetTensorFlowVersion   [] gax 
. CallOption 
ListAcceleratorTypes   [] gax 
. CallOption 
GetAcceleratorType     [] gax 
. CallOption 
} 

CallOptions contains the retry settings for each method of Client.

Client

 type Client struct {

	// The call options for this service.
	CallOptions * CallOptions 
// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient * lroauto 
. OperationsClient 
// contains filtered or unexported fields
} 

Client is a client for interacting with Cloud TPU API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Manages TPU nodes and other resources

TPU API v1

func NewClient

 func NewClient(ctx context 
. Context 
, opts ... option 
. ClientOption 
) (* Client 
, error 
) 

NewClient creates a new tpu client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Manages TPU nodes and other resources

TPU API v1

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
} 

func (*Client) Close

 func (c * Client 
) Close() error 
 

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*Client) Connection

 func (c * Client 
) Connection() * grpc 
. ClientConn 
 

Connection returns a connection to the API service.

Deprecated.

func (*Client) CreateNode

 func (c * Client 
) CreateNode(ctx context 
. Context 
, req * tpupb 
. CreateNodeRequest 
, opts ... gax 
. CallOption 
) (* CreateNodeOperation 
, error 
) 

CreateNode creates a node.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.CreateNodeRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.CreateNode(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

func (*Client) CreateNodeOperation

 func (c * Client 
) CreateNodeOperation(name string 
) * CreateNodeOperation 
 

CreateNodeOperation returns a new CreateNodeOperation from a given name. The name must be that of a previously created CreateNodeOperation, possibly from a different process.

func (*Client) DeleteNode

 func (c * Client 
) DeleteNode(ctx context 
. Context 
, req * tpupb 
. DeleteNodeRequest 
, opts ... gax 
. CallOption 
) (* DeleteNodeOperation 
, error 
) 

DeleteNode deletes a node.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.DeleteNodeRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.DeleteNode(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

func (*Client) DeleteNodeOperation

 func (c * Client 
) DeleteNodeOperation(name string 
) * DeleteNodeOperation 
 

DeleteNodeOperation returns a new DeleteNodeOperation from a given name. The name must be that of a previously created DeleteNodeOperation, possibly from a different process.

func (*Client) GetAcceleratorType

 func (c * Client 
) GetAcceleratorType(ctx context 
. Context 
, req * tpupb 
. GetAcceleratorTypeRequest 
, opts ... gax 
. CallOption 
) (* tpupb 
. AcceleratorType 
, error 
) 

GetAcceleratorType gets AcceleratorType.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.GetAcceleratorTypeRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetAcceleratorType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

func (*Client) GetNode

 func (c * Client 
) GetNode(ctx context 
. Context 
, req * tpupb 
. GetNodeRequest 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

GetNode gets the details of a node.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.GetNodeRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetNode(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

func (*Client) GetTensorFlowVersion

 func (c * Client 
) GetTensorFlowVersion(ctx context 
. Context 
, req * tpupb 
. GetTensorFlowVersionRequest 
, opts ... gax 
. CallOption 
) (* tpupb 
. TensorFlowVersion 
, error 
) 

GetTensorFlowVersion gets TensorFlow Version.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.GetTensorFlowVersionRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetTensorFlowVersion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

func (*Client) ListAcceleratorTypes

 func (c * Client 
) ListAcceleratorTypes(ctx context 
. Context 
, req * tpupb 
. ListAcceleratorTypesRequest 
, opts ... gax 
. CallOption 
) * AcceleratorTypeIterator 
 

ListAcceleratorTypes lists accelerator types supported by this API.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	"google.golang.org/api/iterator"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.ListAcceleratorTypesRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListAcceleratorTypes(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
} 

func (*Client) ListNodes

 func (c * Client 
) ListNodes(ctx context 
. Context 
, req * tpupb 
. ListNodesRequest 
, opts ... gax 
. CallOption 
) * NodeIterator 
 

ListNodes lists nodes.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	"google.golang.org/api/iterator"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.ListNodesRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListNodes(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
} 

func (*Client) ListTensorFlowVersions

 func (c * Client 
) ListTensorFlowVersions(ctx context 
. Context 
, req * tpupb 
. ListTensorFlowVersionsRequest 
, opts ... gax 
. CallOption 
) * TensorFlowVersionIterator 
 

ListTensorFlowVersions list TensorFlow versions supported by this API.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	"google.golang.org/api/iterator"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.ListTensorFlowVersionsRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListTensorFlowVersions(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
} 

func (*Client) ReimageNode

 func (c * Client 
) ReimageNode(ctx context 
. Context 
, req * tpupb 
. ReimageNodeRequest 
, opts ... gax 
. CallOption 
) (* ReimageNodeOperation 
, error 
) 

ReimageNode reimages a node’s OS.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.ReimageNodeRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.ReimageNode(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

func (*Client) ReimageNodeOperation

 func (c * Client 
) ReimageNodeOperation(name string 
) * ReimageNodeOperation 
 

ReimageNodeOperation returns a new ReimageNodeOperation from a given name. The name must be that of a previously created ReimageNodeOperation, possibly from a different process.

func (*Client) StartNode

 func (c * Client 
) StartNode(ctx context 
. Context 
, req * tpupb 
. StartNodeRequest 
, opts ... gax 
. CallOption 
) (* StartNodeOperation 
, error 
) 

StartNode starts a node.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.StartNodeRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.StartNode(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

func (*Client) StartNodeOperation

 func (c * Client 
) StartNodeOperation(name string 
) * StartNodeOperation 
 

StartNodeOperation returns a new StartNodeOperation from a given name. The name must be that of a previously created StartNodeOperation, possibly from a different process.

func (*Client) StopNode

 func (c * Client 
) StopNode(ctx context 
. Context 
, req * tpupb 
. StopNodeRequest 
, opts ... gax 
. CallOption 
) (* StopNodeOperation 
, error 
) 

StopNode stops a node.

Example

 package main

import (
	tpu "cloud.google.com/go/tpu/apiv1"
	"context"
	tpupb "google.golang.org/genproto/googleapis/cloud/tpu/v1"
)

func main() {
	ctx := context.Background()
	c, err := tpu.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &tpupb.StopNodeRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.StopNode(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

func (*Client) StopNodeOperation

 func (c * Client 
) StopNodeOperation(name string 
) * StopNodeOperation 
 

StopNodeOperation returns a new StopNodeOperation from a given name. The name must be that of a previously created StopNodeOperation, possibly from a different process.

CreateNodeOperation

 type CreateNodeOperation struct {
	// contains filtered or unexported fields
} 

CreateNodeOperation manages a long-running operation from CreateNode.

func (*CreateNodeOperation) Done

 func (op * CreateNodeOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * CreateNodeOperation 
) Metadata() (* tpupb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateNodeOperation) Name

 func (op * CreateNodeOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateNodeOperation) Poll

 func (op * CreateNodeOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateNodeOperation) Wait

 func (op * CreateNodeOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteNodeOperation

 type DeleteNodeOperation struct {
	// contains filtered or unexported fields
} 

DeleteNodeOperation manages a long-running operation from DeleteNode.

func (*DeleteNodeOperation) Done

 func (op * DeleteNodeOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * DeleteNodeOperation 
) Metadata() (* tpupb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeleteNodeOperation) Name

 func (op * DeleteNodeOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteNodeOperation) Poll

 func (op * DeleteNodeOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeleteNodeOperation) Wait

 func (op * DeleteNodeOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

NodeIterator

 type NodeIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int 
, pageToken string 
) (results []* tpupb 
. Node 
, nextPageToken string 
, err error 
)
	// contains filtered or unexported fields
} 

NodeIterator manages a stream of *tpupb.Node.

func (*NodeIterator) Next

 func (it * NodeIterator 
) Next() (* tpupb 
. Node 
, error 
) 

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*NodeIterator) PageInfo

 func (it * NodeIterator 
) PageInfo() * iterator 
. PageInfo 
 

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

ReimageNodeOperation

 type ReimageNodeOperation struct {
	// contains filtered or unexported fields
} 

ReimageNodeOperation manages a long-running operation from ReimageNode.

func (*ReimageNodeOperation) Done

 func (op * ReimageNodeOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * ReimageNodeOperation 
) Metadata() (* tpupb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*ReimageNodeOperation) Name

 func (op * ReimageNodeOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*ReimageNodeOperation) Poll

 func (op * ReimageNodeOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*ReimageNodeOperation) Wait

 func (op * ReimageNodeOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

StartNodeOperation

 type StartNodeOperation struct {
	// contains filtered or unexported fields
} 

StartNodeOperation manages a long-running operation from StartNode.

func (*StartNodeOperation) Done

 func (op * StartNodeOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * StartNodeOperation 
) Metadata() (* tpupb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*StartNodeOperation) Name

 func (op * StartNodeOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*StartNodeOperation) Poll

 func (op * StartNodeOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*StartNodeOperation) Wait

 func (op * StartNodeOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

StopNodeOperation

 type StopNodeOperation struct {
	// contains filtered or unexported fields
} 

StopNodeOperation manages a long-running operation from StopNode.

func (*StopNodeOperation) Done

 func (op * StopNodeOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * StopNodeOperation 
) Metadata() (* tpupb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*StopNodeOperation) Name

 func (op * StopNodeOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*StopNodeOperation) Poll

 func (op * StopNodeOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*StopNodeOperation) Wait

 func (op * StopNodeOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* tpupb 
. Node 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

TensorFlowVersionIterator

 type TensorFlowVersionIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int 
, pageToken string 
) (results []* tpupb 
. TensorFlowVersion 
, nextPageToken string 
, err error 
)
	// contains filtered or unexported fields
} 

TensorFlowVersionIterator manages a stream of *tpupb.TensorFlowVersion.

func (*TensorFlowVersionIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*TensorFlowVersionIterator) PageInfo

 func (it * TensorFlowVersionIterator 
) PageInfo() * iterator 
. PageInfo 
 

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

Design a Mobile Site
View Site in Mobile | Classic
Share by: