Documentation

Overview

Package notebooks is an auto-generated package for the Notebooks API.

AI Platform Notebooks API is used to manage notebook resources in Google Cloud.

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 pkg.go.dev/cloud.google.com/go.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

    Types

    type 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

          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

            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

              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

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

                See documentation of Poll for error-handling information.

                type 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

                      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

                          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

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

                            See documentation of Poll for error-handling information.

                            type 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

                                  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

                                    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

                                      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

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

                                        See documentation of Poll for error-handling information.

                                        type 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

                                              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.

                                                    type 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

                                                        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.

                                                          type 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.

                                                                type 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.

                                                                  type NotebookClient

                                                                  type NotebookClient struct {
                                                                  
                                                                  	// LROClient is used internally to handle longrunning operations.
                                                                  	// It is exposed so that its CallOptions can be modified if required.
                                                                  	// Users should not Close this client.
                                                                  	LROClient *lroauto.OperationsClient
                                                                  
                                                                  	// The call options for this service.
                                                                  	CallOptions *NotebookCallOptions
                                                                  	// 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.

                                                                    func NewNotebookClient

                                                                    func NewNotebookClient(ctx context.Context, opts ...option.ClientOption) (*NotebookClient, error)

                                                                      NewNotebookClient creates a new notebook service client.

                                                                      API v1beta1 service for Cloud AI Platform Notebooks.

                                                                      Example
                                                                      Output:
                                                                      
                                                                      

                                                                      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

                                                                            CreateEnvironment creates a new Environment.

                                                                            Example
                                                                            Output:
                                                                            
                                                                            

                                                                            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

                                                                                CreateInstance creates a new Instance in a given project and location.

                                                                                Example
                                                                                Output:
                                                                                
                                                                                

                                                                                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

                                                                                    DeleteEnvironment deletes a single Environment.

                                                                                    Example
                                                                                    Output:
                                                                                    
                                                                                    

                                                                                    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

                                                                                        DeleteInstance deletes a single Instance.

                                                                                        Example
                                                                                        Output:
                                                                                        
                                                                                        

                                                                                        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

                                                                                            GetEnvironment gets details of a single Environment.

                                                                                            Example
                                                                                            Output:
                                                                                            
                                                                                            

                                                                                            func (*NotebookClient) GetInstance

                                                                                              GetInstance gets details of a single Instance.

                                                                                              Example
                                                                                              Output:
                                                                                              
                                                                                              

                                                                                              func (*NotebookClient) IsInstanceUpgradeable

                                                                                                IsInstanceUpgradeable check if a notebook instance is upgradable.

                                                                                                Example
                                                                                                Output:
                                                                                                
                                                                                                

                                                                                                func (*NotebookClient) ListEnvironments

                                                                                                  ListEnvironments lists environments in a project.

                                                                                                  Example
                                                                                                  Output:
                                                                                                  
                                                                                                  

                                                                                                  func (*NotebookClient) ListInstances

                                                                                                    ListInstances lists instances in a given project and location.

                                                                                                    Example
                                                                                                    Output:
                                                                                                    
                                                                                                    

                                                                                                    func (*NotebookClient) RegisterInstance

                                                                                                      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
                                                                                                      Output:
                                                                                                      
                                                                                                      

                                                                                                      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

                                                                                                          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
                                                                                                          Output:
                                                                                                          
                                                                                                          

                                                                                                          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

                                                                                                              ResetInstance resets a notebook instance.

                                                                                                              Example
                                                                                                              Output:
                                                                                                              
                                                                                                              

                                                                                                              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

                                                                                                                  SetInstanceAccelerator updates the guest accelerators of a single Instance.

                                                                                                                  Example
                                                                                                                  Output:
                                                                                                                  
                                                                                                                  

                                                                                                                  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

                                                                                                                      SetInstanceLabels updates the labels of an Instance.

                                                                                                                      Example
                                                                                                                      Output:
                                                                                                                      
                                                                                                                      

                                                                                                                      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

                                                                                                                          SetInstanceMachineType updates the machine type of a single Instance.

                                                                                                                          Example
                                                                                                                          Output:
                                                                                                                          
                                                                                                                          

                                                                                                                          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

                                                                                                                              StartInstance starts a notebook instance.

                                                                                                                              Example
                                                                                                                              Output:
                                                                                                                              
                                                                                                                              

                                                                                                                              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

                                                                                                                                  StopInstance stops a notebook instance.

                                                                                                                                  Example
                                                                                                                                  Output:
                                                                                                                                  
                                                                                                                                  

                                                                                                                                  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

                                                                                                                                      UpgradeInstance upgrades a notebook instance to the latest version.

                                                                                                                                      Example
                                                                                                                                      Output:
                                                                                                                                      
                                                                                                                                      

                                                                                                                                      func (*NotebookClient) UpgradeInstanceInternal

                                                                                                                                        UpgradeInstanceInternal allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

                                                                                                                                        Example
                                                                                                                                        Output:
                                                                                                                                        
                                                                                                                                        

                                                                                                                                        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.

                                                                                                                                            type 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

                                                                                                                                                  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

                                                                                                                                                      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

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

                                                                                                                                                        See documentation of Poll for error-handling information.

                                                                                                                                                        type 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

                                                                                                                                                              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

                                                                                                                                                                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

                                                                                                                                                                  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

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

                                                                                                                                                                    See documentation of Poll for error-handling information.

                                                                                                                                                                    type 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

                                                                                                                                                                          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

                                                                                                                                                                              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

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

                                                                                                                                                                                See documentation of Poll for error-handling information.

                                                                                                                                                                                type SetInstanceAcceleratorOperation

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

                                                                                                                                                                                  SetInstanceAcceleratorOperation manages a long-running operation from SetInstanceAccelerator.

                                                                                                                                                                                  func (*SetInstanceAcceleratorOperation) Done

                                                                                                                                                                                    Done reports whether the long-running operation has completed.

                                                                                                                                                                                    func (*SetInstanceAcceleratorOperation) Metadata

                                                                                                                                                                                      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

                                                                                                                                                                                        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

                                                                                                                                                                                          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

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

                                                                                                                                                                                            See documentation of Poll for error-handling information.

                                                                                                                                                                                            type 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

                                                                                                                                                                                                  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

                                                                                                                                                                                                    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

                                                                                                                                                                                                      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

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

                                                                                                                                                                                                        See documentation of Poll for error-handling information.

                                                                                                                                                                                                        type SetInstanceMachineTypeOperation

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

                                                                                                                                                                                                          SetInstanceMachineTypeOperation manages a long-running operation from SetInstanceMachineType.

                                                                                                                                                                                                          func (*SetInstanceMachineTypeOperation) Done

                                                                                                                                                                                                            Done reports whether the long-running operation has completed.

                                                                                                                                                                                                            func (*SetInstanceMachineTypeOperation) Metadata

                                                                                                                                                                                                              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

                                                                                                                                                                                                                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

                                                                                                                                                                                                                  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

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

                                                                                                                                                                                                                    See documentation of Poll for error-handling information.

                                                                                                                                                                                                                    type 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

                                                                                                                                                                                                                          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

                                                                                                                                                                                                                              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

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

                                                                                                                                                                                                                                See documentation of Poll for error-handling information.

                                                                                                                                                                                                                                type 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

                                                                                                                                                                                                                                      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

                                                                                                                                                                                                                                          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

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

                                                                                                                                                                                                                                            See documentation of Poll for error-handling information.

                                                                                                                                                                                                                                            type UpgradeInstanceInternalOperation

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

                                                                                                                                                                                                                                              UpgradeInstanceInternalOperation manages a long-running operation from UpgradeInstanceInternal.

                                                                                                                                                                                                                                              func (*UpgradeInstanceInternalOperation) Done

                                                                                                                                                                                                                                                Done reports whether the long-running operation has completed.

                                                                                                                                                                                                                                                func (*UpgradeInstanceInternalOperation) Metadata

                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                      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

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

                                                                                                                                                                                                                                                        See documentation of Poll for error-handling information.

                                                                                                                                                                                                                                                        type 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

                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                  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

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

                                                                                                                                                                                                                                                                    See documentation of Poll for error-handling information.