Package cloud.google.com/go/notebooks/apiv1 (v0.4.0)

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

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

NOTE: This package is in beta. It is not stable, and may be subject to changes.

Example usage

To get started with this package, create a client.

ctx := context.Background()
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &notebookspb.ListRuntimesRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#ListRuntimesRequest.
}
it := c.ListRuntimes(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

Use of Context

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

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

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

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

CreateEnvironmentOperation

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

CreateEnvironmentOperation manages a long-running operation from CreateEnvironment.

func (*CreateEnvironmentOperation) Done

func (op *CreateEnvironmentOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateEnvironmentOperation) Metadata

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.

CreateExecutionOperation

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

CreateExecutionOperation manages a long-running operation from CreateExecution.

func (*CreateExecutionOperation) Done

func (op *CreateExecutionOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateExecutionOperation) 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 (*CreateExecutionOperation) Name

func (op *CreateExecutionOperation) 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 (*CreateExecutionOperation) 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 (*CreateExecutionOperation) 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.

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.

CreateRuntimeOperation

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

CreateRuntimeOperation manages a long-running operation from CreateRuntime.

func (*CreateRuntimeOperation) Done

func (op *CreateRuntimeOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateRuntimeOperation) 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 (*CreateRuntimeOperation) Name

func (op *CreateRuntimeOperation) 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 (*CreateRuntimeOperation) 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 (*CreateRuntimeOperation) 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.

CreateScheduleOperation

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

CreateScheduleOperation manages a long-running operation from CreateSchedule.

func (*CreateScheduleOperation) Done

func (op *CreateScheduleOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateScheduleOperation) 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 (*CreateScheduleOperation) Name

func (op *CreateScheduleOperation) 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 (*CreateScheduleOperation) 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 (*CreateScheduleOperation) 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.

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.

DeleteExecutionOperation

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

DeleteExecutionOperation manages a long-running operation from DeleteExecution.

func (*DeleteExecutionOperation) Done

func (op *DeleteExecutionOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteExecutionOperation) 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 (*DeleteExecutionOperation) Name

func (op *DeleteExecutionOperation) 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 (*DeleteExecutionOperation) 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 (*DeleteExecutionOperation) 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.

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.

DeleteRuntimeOperation

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

DeleteRuntimeOperation manages a long-running operation from DeleteRuntime.

func (*DeleteRuntimeOperation) Done

func (op *DeleteRuntimeOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteRuntimeOperation) 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 (*DeleteRuntimeOperation) Name

func (op *DeleteRuntimeOperation) 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 (*DeleteRuntimeOperation) Poll

func (op *DeleteRuntimeOperation) 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 (*DeleteRuntimeOperation) Wait

func (op *DeleteRuntimeOperation) 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.

DeleteScheduleOperation

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

DeleteScheduleOperation manages a long-running operation from DeleteSchedule.

func (*DeleteScheduleOperation) Done

func (op *DeleteScheduleOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteScheduleOperation) 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 (*DeleteScheduleOperation) Name

func (op *DeleteScheduleOperation) 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 (*DeleteScheduleOperation) Poll

func (op *DeleteScheduleOperation) 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 (*DeleteScheduleOperation) Wait

func (op *DeleteScheduleOperation) Wait(ctx context.Context, opts ...gax.CallOption) error

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

See documentation of Poll for error-handling information.

EnvironmentIterator

type EnvironmentIterator struct {

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

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

EnvironmentIterator manages a stream of *notebookspb.Environment.

func (*EnvironmentIterator) Next

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.

ExecutionIterator

type ExecutionIterator 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.Execution, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ExecutionIterator manages a stream of *notebookspb.Execution.

func (*ExecutionIterator) 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 (*ExecutionIterator) PageInfo

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

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

InstanceIterator

type InstanceIterator struct {

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

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

InstanceIterator manages a stream of *notebookspb.Instance.

func (*InstanceIterator) Next

func (it *InstanceIterator) Next() (*notebookspb.Instance, error)

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

func (*InstanceIterator) PageInfo

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

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

ManagedNotebookCallOptions

type ManagedNotebookCallOptions struct {
	ListRuntimes                []gax.CallOption
	GetRuntime                  []gax.CallOption
	CreateRuntime               []gax.CallOption
	DeleteRuntime               []gax.CallOption
	StartRuntime                []gax.CallOption
	StopRuntime                 []gax.CallOption
	SwitchRuntime               []gax.CallOption
	ResetRuntime                []gax.CallOption
	ReportRuntimeEvent          []gax.CallOption
	RefreshRuntimeTokenInternal []gax.CallOption
}

ManagedNotebookCallOptions contains the retry settings for each method of ManagedNotebookClient.

ManagedNotebookClient

type ManagedNotebookClient struct {

	// The call options for this service.
	CallOptions *ManagedNotebookCallOptions

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

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

API v1 service for Managed Notebooks.

func NewManagedNotebookClient

func NewManagedNotebookClient(ctx context.Context, opts ...option.ClientOption) (*ManagedNotebookClient, error)

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

API v1 service for Managed Notebooks.

Example

package main

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

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

	// TODO: Use client.
	_ = c
}

func (*ManagedNotebookClient) Close

func (c *ManagedNotebookClient) Close() error

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

func (*ManagedNotebookClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*ManagedNotebookClient) CreateRuntime

CreateRuntime creates a new Runtime in a given project and location.

Example

package main

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

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

	req := &notebookspb.CreateRuntimeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#CreateRuntimeRequest.
	}
	op, err := c.CreateRuntime(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*ManagedNotebookClient) CreateRuntimeOperation

func (c *ManagedNotebookClient) CreateRuntimeOperation(name string) *CreateRuntimeOperation

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

func (*ManagedNotebookClient) DeleteRuntime

DeleteRuntime deletes a single Runtime.

Example

package main

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

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

	req := &notebookspb.DeleteRuntimeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#DeleteRuntimeRequest.
	}
	op, err := c.DeleteRuntime(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*ManagedNotebookClient) DeleteRuntimeOperation

func (c *ManagedNotebookClient) DeleteRuntimeOperation(name string) *DeleteRuntimeOperation

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

func (*ManagedNotebookClient) GetRuntime

GetRuntime gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Example

package main

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

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

	req := &notebookspb.GetRuntimeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#GetRuntimeRequest.
	}
	resp, err := c.GetRuntime(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ManagedNotebookClient) ListRuntimes

