Package notebooks is an auto-generated package for the Notebooks API.
AI Platform Notebooks API is used to manage notebook resources in Google Cloud.
NOTE: This package is in beta. It is not stable, and may be subject to changes.
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.
CreateEnvironmentOperation
type CreateEnvironmentOperation struct {
// contains filtered or unexported fields
}
CreateEnvironmentOperation manages a long-running operation from CreateEnvironment.
func (*CreateEnvironmentOperation) Done
func (op * CreateEnvironmentOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateEnvironmentOperation) Metadata
func (op * CreateEnvironmentOperation
) Metadata() (* notebookspb
. 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 (*CreateEnvironmentOperation) Name
func (op * CreateEnvironmentOperation
) 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 (*CreateEnvironmentOperation) Poll
func (op * CreateEnvironmentOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Environment
, 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 (*CreateEnvironmentOperation) Wait
func (op * CreateEnvironmentOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Environment
, 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.
CreateInstanceOperation
type CreateInstanceOperation struct {
// contains filtered or unexported fields
}
CreateInstanceOperation manages a long-running operation from CreateInstance.
func (*CreateInstanceOperation) Done
func (op * CreateInstanceOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateInstanceOperation) Metadata
func (op * CreateInstanceOperation
) Metadata() (* notebookspb
. 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 (*CreateInstanceOperation) Name
func (op * CreateInstanceOperation
) 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 (*CreateInstanceOperation) Poll
func (op * CreateInstanceOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*CreateInstanceOperation) Wait
func (op * CreateInstanceOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
DeleteEnvironmentOperation
type DeleteEnvironmentOperation struct {
// contains filtered or unexported fields
}
DeleteEnvironmentOperation manages a long-running operation from DeleteEnvironment.
func (*DeleteEnvironmentOperation) Done
func (op * DeleteEnvironmentOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteEnvironmentOperation) Metadata
func (op * DeleteEnvironmentOperation
) Metadata() (* notebookspb
. 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 (*DeleteEnvironmentOperation) Name
func (op * DeleteEnvironmentOperation
) 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 (*DeleteEnvironmentOperation) Poll
func (op * DeleteEnvironmentOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) 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 (*DeleteEnvironmentOperation) Wait
func (op * DeleteEnvironmentOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) 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.
DeleteInstanceOperation
type DeleteInstanceOperation struct {
// contains filtered or unexported fields
}
DeleteInstanceOperation manages a long-running operation from DeleteInstance.
func (*DeleteInstanceOperation) Done
func (op * DeleteInstanceOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteInstanceOperation) Metadata
func (op * DeleteInstanceOperation
) Metadata() (* notebookspb
. 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 (*DeleteInstanceOperation) Name
func (op * DeleteInstanceOperation
) 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 (*DeleteInstanceOperation) Poll
func (op * DeleteInstanceOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) 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 (*DeleteInstanceOperation) Wait
func (op * DeleteInstanceOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) 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.
EnvironmentIterator
type EnvironmentIterator 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 []* notebookspb
. Environment
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
EnvironmentIterator manages a stream of *notebookspb.Environment.
func (*EnvironmentIterator) Next
func (it * EnvironmentIterator
) Next() (* notebookspb
. Environment
, 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 (*EnvironmentIterator) PageInfo
func (it * EnvironmentIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
InstanceIterator
type InstanceIterator 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 []* notebookspb
. Instance
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
InstanceIterator manages a stream of *notebookspb.Instance.
func (*InstanceIterator) Next
func (it * InstanceIterator
) Next() (* notebookspb
. Instance
, 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 (*InstanceIterator) PageInfo
func (it * InstanceIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
NotebookCallOptions
type NotebookCallOptions struct {
ListInstances [] gax
. CallOption
GetInstance [] gax
. CallOption
CreateInstance [] gax
. CallOption
RegisterInstance [] gax
. CallOption
SetInstanceAccelerator [] gax
. CallOption
SetInstanceMachineType [] gax
. CallOption
SetInstanceLabels [] gax
. CallOption
DeleteInstance [] gax
. CallOption
StartInstance [] gax
. CallOption
StopInstance [] gax
. CallOption
ResetInstance [] gax
. CallOption
ReportInstanceInfo [] gax
. CallOption
IsInstanceUpgradeable [] gax
. CallOption
UpgradeInstance [] gax
. CallOption
UpgradeInstanceInternal [] gax
. CallOption
ListEnvironments [] gax
. CallOption
GetEnvironment [] gax
. CallOption
CreateEnvironment [] gax
. CallOption
DeleteEnvironment [] gax
. CallOption
}
NotebookCallOptions contains the retry settings for each method of NotebookClient.
NotebookClient
type NotebookClient struct {
// The call options for this service.
CallOptions * NotebookCallOptions
// 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
}
NotebookClient is a client for interacting with Notebooks API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
API v1beta1 service for Cloud AI Platform Notebooks.
func NewNotebookClient
func NewNotebookClient(ctx context
. Context
, opts ... option
. ClientOption
) (* NotebookClient
, error
)
NewNotebookClient creates a new notebook service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
API v1beta1 service for Cloud AI Platform Notebooks.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*NotebookClient) Close
func (c * NotebookClient
) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*NotebookClient) Connection
func (c * NotebookClient
) Connection() * grpc
. ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*NotebookClient) CreateEnvironment
func (c * NotebookClient
) CreateEnvironment(ctx context
. Context
, req * notebookspb
. CreateEnvironmentRequest
, opts ... gax
. CallOption
) (* CreateEnvironmentOperation
, error
)
CreateEnvironment creates a new Environment.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.CreateEnvironmentRequest{
// TODO: Fill request struct fields.
}
op, err := c.CreateEnvironment(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) CreateEnvironmentOperation
func (c * NotebookClient
) CreateEnvironmentOperation(name string
) * CreateEnvironmentOperation
CreateEnvironmentOperation returns a new CreateEnvironmentOperation from a given name. The name must be that of a previously created CreateEnvironmentOperation, possibly from a different process.
func (*NotebookClient) CreateInstance
func (c * NotebookClient
) CreateInstance(ctx context
. Context
, req * notebookspb
. CreateInstanceRequest
, opts ... gax
. CallOption
) (* CreateInstanceOperation
, error
)
CreateInstance creates a new Instance in a given project and location.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.CreateInstanceRequest{
// TODO: Fill request struct fields.
}
op, err := c.CreateInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) CreateInstanceOperation
func (c * NotebookClient
) CreateInstanceOperation(name string
) * CreateInstanceOperation
CreateInstanceOperation returns a new CreateInstanceOperation from a given name. The name must be that of a previously created CreateInstanceOperation, possibly from a different process.
func (*NotebookClient) DeleteEnvironment
func (c * NotebookClient
) DeleteEnvironment(ctx context
. Context
, req * notebookspb
. DeleteEnvironmentRequest
, opts ... gax
. CallOption
) (* DeleteEnvironmentOperation
, error
)
DeleteEnvironment deletes a single Environment.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.DeleteEnvironmentRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteEnvironment(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*NotebookClient) DeleteEnvironmentOperation
func (c * NotebookClient
) DeleteEnvironmentOperation(name string
) * DeleteEnvironmentOperation
DeleteEnvironmentOperation returns a new DeleteEnvironmentOperation from a given name. The name must be that of a previously created DeleteEnvironmentOperation, possibly from a different process.
func (*NotebookClient) DeleteInstance
func (c * NotebookClient
) DeleteInstance(ctx context
. Context
, req * notebookspb
. DeleteInstanceRequest
, opts ... gax
. CallOption
) (* DeleteInstanceOperation
, error
)
DeleteInstance deletes a single Instance.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.DeleteInstanceRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*NotebookClient) DeleteInstanceOperation
func (c * NotebookClient
) DeleteInstanceOperation(name string
) * DeleteInstanceOperation
DeleteInstanceOperation returns a new DeleteInstanceOperation from a given name. The name must be that of a previously created DeleteInstanceOperation, possibly from a different process.
func (*NotebookClient) GetEnvironment
func (c * NotebookClient
) GetEnvironment(ctx context
. Context
, req * notebookspb
. GetEnvironmentRequest
, opts ... gax
. CallOption
) (* notebookspb
. Environment
, error
)
GetEnvironment gets details of a single Environment.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.GetEnvironmentRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetEnvironment(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) GetInstance
func (c * NotebookClient
) GetInstance(ctx context
. Context
, req * notebookspb
. GetInstanceRequest
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, error
)
GetInstance gets details of a single Instance.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.GetInstanceRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) IsInstanceUpgradeable
func (c * NotebookClient
) IsInstanceUpgradeable(ctx context
. Context
, req * notebookspb
. IsInstanceUpgradeableRequest
, opts ... gax
. CallOption
) (* notebookspb
. IsInstanceUpgradeableResponse
, error
)
IsInstanceUpgradeable check if a notebook instance is upgradable.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.IsInstanceUpgradeableRequest{
// TODO: Fill request struct fields.
}
resp, err := c.IsInstanceUpgradeable(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) ListEnvironments
func (c * NotebookClient
) ListEnvironments(ctx context
. Context
, req * notebookspb
. ListEnvironmentsRequest
, opts ... gax
. CallOption
) * EnvironmentIterator
ListEnvironments lists environments in a project.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
"google.golang.org/api/iterator"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ListEnvironmentsRequest{
// TODO: Fill request struct fields.
}
it := c.ListEnvironments(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*NotebookClient) ListInstances
func (c * NotebookClient
) ListInstances(ctx context
. Context
, req * notebookspb
. ListInstancesRequest
, opts ... gax
. CallOption
) * InstanceIterator
ListInstances lists instances in a given project and location.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
"google.golang.org/api/iterator"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ListInstancesRequest{
// TODO: Fill request struct fields.
}
it := c.ListInstances(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*NotebookClient) RegisterInstance
func (c * NotebookClient
) RegisterInstance(ctx context
. Context
, req * notebookspb
. RegisterInstanceRequest
, opts ... gax
. CallOption
) (* RegisterInstanceOperation
, error
)
RegisterInstance registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.RegisterInstanceRequest{
// TODO: Fill request struct fields.
}
op, err := c.RegisterInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) RegisterInstanceOperation
func (c * NotebookClient
) RegisterInstanceOperation(name string
) * RegisterInstanceOperation
RegisterInstanceOperation returns a new RegisterInstanceOperation from a given name. The name must be that of a previously created RegisterInstanceOperation, possibly from a different process.
func (*NotebookClient) ReportInstanceInfo
func (c * NotebookClient
) ReportInstanceInfo(ctx context
. Context
, req * notebookspb
. ReportInstanceInfoRequest
, opts ... gax
. CallOption
) (* ReportInstanceInfoOperation
, error
)
ReportInstanceInfo allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ReportInstanceInfoRequest{
// TODO: Fill request struct fields.
}
op, err := c.ReportInstanceInfo(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) ReportInstanceInfoOperation
func (c * NotebookClient
) ReportInstanceInfoOperation(name string
) * ReportInstanceInfoOperation
ReportInstanceInfoOperation returns a new ReportInstanceInfoOperation from a given name. The name must be that of a previously created ReportInstanceInfoOperation, possibly from a different process.
func (*NotebookClient) ResetInstance
func (c * NotebookClient
) ResetInstance(ctx context
. Context
, req * notebookspb
. ResetInstanceRequest
, opts ... gax
. CallOption
) (* ResetInstanceOperation
, error
)
ResetInstance resets a notebook instance.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ResetInstanceRequest{
// TODO: Fill request struct fields.
}
op, err := c.ResetInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) ResetInstanceOperation
func (c * NotebookClient
) ResetInstanceOperation(name string
) * ResetInstanceOperation
ResetInstanceOperation returns a new ResetInstanceOperation from a given name. The name must be that of a previously created ResetInstanceOperation, possibly from a different process.
func (*NotebookClient) SetInstanceAccelerator
func (c * NotebookClient
) SetInstanceAccelerator(ctx context
. Context
, req * notebookspb
. SetInstanceAcceleratorRequest
, opts ... gax
. CallOption
) (* SetInstanceAcceleratorOperation
, error
)
SetInstanceAccelerator updates the guest accelerators of a single Instance.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.SetInstanceAcceleratorRequest{
// TODO: Fill request struct fields.
}
op, err := c.SetInstanceAccelerator(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) SetInstanceAcceleratorOperation
func (c * NotebookClient
) SetInstanceAcceleratorOperation(name string
) * SetInstanceAcceleratorOperation
SetInstanceAcceleratorOperation returns a new SetInstanceAcceleratorOperation from a given name. The name must be that of a previously created SetInstanceAcceleratorOperation, possibly from a different process.
func (*NotebookClient) SetInstanceLabels
func (c * NotebookClient
) SetInstanceLabels(ctx context
. Context
, req * notebookspb
. SetInstanceLabelsRequest
, opts ... gax
. CallOption
) (* SetInstanceLabelsOperation
, error
)
SetInstanceLabels updates the labels of an Instance.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.SetInstanceLabelsRequest{
// TODO: Fill request struct fields.
}
op, err := c.SetInstanceLabels(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) SetInstanceLabelsOperation
func (c * NotebookClient
) SetInstanceLabelsOperation(name string
) * SetInstanceLabelsOperation
SetInstanceLabelsOperation returns a new SetInstanceLabelsOperation from a given name. The name must be that of a previously created SetInstanceLabelsOperation, possibly from a different process.
func (*NotebookClient) SetInstanceMachineType
func (c * NotebookClient
) SetInstanceMachineType(ctx context
. Context
, req * notebookspb
. SetInstanceMachineTypeRequest
, opts ... gax
. CallOption
) (* SetInstanceMachineTypeOperation
, error
)
SetInstanceMachineType updates the machine type of a single Instance.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.SetInstanceMachineTypeRequest{
// TODO: Fill request struct fields.
}
op, err := c.SetInstanceMachineType(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) SetInstanceMachineTypeOperation
func (c * NotebookClient
) SetInstanceMachineTypeOperation(name string
) * SetInstanceMachineTypeOperation
SetInstanceMachineTypeOperation returns a new SetInstanceMachineTypeOperation from a given name. The name must be that of a previously created SetInstanceMachineTypeOperation, possibly from a different process.
func (*NotebookClient) StartInstance
func (c * NotebookClient
) StartInstance(ctx context
. Context
, req * notebookspb
. StartInstanceRequest
, opts ... gax
. CallOption
) (* StartInstanceOperation
, error
)
StartInstance starts a notebook instance.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.StartInstanceRequest{
// TODO: Fill request struct fields.
}
op, err := c.StartInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) StartInstanceOperation
func (c * NotebookClient
) StartInstanceOperation(name string
) * StartInstanceOperation
StartInstanceOperation returns a new StartInstanceOperation from a given name. The name must be that of a previously created StartInstanceOperation, possibly from a different process.
func (*NotebookClient) StopInstance
func (c * NotebookClient
) StopInstance(ctx context
. Context
, req * notebookspb
. StopInstanceRequest
, opts ... gax
. CallOption
) (* StopInstanceOperation
, error
)
StopInstance stops a notebook instance.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.StopInstanceRequest{
// TODO: Fill request struct fields.
}
op, err := c.StopInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) StopInstanceOperation
func (c * NotebookClient
) StopInstanceOperation(name string
) * StopInstanceOperation
StopInstanceOperation returns a new StopInstanceOperation from a given name. The name must be that of a previously created StopInstanceOperation, possibly from a different process.
func (*NotebookClient) UpgradeInstance
func (c * NotebookClient
) UpgradeInstance(ctx context
. Context
, req * notebookspb
. UpgradeInstanceRequest
, opts ... gax
. CallOption
) (* UpgradeInstanceOperation
, error
)
UpgradeInstance upgrades a notebook instance to the latest version.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.UpgradeInstanceRequest{
// TODO: Fill request struct fields.
}
op, err := c.UpgradeInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) UpgradeInstanceInternal
func (c * NotebookClient
) UpgradeInstanceInternal(ctx context
. Context
, req * notebookspb
. UpgradeInstanceInternalRequest
, opts ... gax
. CallOption
) (* UpgradeInstanceInternalOperation
, error
)
UpgradeInstanceInternal allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.
Example
package main
import (
notebooks "cloud.google.com/go/notebooks/apiv1beta1"
"context"
notebookspb "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1"
)
func main() {
ctx := context.Background()
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.UpgradeInstanceInternalRequest{
// TODO: Fill request struct fields.
}
op, err := c.UpgradeInstanceInternal(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) UpgradeInstanceInternalOperation
func (c * NotebookClient
) UpgradeInstanceInternalOperation(name string
) * UpgradeInstanceInternalOperation
UpgradeInstanceInternalOperation returns a new UpgradeInstanceInternalOperation from a given name. The name must be that of a previously created UpgradeInstanceInternalOperation, possibly from a different process.
func (*NotebookClient) UpgradeInstanceOperation
func (c * NotebookClient
) UpgradeInstanceOperation(name string
) * UpgradeInstanceOperation
UpgradeInstanceOperation returns a new UpgradeInstanceOperation from a given name. The name must be that of a previously created UpgradeInstanceOperation, possibly from a different process.
RegisterInstanceOperation
type RegisterInstanceOperation struct {
// contains filtered or unexported fields
}
RegisterInstanceOperation manages a long-running operation from RegisterInstance.
func (*RegisterInstanceOperation) Done
func (op * RegisterInstanceOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*RegisterInstanceOperation) Metadata
func (op * RegisterInstanceOperation
) Metadata() (* notebookspb
. 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 (*RegisterInstanceOperation) Name
func (op * RegisterInstanceOperation
) 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 (*RegisterInstanceOperation) Poll
func (op * RegisterInstanceOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*RegisterInstanceOperation) Wait
func (op * RegisterInstanceOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
ReportInstanceInfoOperation
type ReportInstanceInfoOperation struct {
// contains filtered or unexported fields
}
ReportInstanceInfoOperation manages a long-running operation from ReportInstanceInfo.
func (*ReportInstanceInfoOperation) Done
func (op * ReportInstanceInfoOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*ReportInstanceInfoOperation) Metadata
func (op * ReportInstanceInfoOperation
) Metadata() (* notebookspb
. 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 (*ReportInstanceInfoOperation) Name
func (op * ReportInstanceInfoOperation
) 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 (*ReportInstanceInfoOperation) Poll
func (op * ReportInstanceInfoOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*ReportInstanceInfoOperation) Wait
func (op * ReportInstanceInfoOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
ResetInstanceOperation
type ResetInstanceOperation struct {
// contains filtered or unexported fields
}
ResetInstanceOperation manages a long-running operation from ResetInstance.
func (*ResetInstanceOperation) Done
func (op * ResetInstanceOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*ResetInstanceOperation) Metadata
func (op * ResetInstanceOperation
) Metadata() (* notebookspb
. 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 (*ResetInstanceOperation) Name
func (op * ResetInstanceOperation
) 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 (*ResetInstanceOperation) Poll
func (op * ResetInstanceOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*ResetInstanceOperation) Wait
func (op * ResetInstanceOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
SetInstanceAcceleratorOperation
type SetInstanceAcceleratorOperation struct {
// contains filtered or unexported fields
}
SetInstanceAcceleratorOperation manages a long-running operation from SetInstanceAccelerator.
func (*SetInstanceAcceleratorOperation) Done
func (op * SetInstanceAcceleratorOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*SetInstanceAcceleratorOperation) Metadata
func (op * SetInstanceAcceleratorOperation
) Metadata() (* notebookspb
. 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 (*SetInstanceAcceleratorOperation) Name
func (op * SetInstanceAcceleratorOperation
) 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 (*SetInstanceAcceleratorOperation) Poll
func (op * SetInstanceAcceleratorOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*SetInstanceAcceleratorOperation) Wait
func (op * SetInstanceAcceleratorOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
SetInstanceLabelsOperation
type SetInstanceLabelsOperation struct {
// contains filtered or unexported fields
}
SetInstanceLabelsOperation manages a long-running operation from SetInstanceLabels.
func (*SetInstanceLabelsOperation) Done
func (op * SetInstanceLabelsOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*SetInstanceLabelsOperation) Metadata
func (op * SetInstanceLabelsOperation
) Metadata() (* notebookspb
. 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 (*SetInstanceLabelsOperation) Name
func (op * SetInstanceLabelsOperation
) 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 (*SetInstanceLabelsOperation) Poll
func (op * SetInstanceLabelsOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*SetInstanceLabelsOperation) Wait
func (op * SetInstanceLabelsOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
SetInstanceMachineTypeOperation
type SetInstanceMachineTypeOperation struct {
// contains filtered or unexported fields
}
SetInstanceMachineTypeOperation manages a long-running operation from SetInstanceMachineType.
func (*SetInstanceMachineTypeOperation) Done
func (op * SetInstanceMachineTypeOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*SetInstanceMachineTypeOperation) Metadata
func (op * SetInstanceMachineTypeOperation
) Metadata() (* notebookspb
. 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 (*SetInstanceMachineTypeOperation) Name
func (op * SetInstanceMachineTypeOperation
) 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 (*SetInstanceMachineTypeOperation) Poll
func (op * SetInstanceMachineTypeOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*SetInstanceMachineTypeOperation) Wait
func (op * SetInstanceMachineTypeOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
StartInstanceOperation
type StartInstanceOperation struct {
// contains filtered or unexported fields
}
StartInstanceOperation manages a long-running operation from StartInstance.
func (*StartInstanceOperation) Done
func (op * StartInstanceOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*StartInstanceOperation) Metadata
func (op * StartInstanceOperation
) Metadata() (* notebookspb
. 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 (*StartInstanceOperation) Name
func (op * StartInstanceOperation
) 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 (*StartInstanceOperation) Poll
func (op * StartInstanceOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*StartInstanceOperation) Wait
func (op * StartInstanceOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
StopInstanceOperation
type StopInstanceOperation struct {
// contains filtered or unexported fields
}
StopInstanceOperation manages a long-running operation from StopInstance.
func (*StopInstanceOperation) Done
func (op * StopInstanceOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*StopInstanceOperation) Metadata
func (op * StopInstanceOperation
) Metadata() (* notebookspb
. 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 (*StopInstanceOperation) Name
func (op * StopInstanceOperation
) 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 (*StopInstanceOperation) Poll
func (op * StopInstanceOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*StopInstanceOperation) Wait
func (op * StopInstanceOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
UpgradeInstanceInternalOperation
type UpgradeInstanceInternalOperation struct {
// contains filtered or unexported fields
}
UpgradeInstanceInternalOperation manages a long-running operation from UpgradeInstanceInternal.
func (*UpgradeInstanceInternalOperation) Done
func (op * UpgradeInstanceInternalOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*UpgradeInstanceInternalOperation) Metadata
func (op * UpgradeInstanceInternalOperation
) Metadata() (* notebookspb
. 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 (*UpgradeInstanceInternalOperation) Name
func (op * UpgradeInstanceInternalOperation
) 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 (*UpgradeInstanceInternalOperation) Poll
func (op * UpgradeInstanceInternalOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*UpgradeInstanceInternalOperation) Wait
func (op * UpgradeInstanceInternalOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
UpgradeInstanceOperation
type UpgradeInstanceOperation struct {
// contains filtered or unexported fields
}
UpgradeInstanceOperation manages a long-running operation from UpgradeInstance.
func (*UpgradeInstanceOperation) Done
func (op * UpgradeInstanceOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*UpgradeInstanceOperation) Metadata
func (op * UpgradeInstanceOperation
) Metadata() (* notebookspb
. 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 (*UpgradeInstanceOperation) Name
func (op * UpgradeInstanceOperation
) 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 (*UpgradeInstanceOperation) Poll
func (op * UpgradeInstanceOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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 (*UpgradeInstanceOperation) Wait
func (op * UpgradeInstanceOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* notebookspb
. Instance
, 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.
