Package notebooks is an auto-generated package for the Notebooks API.
Notebooks API is used to manage notebook resources in Google Cloud.
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 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() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := notebooks.NewManagedNotebookClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := ¬ebookspb.CreateRuntimeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
Use of Context
The ctx passed to NewManagedNotebookClient 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.
Functions
func DefaultAuthScopes
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CreateEnvironmentOperation
type CreateEnvironmentOperation struct {
// contains filtered or unexported fields
}
CreateEnvironmentOperation manages a long-running operation from CreateEnvironment.
func (*CreateEnvironmentOperation) Done
func (op *CreateEnvironmentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateEnvironmentOperation) Metadata
func (op *CreateEnvironmentOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateEnvironmentOperation) Name
func (op *CreateEnvironmentOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateEnvironmentOperation) Poll
func (op *CreateEnvironmentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Environment, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateEnvironmentOperation) Wait
func (op *CreateEnvironmentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Environment, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
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
func (op *CreateExecutionOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*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
func (op *CreateExecutionOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Execution, 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 (*CreateExecutionOperation) Wait
func (op *CreateExecutionOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Execution, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
CreateInstanceOperation
type CreateInstanceOperation struct {
// contains filtered or unexported fields
}
CreateInstanceOperation manages a long-running operation from CreateInstance.
func (*CreateInstanceOperation) Done
func (op *CreateInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateInstanceOperation) Metadata
func (op *CreateInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateInstanceOperation) Name
func (op *CreateInstanceOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateInstanceOperation) Poll
func (op *CreateInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateInstanceOperation) Wait
func (op *CreateInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
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
func (op *CreateRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*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
func (op *CreateRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, 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 (*CreateRuntimeOperation) Wait
func (op *CreateRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, 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.
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
func (op *CreateScheduleOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*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
func (op *CreateScheduleOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Schedule, 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 (*CreateScheduleOperation) Wait
func (op *CreateScheduleOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Schedule, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteEnvironmentOperation
type DeleteEnvironmentOperation struct {
// contains filtered or unexported fields
}
DeleteEnvironmentOperation manages a long-running operation from DeleteEnvironment.
func (*DeleteEnvironmentOperation) Done
func (op *DeleteEnvironmentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteEnvironmentOperation) Metadata
func (op *DeleteEnvironmentOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteEnvironmentOperation) Name
func (op *DeleteEnvironmentOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteEnvironmentOperation) Poll
func (op *DeleteEnvironmentOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteEnvironmentOperation) Wait
func (op *DeleteEnvironmentOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
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
func (op *DeleteExecutionOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*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
func (op *DeleteExecutionOperation) 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 (*DeleteExecutionOperation) Wait
func (op *DeleteExecutionOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteInstanceOperation
type DeleteInstanceOperation struct {
// contains filtered or unexported fields
}
DeleteInstanceOperation manages a long-running operation from DeleteInstance.
func (*DeleteInstanceOperation) Done
func (op *DeleteInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteInstanceOperation) Metadata
func (op *DeleteInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteInstanceOperation) Name
func (op *DeleteInstanceOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteInstanceOperation) Poll
func (op *DeleteInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteInstanceOperation) Wait
func (op *DeleteInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
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
func (op *DeleteRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*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
func (op *DeleteScheduleOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*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.
DiagnoseInstanceOperation
type DiagnoseInstanceOperation struct {
// contains filtered or unexported fields
}
DiagnoseInstanceOperation manages a long-running operation from DiagnoseInstance.
func (*DiagnoseInstanceOperation) Done
func (op *DiagnoseInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DiagnoseInstanceOperation) Metadata
func (op *DiagnoseInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DiagnoseInstanceOperation) Name
func (op *DiagnoseInstanceOperation) 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 (*DiagnoseInstanceOperation) Poll
func (op *DiagnoseInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DiagnoseInstanceOperation) Wait
func (op *DiagnoseInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DiagnoseRuntimeOperation
type DiagnoseRuntimeOperation struct {
// contains filtered or unexported fields
}
DiagnoseRuntimeOperation manages a long-running operation from DiagnoseRuntime.
func (*DiagnoseRuntimeOperation) Done
func (op *DiagnoseRuntimeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DiagnoseRuntimeOperation) Metadata
func (op *DiagnoseRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DiagnoseRuntimeOperation) Name
func (op *DiagnoseRuntimeOperation) 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 (*DiagnoseRuntimeOperation) Poll
func (op *DiagnoseRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, 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 (*DiagnoseRuntimeOperation) Wait
func (op *DiagnoseRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, 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) All
func (it *EnvironmentIterator) All() iter.Seq2[*notebookspb.Environment, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*EnvironmentIterator) Next
func (it *EnvironmentIterator) Next() (*notebookspb.Environment, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*EnvironmentIterator) PageInfo
func (it *EnvironmentIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
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) All
func (it *ExecutionIterator) All() iter.Seq2[*notebookspb.Execution, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ExecutionIterator) Next
func (it *ExecutionIterator) Next() (*notebookspb.Execution, 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 (*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) All
func (it *InstanceIterator) All() iter.Seq2[*notebookspb.Instance, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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.
LocationIterator
type LocationIterator 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 []*locationpb.Location, nextPageToken string, err error)
// contains filtered or unexported fields
}
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) All
func (it *LocationIterator) All() iter.Seq2[*locationpb.Location, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*LocationIterator) Next
func (it *LocationIterator) Next() (*locationpb.Location, 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 (*LocationIterator) PageInfo
func (it *LocationIterator) 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
UpdateRuntime []gax.CallOption
DeleteRuntime []gax.CallOption
StartRuntime []gax.CallOption
StopRuntime []gax.CallOption
SwitchRuntime []gax.CallOption
ResetRuntime []gax.CallOption
UpgradeRuntime []gax.CallOption
ReportRuntimeEvent []gax.CallOption
RefreshRuntimeTokenInternal []gax.CallOption
DiagnoseRuntime []gax.CallOption
GetLocation []gax.CallOption
ListLocations []gax.CallOption
GetIamPolicy []gax.CallOption
SetIamPolicy []gax.CallOption
TestIamPermissions []gax.CallOption
CancelOperation []gax.CallOption
DeleteOperation []gax.CallOption
GetOperation []gax.CallOption
ListOperations []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 (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*ManagedNotebookClient) CancelOperation
func (c *ManagedNotebookClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.CancelOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.
}
err = c.CancelOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
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 (deprecated)
func (c *ManagedNotebookClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*ManagedNotebookClient) CreateRuntime
func (c *ManagedNotebookClient) CreateRuntime(ctx context.Context, req *notebookspb.CreateRuntimeRequest, opts ...gax.CallOption) (*CreateRuntimeOperation, error)
CreateRuntime creates a new Runtime in a given project and location.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.CreateRuntimeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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) DeleteOperation
func (c *ManagedNotebookClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.DeleteOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.
}
err = c.DeleteOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*ManagedNotebookClient) DeleteRuntime
func (c *ManagedNotebookClient) DeleteRuntime(ctx context.Context, req *notebookspb.DeleteRuntimeRequest, opts ...gax.CallOption) (*DeleteRuntimeOperation, error)
DeleteRuntime deletes a single Runtime.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.DeleteRuntimeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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) DiagnoseRuntime
func (c *ManagedNotebookClient) DiagnoseRuntime(ctx context.Context, req *notebookspb.DiagnoseRuntimeRequest, opts ...gax.CallOption) (*DiagnoseRuntimeOperation, error)
DiagnoseRuntime creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.DiagnoseRuntimeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#DiagnoseRuntimeRequest.
}
op, err := c.DiagnoseRuntime(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) DiagnoseRuntimeOperation
func (c *ManagedNotebookClient) DiagnoseRuntimeOperation(name string) *DiagnoseRuntimeOperation
DiagnoseRuntimeOperation returns a new DiagnoseRuntimeOperation from a given name. The name must be that of a previously created DiagnoseRuntimeOperation, possibly from a different process.
func (*ManagedNotebookClient) GetIamPolicy
func (c *ManagedNotebookClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Example
package main
import (
"context"
iampb "cloud.google.com/go/iam/apiv1/iampb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &iampb.GetIamPolicyRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest.
}
resp, err := c.GetIamPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ManagedNotebookClient) GetLocation
func (c *ManagedNotebookClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
locationpb "google.golang.org/genproto/googleapis/cloud/location"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &locationpb.GetLocationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp, err := c.GetLocation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ManagedNotebookClient) GetOperation
func (c *ManagedNotebookClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ManagedNotebookClient) GetRuntime
func (c *ManagedNotebookClient) GetRuntime(ctx context.Context, req *notebookspb.GetRuntimeRequest, opts ...gax.CallOption) (*notebookspb.Runtime, error)
GetRuntime gets details of a single Runtime. The location must be a regional endpoint rather than zonal.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.GetRuntimeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#GetRuntimeRequest.
}
resp, err := c.GetRuntime(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ManagedNotebookClient) ListLocations
func (c *ManagedNotebookClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Examples
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
"google.golang.org/api/iterator"
locationpb "google.golang.org/genproto/googleapis/cloud/location"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &locationpb.ListLocationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it := c.ListLocations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*locationpb.ListLocationsResponse)
}
}
all
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
locationpb "google.golang.org/genproto/googleapis/cloud/location"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &locationpb.ListLocationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
for resp, err := range c.ListLocations(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ManagedNotebookClient) ListOperations
func (c *ManagedNotebookClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
notebooks "cloud.google.com/go/notebooks/apiv1"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ManagedNotebookClient) ListRuntimes
func (c *ManagedNotebookClient) ListRuntimes(ctx context.Context, req *notebookspb.ListRuntimesRequest, opts ...gax.CallOption) *RuntimeIterator
ListRuntimes lists Runtimes in a given project and location.
Examples
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ListRuntimesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*notebookspb.ListRuntimesResponse)
}
}
all
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ListRuntimesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#ListRuntimesRequest.
}
for resp, err := range c.ListRuntimes(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ManagedNotebookClient) RefreshRuntimeTokenInternal
func (c *ManagedNotebookClient) RefreshRuntimeTokenInternal(ctx context.Context, req *notebookspb.RefreshRuntimeTokenInternalRequest, opts ...gax.CallOption) (*notebookspb.RefreshRuntimeTokenInternalResponse, error)
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 (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.RefreshRuntimeTokenInternalRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#RefreshRuntimeTokenInternalRequest.
}
resp, err := c.RefreshRuntimeTokenInternal(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ManagedNotebookClient) ReportRuntimeEvent
func (c *ManagedNotebookClient) ReportRuntimeEvent(ctx context.Context, req *notebookspb.ReportRuntimeEventRequest, opts ...gax.CallOption) (*ReportRuntimeEventOperation, error)
ReportRuntimeEvent report and process a runtime event.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ReportRuntimeEventRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
func (c *ManagedNotebookClient) ResetRuntime(ctx context.Context, req *notebookspb.ResetRuntimeRequest, opts ...gax.CallOption) (*ResetRuntimeOperation, error)
ResetRuntime resets a Managed Notebook Runtime.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ResetRuntimeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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) SetIamPolicy
func (c *ManagedNotebookClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
SetIamPolicy sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Example
package main
import (
"context"
iampb "cloud.google.com/go/iam/apiv1/iampb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &iampb.SetIamPolicyRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest.
}
resp, err := c.SetIamPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ManagedNotebookClient) StartRuntime
func (c *ManagedNotebookClient) StartRuntime(ctx context.Context, req *notebookspb.StartRuntimeRequest, opts ...gax.CallOption) (*StartRuntimeOperation, error)
StartRuntime starts a Managed Notebook Runtime. Perform “Start” on GPU instances; “Resume” on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance (at https://cloud.google.com/compute/docs/instances/stop-start-instance) https://cloud.google.com/compute/docs/instances/suspend-resume-instance (at https://cloud.google.com/compute/docs/instances/suspend-resume-instance)
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.StartRuntimeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
func (c *ManagedNotebookClient) StopRuntime(ctx context.Context, req *notebookspb.StopRuntimeRequest, opts ...gax.CallOption) (*StopRuntimeOperation, error)
StopRuntime stops a Managed Notebook Runtime. Perform “Stop” on GPU instances; “Suspend” on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance (at https://cloud.google.com/compute/docs/instances/stop-start-instance) https://cloud.google.com/compute/docs/instances/suspend-resume-instance (at https://cloud.google.com/compute/docs/instances/suspend-resume-instance)
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.StopRuntimeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
func (c *ManagedNotebookClient) SwitchRuntime(ctx context.Context, req *notebookspb.SwitchRuntimeRequest, opts ...gax.CallOption) (*SwitchRuntimeOperation, error)
SwitchRuntime switch a Managed Notebook Runtime.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.SwitchRuntimeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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.
func (*ManagedNotebookClient) TestIamPermissions
func (c *ManagedNotebookClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
TestIamPermissions returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
Example
package main
import (
"context"
iampb "cloud.google.com/go/iam/apiv1/iampb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &iampb.TestIamPermissionsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest.
}
resp, err := c.TestIamPermissions(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ManagedNotebookClient) UpdateRuntime
func (c *ManagedNotebookClient) UpdateRuntime(ctx context.Context, req *notebookspb.UpdateRuntimeRequest, opts ...gax.CallOption) (*UpdateRuntimeOperation, error)
UpdateRuntime update Notebook Runtime configuration.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.UpdateRuntimeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#UpdateRuntimeRequest.
}
op, err := c.UpdateRuntime(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) UpdateRuntimeOperation
func (c *ManagedNotebookClient) UpdateRuntimeOperation(name string) *UpdateRuntimeOperation
UpdateRuntimeOperation returns a new UpdateRuntimeOperation from a given name. The name must be that of a previously created UpdateRuntimeOperation, possibly from a different process.
func (*ManagedNotebookClient) UpgradeRuntime
func (c *ManagedNotebookClient) UpgradeRuntime(ctx context.Context, req *notebookspb.UpgradeRuntimeRequest, opts ...gax.CallOption) (*UpgradeRuntimeOperation, error)
UpgradeRuntime upgrades a Managed Notebook Runtime to the latest version.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewManagedNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.UpgradeRuntimeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#UpgradeRuntimeRequest.
}
op, err := c.UpgradeRuntime(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) UpgradeRuntimeOperation
func (c *ManagedNotebookClient) UpgradeRuntimeOperation(name string) *UpgradeRuntimeOperation
UpgradeRuntimeOperation returns a new UpgradeRuntimeOperation from a given name. The name must be that of a previously created UpgradeRuntimeOperation, 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
DiagnoseInstance []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
GetLocation []gax.CallOption
ListLocations []gax.CallOption
GetIamPolicy []gax.CallOption
SetIamPolicy []gax.CallOption
TestIamPermissions []gax.CallOption
CancelOperation []gax.CallOption
DeleteOperation []gax.CallOption
GetOperation []gax.CallOption
ListOperations []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 (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*NotebookClient) CancelOperation
func (c *NotebookClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.CancelOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.
}
err = c.CancelOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
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 (deprecated)
func (c *NotebookClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*NotebookClient) CreateEnvironment
func (c *NotebookClient) CreateEnvironment(ctx context.Context, req *notebookspb.CreateEnvironmentRequest, opts ...gax.CallOption) (*CreateEnvironmentOperation, error)
CreateEnvironment creates a new Environment.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.CreateEnvironmentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
func (c *NotebookClient) CreateExecution(ctx context.Context, req *notebookspb.CreateExecutionRequest, opts ...gax.CallOption) (*CreateExecutionOperation, error)
CreateExecution creates a new Execution in a given project and location.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.CreateExecutionRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
func (c *NotebookClient) CreateInstance(ctx context.Context, req *notebookspb.CreateInstanceRequest, opts ...gax.CallOption) (*CreateInstanceOperation, error)
CreateInstance creates a new Instance in a given project and location.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.CreateInstanceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
func (c *NotebookClient) CreateSchedule(ctx context.Context, req *notebookspb.CreateScheduleRequest, opts ...gax.CallOption) (*CreateScheduleOperation, error)
CreateSchedule creates a new Scheduled Notebook in a given project and location.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.CreateScheduleRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
func (c *NotebookClient) DeleteEnvironment(ctx context.Context, req *notebookspb.DeleteEnvironmentRequest, opts ...gax.CallOption) (*DeleteEnvironmentOperation, error)
DeleteEnvironment deletes a single Environment.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.DeleteEnvironmentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
func (c *NotebookClient) DeleteExecution(ctx context.Context, req *notebookspb.DeleteExecutionRequest, opts ...gax.CallOption) (*DeleteExecutionOperation, error)
DeleteExecution deletes execution
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.DeleteExecutionRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
func (c *NotebookClient) DeleteInstance(ctx context.Context, req *notebookspb.DeleteInstanceRequest, opts ...gax.CallOption) (*DeleteInstanceOperation, error)
DeleteInstance deletes a single Instance.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.DeleteInstanceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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) DeleteOperation
func (c *NotebookClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.DeleteOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.
}
err = c.DeleteOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*NotebookClient) DeleteSchedule
func (c *NotebookClient) DeleteSchedule(ctx context.Context, req *notebookspb.DeleteScheduleRequest, opts ...gax.CallOption) (*DeleteScheduleOperation, error)
DeleteSchedule deletes schedule and all underlying jobs
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.DeleteScheduleRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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) DiagnoseInstance
func (c *NotebookClient) DiagnoseInstance(ctx context.Context, req *notebookspb.DiagnoseInstanceRequest, opts ...gax.CallOption) (*DiagnoseInstanceOperation, error)
DiagnoseInstance creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.DiagnoseInstanceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#DiagnoseInstanceRequest.
}
op, err := c.DiagnoseInstance(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) DiagnoseInstanceOperation
func (c *NotebookClient) DiagnoseInstanceOperation(name string) *DiagnoseInstanceOperation
DiagnoseInstanceOperation returns a new DiagnoseInstanceOperation from a given name. The name must be that of a previously created DiagnoseInstanceOperation, possibly from a different process.
func (*NotebookClient) GetEnvironment
func (c *NotebookClient) GetEnvironment(ctx context.Context, req *notebookspb.GetEnvironmentRequest, opts ...gax.CallOption) (*notebookspb.Environment, error)
GetEnvironment gets details of a single Environment.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.GetEnvironmentRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#GetEnvironmentRequest.
}
resp, err := c.GetEnvironment(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) GetExecution
func (c *NotebookClient) GetExecution(ctx context.Context, req *notebookspb.GetExecutionRequest, opts ...gax.CallOption) (*notebookspb.Execution, error)
GetExecution gets details of executions
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.GetExecutionRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#GetExecutionRequest.
}
resp, err := c.GetExecution(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) GetIamPolicy
func (c *NotebookClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Example
package main
import (
"context"
iampb "cloud.google.com/go/iam/apiv1/iampb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &iampb.GetIamPolicyRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest.
}
resp, err := c.GetIamPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) GetInstance
func (c *NotebookClient) GetInstance(ctx context.Context, req *notebookspb.GetInstanceRequest, opts ...gax.CallOption) (*notebookspb.Instance, error)
GetInstance gets details of a single Instance.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.GetInstanceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#GetInstanceRequest.
}
resp, err := c.GetInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) GetInstanceHealth
func (c *NotebookClient) GetInstanceHealth(ctx context.Context, req *notebookspb.GetInstanceHealthRequest, opts ...gax.CallOption) (*notebookspb.GetInstanceHealthResponse, error)
GetInstanceHealth check if a notebook instance is healthy.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.GetInstanceHealthRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#GetInstanceHealthRequest.
}
resp, err := c.GetInstanceHealth(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) GetLocation
func (c *NotebookClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
locationpb "google.golang.org/genproto/googleapis/cloud/location"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &locationpb.GetLocationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp, err := c.GetLocation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) GetOperation
func (c *NotebookClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) GetSchedule
func (c *NotebookClient) GetSchedule(ctx context.Context, req *notebookspb.GetScheduleRequest, opts ...gax.CallOption) (*notebookspb.Schedule, error)
GetSchedule gets details of schedule
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.GetScheduleRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#GetScheduleRequest.
}
resp, err := c.GetSchedule(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) IsInstanceUpgradeable
func (c *NotebookClient) IsInstanceUpgradeable(ctx context.Context, req *notebookspb.IsInstanceUpgradeableRequest, opts ...gax.CallOption) (*notebookspb.IsInstanceUpgradeableResponse, error)
IsInstanceUpgradeable check if a notebook instance is upgradable.
Example
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.IsInstanceUpgradeableRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#IsInstanceUpgradeableRequest.
}
resp, err := c.IsInstanceUpgradeable(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) ListEnvironments
func (c *NotebookClient) ListEnvironments(ctx context.Context, req *notebookspb.ListEnvironmentsRequest, opts ...gax.CallOption) *EnvironmentIterator
ListEnvironments lists environments in a project.
Examples
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ListEnvironmentsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*notebookspb.ListEnvironmentsResponse)
}
}
all
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ListEnvironmentsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#ListEnvironmentsRequest.
}
for resp, err := range c.ListEnvironments(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*NotebookClient) ListExecutions
func (c *NotebookClient) ListExecutions(ctx context.Context, req *notebookspb.ListExecutionsRequest, opts ...gax.CallOption) *ExecutionIterator
ListExecutions lists executions in a given project and location
Examples
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ListExecutionsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*notebookspb.ListExecutionsResponse)
}
}
all
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ListExecutionsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#ListExecutionsRequest.
}
for resp, err := range c.ListExecutions(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*NotebookClient) ListInstances
func (c *NotebookClient) ListInstances(ctx context.Context, req *notebookspb.ListInstancesRequest, opts ...gax.CallOption) *InstanceIterator
ListInstances lists instances in a given project and location.
Examples
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ListInstancesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#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
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*notebookspb.ListInstancesResponse)
}
}
all
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
notebookspb "cloud.google.com/go/notebooks/apiv1/notebookspb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := ¬ebookspb.ListInstancesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#ListInstancesRequest.
}
for resp, err := range c.ListInstances(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*NotebookClient) ListLocations
func (c *NotebookClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Examples
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
"google.golang.org/api/iterator"
locationpb "google.golang.org/genproto/googleapis/cloud/location"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &locationpb.ListLocationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it := c.ListLocations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*locationpb.ListLocationsResponse)
}
}
all
package main
import (
"context"
notebooks "cloud.google.com/go/notebooks/apiv1"
locationpb "google.golang.org/genproto/googleapis/cloud/location"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &locationpb.ListLocationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
for resp, err := range c.ListLocations(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*NotebookClient) ListOperations
func (c *NotebookClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Examples
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
notebooks "cloud.google.com/go/notebooks/apiv1"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it := c.ListOperations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*longrunningpb.ListOperationsResponse)
}
}
all
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
notebooks "cloud.google.com/go/notebooks/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := notebooks.NewNotebookClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &longrunningpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for resp, err := range c.ListOperations(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.