ListRuntimes lists Runtimes in a given project and location.

Example

package main

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

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

	req := &notebookspb.ListRuntimesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#ListRuntimesRequest.
	}
	it := c.ListRuntimes(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*ManagedNotebookClient) RefreshRuntimeTokenInternal

RefreshRuntimeTokenInternal gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

Example

package main

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

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

	req := &notebookspb.RefreshRuntimeTokenInternalRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#RefreshRuntimeTokenInternalRequest.
	}
	resp, err := c.RefreshRuntimeTokenInternal(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*ManagedNotebookClient) ReportRuntimeEvent

ReportRuntimeEvent report and process a runtime event.

Example

package main

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

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

	req := &notebookspb.ReportRuntimeEventRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#ReportRuntimeEventRequest.
	}
	op, err := c.ReportRuntimeEvent(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*ManagedNotebookClient) ReportRuntimeEventOperation

func (c *ManagedNotebookClient) ReportRuntimeEventOperation(name string) *ReportRuntimeEventOperation

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

func (*ManagedNotebookClient) ResetRuntime

ResetRuntime resets a Managed Notebook Runtime.

Example

package main

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

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

	req := &notebookspb.ResetRuntimeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#ResetRuntimeRequest.
	}
	op, err := c.ResetRuntime(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*ManagedNotebookClient) ResetRuntimeOperation

func (c *ManagedNotebookClient) ResetRuntimeOperation(name string) *ResetRuntimeOperation

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

func (*ManagedNotebookClient) StartRuntime

Example

package main

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

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

	req := &notebookspb.StartRuntimeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#StartRuntimeRequest.
	}
	op, err := c.StartRuntime(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*ManagedNotebookClient) StartRuntimeOperation

func (c *ManagedNotebookClient) StartRuntimeOperation(name string) *StartRuntimeOperation

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

func (*ManagedNotebookClient) StopRuntime

Example

package main

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

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

	req := &notebookspb.StopRuntimeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#StopRuntimeRequest.
	}
	op, err := c.StopRuntime(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*ManagedNotebookClient) StopRuntimeOperation

func (c *ManagedNotebookClient) StopRuntimeOperation(name string) *StopRuntimeOperation

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

func (*ManagedNotebookClient) SwitchRuntime

SwitchRuntime switch a Managed Notebook Runtime.

Example

package main

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

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

	req := &notebookspb.SwitchRuntimeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#SwitchRuntimeRequest.
	}
	op, err := c.SwitchRuntime(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*ManagedNotebookClient) SwitchRuntimeOperation

func (c *ManagedNotebookClient) SwitchRuntimeOperation(name string) *SwitchRuntimeOperation

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

NotebookCallOptions

type NotebookCallOptions struct {
	ListInstances                []gax.CallOption
	GetInstance                  []gax.CallOption
	CreateInstance               []gax.CallOption
	RegisterInstance             []gax.CallOption
	SetInstanceAccelerator       []gax.CallOption
	SetInstanceMachineType       []gax.CallOption
	UpdateInstanceConfig         []gax.CallOption
	UpdateShieldedInstanceConfig []gax.CallOption
	SetInstanceLabels            []gax.CallOption
	UpdateInstanceMetadataItems  []gax.CallOption
	DeleteInstance               []gax.CallOption
	StartInstance                []gax.CallOption
	StopInstance                 []gax.CallOption
	ResetInstance                []gax.CallOption
	ReportInstanceInfo           []gax.CallOption
	IsInstanceUpgradeable        []gax.CallOption
	GetInstanceHealth            []gax.CallOption
	UpgradeInstance              []gax.CallOption
	RollbackInstance             []gax.CallOption
	UpgradeInstanceInternal      []gax.CallOption
	ListEnvironments             []gax.CallOption
	GetEnvironment               []gax.CallOption
	CreateEnvironment            []gax.CallOption
	DeleteEnvironment            []gax.CallOption
	ListSchedules                []gax.CallOption
	GetSchedule                  []gax.CallOption
	DeleteSchedule               []gax.CallOption
	CreateSchedule               []gax.CallOption
	TriggerSchedule              []gax.CallOption
	ListExecutions               []gax.CallOption
	GetExecution                 []gax.CallOption
	DeleteExecution              []gax.CallOption
	CreateExecution              []gax.CallOption
}

NotebookCallOptions contains the retry settings for each method of NotebookClient.

NotebookClient

type NotebookClient struct {

	// The call options for this service.
	CallOptions *NotebookCallOptions

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

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

API v1 service for Cloud AI Platform Notebooks.

func NewNotebookClient

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

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

API v1 service for Cloud AI Platform Notebooks.

Example

package main

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

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

	// TODO: Use client.
	_ = c
}

func (*NotebookClient) Close

func (c *NotebookClient) Close() error

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

func (*NotebookClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*NotebookClient) CreateEnvironment

CreateEnvironment creates a new Environment.

Example

package main

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

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

	req := &notebookspb.CreateEnvironmentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#CreateEnvironmentRequest.
	}
	op, err := c.CreateEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) CreateEnvironmentOperation

func (c *NotebookClient) CreateEnvironmentOperation(name string) *CreateEnvironmentOperation

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

func (*NotebookClient) CreateExecution

CreateExecution creates a new Execution in a given project and location.

Example

package main

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

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

	req := &notebookspb.CreateExecutionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#CreateExecutionRequest.
	}
	op, err := c.CreateExecution(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) CreateExecutionOperation

func (c *NotebookClient) CreateExecutionOperation(name string) *CreateExecutionOperation

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

func (*NotebookClient) CreateInstance

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

Example

package main

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

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

	req := &notebookspb.CreateInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#CreateInstanceRequest.
	}
	op, err := c.CreateInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) CreateInstanceOperation

func (c *NotebookClient) CreateInstanceOperation(name string) *CreateInstanceOperation

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

func (*NotebookClient) CreateSchedule

CreateSchedule creates a new Scheduled Notebook in a given project and location.

Example

package main

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

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

	req := &notebookspb.CreateScheduleRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#CreateScheduleRequest.
	}
	op, err := c.CreateSchedule(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) CreateScheduleOperation

func (c *NotebookClient) CreateScheduleOperation(name string) *CreateScheduleOperation

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

func (*NotebookClient) DeleteEnvironment

DeleteEnvironment deletes a single Environment.

Example

package main

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

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

	req := &notebookspb.DeleteEnvironmentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#DeleteEnvironmentRequest.
	}
	op, err := c.DeleteEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) DeleteEnvironmentOperation

func (c *NotebookClient) DeleteEnvironmentOperation(name string) *DeleteEnvironmentOperation

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

func (*NotebookClient) DeleteExecution

DeleteExecution deletes execution

Example

package main

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

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

	req := &notebookspb.DeleteExecutionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#DeleteExecutionRequest.
	}
	op, err := c.DeleteExecution(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) DeleteExecutionOperation

func (c *NotebookClient) DeleteExecutionOperation(name string) *DeleteExecutionOperation

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

func (*NotebookClient) DeleteInstance

DeleteInstance deletes a single Instance.

Example

package main

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

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

	req := &notebookspb.DeleteInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#DeleteInstanceRequest.
	}
	op, err := c.DeleteInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) DeleteInstanceOperation

func (c *NotebookClient) DeleteInstanceOperation(name string) *DeleteInstanceOperation

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

func (*NotebookClient) DeleteSchedule

DeleteSchedule deletes schedule and all underlying jobs

Example

package main

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

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

	req := &notebookspb.DeleteScheduleRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#DeleteScheduleRequest.
	}
	op, err := c.DeleteSchedule(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) DeleteScheduleOperation

func (c *NotebookClient) DeleteScheduleOperation(name string) *DeleteScheduleOperation

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

func (*NotebookClient) GetEnvironment

GetEnvironment gets details of a single Environment.

Example

package main

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

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

	req := &notebookspb.GetEnvironmentRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#GetEnvironmentRequest.
	}
	resp, err := c.GetEnvironment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*NotebookClient) GetExecution

GetExecution gets details of executions

Example

package main

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

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

	req := &notebookspb.GetExecutionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#GetExecutionRequest.
	}
	resp, err := c.GetExecution(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*NotebookClient) GetInstance

GetInstance gets details of a single Instance.

Example

package main

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

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

	req := &notebookspb.GetInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#GetInstanceRequest.
	}
	resp, err := c.GetInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*NotebookClient) GetInstanceHealth

GetInstanceHealth check if a notebook instance is healthy.

Example

package main

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

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

	req := &notebookspb.GetInstanceHealthRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#GetInstanceHealthRequest.
	}
	resp, err := c.GetInstanceHealth(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*NotebookClient) GetSchedule

GetSchedule gets details of schedule

Example

package main

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

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

	req := &notebookspb.GetScheduleRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#GetScheduleRequest.
	}
	resp, err := c.GetSchedule(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*NotebookClient) IsInstanceUpgradeable

IsInstanceUpgradeable check if a notebook instance is upgradable.

Example

package main

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

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

	req := &notebookspb.IsInstanceUpgradeableRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#IsInstanceUpgradeableRequest.
	}
	resp, err := c.IsInstanceUpgradeable(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*NotebookClient) ListEnvironments

ListEnvironments lists environments in a project.

Example

package main

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

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

	req := &notebookspb.ListEnvironmentsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#ListEnvironmentsRequest.
	}
	it := c.ListEnvironments(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*NotebookClient) ListExecutions

ListExecutions lists executions in a given project and location

Example

package main

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

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

	req := &notebookspb.ListExecutionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#ListExecutionsRequest.
	}
	it := c.ListExecutions(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*NotebookClient) ListInstances

ListInstances lists instances in a given project and location.

Example

package main

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

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

	req := &notebookspb.ListInstancesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#ListInstancesRequest.
	}
	it := c.ListInstances(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*NotebookClient) ListSchedules

ListSchedules lists schedules in a given project and location.

Example

package main

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

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

	req := &notebookspb.ListSchedulesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#ListSchedulesRequest.
	}
	it := c.ListSchedules(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*NotebookClient) RegisterInstance

RegisterInstance registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Example

package main

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

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

	req := &notebookspb.RegisterInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#RegisterInstanceRequest.
	}
	op, err := c.RegisterInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) RegisterInstanceOperation

func (c *NotebookClient) RegisterInstanceOperation(name string) *RegisterInstanceOperation

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

func (*NotebookClient) ReportInstanceInfo

ReportInstanceInfo allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

Example

package main

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

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

	req := &notebookspb.ReportInstanceInfoRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#ReportInstanceInfoRequest.
	}
	op, err := c.ReportInstanceInfo(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) ReportInstanceInfoOperation

func (c *NotebookClient) ReportInstanceInfoOperation(name string) *ReportInstanceInfoOperation

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

func (*NotebookClient) ResetInstance

ResetInstance resets a notebook instance.

Example

package main

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

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

	req := &notebookspb.ResetInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#ResetInstanceRequest.
	}
	op, err := c.ResetInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) ResetInstanceOperation

func (c *NotebookClient) ResetInstanceOperation(name string) *ResetInstanceOperation

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

func (*NotebookClient) RollbackInstance

RollbackInstance rollbacks a notebook instance to the previous version.

Example

package main

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

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

	req := &notebookspb.RollbackInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#RollbackInstanceRequest.
	}
	op, err := c.RollbackInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) RollbackInstanceOperation

func (c *NotebookClient) RollbackInstanceOperation(name string) *RollbackInstanceOperation

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

func (*NotebookClient) SetInstanceAccelerator

SetInstanceAccelerator updates the guest accelerators of a single Instance.

Example

package main

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

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

	req := &notebookspb.SetInstanceAcceleratorRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#SetInstanceAcceleratorRequest.
	}
	op, err := c.SetInstanceAccelerator(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) SetInstanceAcceleratorOperation

func (c *NotebookClient) SetInstanceAcceleratorOperation(name string) *SetInstanceAcceleratorOperation

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

func (*NotebookClient) SetInstanceLabels

SetInstanceLabels replaces all the labels of an Instance.

Example

package main

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

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

	req := &notebookspb.SetInstanceLabelsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#SetInstanceLabelsRequest.
	}
	op, err := c.SetInstanceLabels(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) SetInstanceLabelsOperation

func (c *NotebookClient) SetInstanceLabelsOperation(name string) *SetInstanceLabelsOperation

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

func (*NotebookClient) SetInstanceMachineType

SetInstanceMachineType updates the machine type of a single Instance.

Example

package main

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

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

	req := &notebookspb.SetInstanceMachineTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#SetInstanceMachineTypeRequest.
	}
	op, err := c.SetInstanceMachineType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) SetInstanceMachineTypeOperation

func (c *NotebookClient) SetInstanceMachineTypeOperation(name string) *SetInstanceMachineTypeOperation

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

func (*NotebookClient) StartInstance

StartInstance starts a notebook instance.

Example

package main

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

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

	req := &notebookspb.StartInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#StartInstanceRequest.
	}
	op, err := c.StartInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) StartInstanceOperation

func (c *NotebookClient) StartInstanceOperation(name string) *StartInstanceOperation

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

func (*NotebookClient) StopInstance

StopInstance stops a notebook instance.

Example

package main

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

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

	req := &notebookspb.StopInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#StopInstanceRequest.
	}
	op, err := c.StopInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) StopInstanceOperation

func (c *NotebookClient) StopInstanceOperation(name string) *StopInstanceOperation

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

func (*NotebookClient) TriggerSchedule

TriggerSchedule triggers execution of an existing schedule.

Example

package main

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

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

	req := &notebookspb.TriggerScheduleRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#TriggerScheduleRequest.
	}
	op, err := c.TriggerSchedule(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) TriggerScheduleOperation

func (c *NotebookClient) TriggerScheduleOperation(name string) *TriggerScheduleOperation

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

func (*NotebookClient) UpdateInstanceConfig

UpdateInstanceConfig update Notebook Instance configurations.

Example

package main

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

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

	req := &notebookspb.UpdateInstanceConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#UpdateInstanceConfigRequest.
	}
	op, err := c.UpdateInstanceConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) UpdateInstanceConfigOperation

func (c *NotebookClient) UpdateInstanceConfigOperation(name string) *UpdateInstanceConfigOperation

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

func (*NotebookClient) UpdateInstanceMetadataItems

UpdateInstanceMetadataItems add/update metadata items for an instance.

Example

package main

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

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

	req := &notebookspb.UpdateInstanceMetadataItemsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#UpdateInstanceMetadataItemsRequest.
	}
	resp, err := c.UpdateInstanceMetadataItems(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*NotebookClient) UpdateShieldedInstanceConfig

UpdateShieldedInstanceConfig updates the Shielded instance configuration of a single Instance.

Example

package main

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

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

	req := &notebookspb.UpdateShieldedInstanceConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#UpdateShieldedInstanceConfigRequest.
	}
	op, err := c.UpdateShieldedInstanceConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) UpdateShieldedInstanceConfigOperation

func (c *NotebookClient) UpdateShieldedInstanceConfigOperation(name string) *UpdateShieldedInstanceConfigOperation

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

func (*NotebookClient) UpgradeInstance

UpgradeInstance upgrades a notebook instance to the latest version.

Example

package main

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

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

	req := &notebookspb.UpgradeInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#UpgradeInstanceRequest.
	}
	op, err := c.UpgradeInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) UpgradeInstanceInternal

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

Example

package main

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

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

	req := &notebookspb.UpgradeInstanceInternalRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/notebooks/v1#UpgradeInstanceInternalRequest.
	}
	op, err := c.UpgradeInstanceInternal(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*NotebookClient) UpgradeInstanceInternalOperation

func (c *NotebookClient) UpgradeInstanceInternalOperation(name string) *UpgradeInstanceInternalOperation

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

func (*NotebookClient) UpgradeInstanceOperation

func (c *NotebookClient) UpgradeInstanceOperation(name string) *UpgradeInstanceOperation

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

RegisterInstanceOperation

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

RegisterInstanceOperation manages a long-running operation from RegisterInstance.

func (*RegisterInstanceOperation) Done

func (op *RegisterInstanceOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RegisterInstanceOperation) Metadata

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.

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.

ReportRuntimeEventOperation

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

ReportRuntimeEventOperation manages a long-running operation from ReportRuntimeEvent.

func (*ReportRuntimeEventOperation) Done

func (op *ReportRuntimeEventOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ReportRuntimeEventOperation) 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 (*ReportRuntimeEventOperation) 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 (*ReportRuntimeEventOperation) 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 (*ReportRuntimeEventOperation) 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.

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.

ResetRuntimeOperation

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

ResetRuntimeOperation manages a long-running operation from ResetRuntime.

func (*ResetRuntimeOperation) Done

func (op *ResetRuntimeOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ResetRuntimeOperation) 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 (*ResetRuntimeOperation) Name

func (op *ResetRuntimeOperation) 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 (*ResetRuntimeOperation) 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 (*ResetRuntimeOperation) 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.

RollbackInstanceOperation

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

RollbackInstanceOperation manages a long-running operation from RollbackInstance.

func (*RollbackInstanceOperation) Done

func (op *RollbackInstanceOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RollbackInstanceOperation) 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 (*RollbackInstanceOperation) Name

func (op *RollbackInstanceOperation) 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 (*RollbackInstanceOperation) 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 (*RollbackInstanceOperation) 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.

RuntimeIterator

type RuntimeIterator 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.Runtime, nextPageToken string, err error)
	// contains filtered or unexported fields
}

RuntimeIterator manages a stream of *notebookspb.Runtime.

func (*RuntimeIterator) Next

func (it *RuntimeIterator) Next() (*notebookspb.Runtime, 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 (*RuntimeIterator) PageInfo

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

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

ScheduleIterator

type ScheduleIterator 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.Schedule, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ScheduleIterator manages a stream of *notebookspb.Schedule.

func (*ScheduleIterator) Next

func (it *ScheduleIterator) Next() (*notebookspb.Schedule, 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 (*ScheduleIterator) PageInfo

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

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

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.

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.

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.

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.

StartRuntimeOperation

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

StartRuntimeOperation manages a long-running operation from StartRuntime.

func (*StartRuntimeOperation) Done

func (op *StartRuntimeOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*StartRuntimeOperation) 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 (*StartRuntimeOperation) Name

func (op *StartRuntimeOperation) 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 (*StartRuntimeOperation) 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 (*StartRuntimeOperation) 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.

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.

StopRuntimeOperation

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

StopRuntimeOperation manages a long-running operation from StopRuntime.

func (*StopRuntimeOperation) Done

func (op *StopRuntimeOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*StopRuntimeOperation) 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 (*StopRuntimeOperation) Name

func (op *StopRuntimeOperation) 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 (*StopRuntimeOperation) 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 (*StopRuntimeOperation) 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.

SwitchRuntimeOperation

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

SwitchRuntimeOperation manages a long-running operation from SwitchRuntime.

func (*SwitchRuntimeOperation) Done

func (op *SwitchRuntimeOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*SwitchRuntimeOperation) 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 (*SwitchRuntimeOperation) Name

func (op *SwitchRuntimeOperation) 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 (*SwitchRuntimeOperation) 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 (*SwitchRuntimeOperation) 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.

TriggerScheduleOperation

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

TriggerScheduleOperation manages a long-running operation from TriggerSchedule.

func (*TriggerScheduleOperation) Done

func (op *TriggerScheduleOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*TriggerScheduleOperation) 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 (*TriggerScheduleOperation) Name

func (op *TriggerScheduleOperation) 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 (*TriggerScheduleOperation) 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 (*TriggerScheduleOperation) 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.

UpdateInstanceConfigOperation

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

UpdateInstanceConfigOperation manages a long-running operation from UpdateInstanceConfig.

func (*UpdateInstanceConfigOperation) Done

Done reports whether the long-running operation has completed.

func (*UpdateInstanceConfigOperation) 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 (*UpdateInstanceConfigOperation) 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 (*UpdateInstanceConfigOperation) 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 (*UpdateInstanceConfigOperation) 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.

UpdateShieldedInstanceConfigOperation

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

UpdateShieldedInstanceConfigOperation manages a long-running operation from UpdateShieldedInstanceConfig.

func (*UpdateShieldedInstanceConfigOperation) Done

Done reports whether the long-running operation has completed.

func (*UpdateShieldedInstanceConfigOperation) 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 (*UpdateShieldedInstanceConfigOperation) 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 (*UpdateShieldedInstanceConfigOperation) 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 (*UpdateShieldedInstanceConfigOperation) 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.

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.

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.