package notebooks
import "cloud.google.com/go/notebooks/apiv1"
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.
// go get cloud.google.com/go/notebooks/apiv1@latest 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, mentioned above.
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.
Index ¶
- func DefaultAuthScopes() []string
- type CreateEnvironmentOperation
- func (op *CreateEnvironmentOperation) Done() bool
- func (op *CreateEnvironmentOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *CreateEnvironmentOperation) Name() string
- func (op *CreateEnvironmentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Environment, error)
- func (op *CreateEnvironmentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Environment, error)
- type CreateExecutionOperation
- func (op *CreateExecutionOperation) Done() bool
- func (op *CreateExecutionOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *CreateExecutionOperation) Name() string
- func (op *CreateExecutionOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Execution, error)
- func (op *CreateExecutionOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Execution, error)
- type CreateInstanceOperation
- func (op *CreateInstanceOperation) Done() bool
- func (op *CreateInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *CreateInstanceOperation) Name() string
- func (op *CreateInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *CreateInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type CreateRuntimeOperation
- func (op *CreateRuntimeOperation) Done() bool
- func (op *CreateRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *CreateRuntimeOperation) Name() string
- func (op *CreateRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- func (op *CreateRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- type CreateScheduleOperation
- func (op *CreateScheduleOperation) Done() bool
- func (op *CreateScheduleOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *CreateScheduleOperation) Name() string
- func (op *CreateScheduleOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Schedule, error)
- func (op *CreateScheduleOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Schedule, error)
- type DeleteEnvironmentOperation
- func (op *DeleteEnvironmentOperation) Done() bool
- func (op *DeleteEnvironmentOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *DeleteEnvironmentOperation) Name() string
- func (op *DeleteEnvironmentOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteEnvironmentOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteExecutionOperation
- func (op *DeleteExecutionOperation) Done() bool
- func (op *DeleteExecutionOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *DeleteExecutionOperation) Name() string
- func (op *DeleteExecutionOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteExecutionOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteInstanceOperation
- func (op *DeleteInstanceOperation) Done() bool
- func (op *DeleteInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *DeleteInstanceOperation) Name() string
- func (op *DeleteInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteRuntimeOperation
- func (op *DeleteRuntimeOperation) Done() bool
- func (op *DeleteRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *DeleteRuntimeOperation) Name() string
- func (op *DeleteRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteScheduleOperation
- func (op *DeleteScheduleOperation) Done() bool
- func (op *DeleteScheduleOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *DeleteScheduleOperation) Name() string
- func (op *DeleteScheduleOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteScheduleOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DiagnoseInstanceOperation
- func (op *DiagnoseInstanceOperation) Done() bool
- func (op *DiagnoseInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *DiagnoseInstanceOperation) Name() string
- func (op *DiagnoseInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *DiagnoseInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type DiagnoseRuntimeOperation
- func (op *DiagnoseRuntimeOperation) Done() bool
- func (op *DiagnoseRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *DiagnoseRuntimeOperation) Name() string
- func (op *DiagnoseRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- func (op *DiagnoseRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- type EnvironmentIterator
- func (it *EnvironmentIterator) All() iter.Seq2[*notebookspb.Environment, error]
- func (it *EnvironmentIterator) Next() (*notebookspb.Environment, error)
- func (it *EnvironmentIterator) PageInfo() *iterator.PageInfo
- type ExecutionIterator
- func (it *ExecutionIterator) All() iter.Seq2[*notebookspb.Execution, error]
- func (it *ExecutionIterator) Next() (*notebookspb.Execution, error)
- func (it *ExecutionIterator) PageInfo() *iterator.PageInfo
- type InstanceIterator
- func (it *InstanceIterator) All() iter.Seq2[*notebookspb.Instance, error]
- func (it *InstanceIterator) Next() (*notebookspb.Instance, error)
- func (it *InstanceIterator) PageInfo() *iterator.PageInfo
- type LocationIterator
- func (it *LocationIterator) All() iter.Seq2[*locationpb.Location, error]
- func (it *LocationIterator) Next() (*locationpb.Location, error)
- func (it *LocationIterator) PageInfo() *iterator.PageInfo
- type ManagedNotebookCallOptions
- type ManagedNotebookClient
- func NewManagedNotebookClient(ctx context.Context, opts ...option.ClientOption) (*ManagedNotebookClient, error)
- func (c *ManagedNotebookClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
- func (c *ManagedNotebookClient) Close() error
- func (c *ManagedNotebookClient) Connection() *grpc.ClientConn
- func (c *ManagedNotebookClient) CreateRuntime(ctx context.Context, req *notebookspb.CreateRuntimeRequest, opts ...gax.CallOption) (*CreateRuntimeOperation, error)
- func (c *ManagedNotebookClient) CreateRuntimeOperation(name string) *CreateRuntimeOperation
- func (c *ManagedNotebookClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
- func (c *ManagedNotebookClient) DeleteRuntime(ctx context.Context, req *notebookspb.DeleteRuntimeRequest, opts ...gax.CallOption) (*DeleteRuntimeOperation, error)
- func (c *ManagedNotebookClient) DeleteRuntimeOperation(name string) *DeleteRuntimeOperation
- func (c *ManagedNotebookClient) DiagnoseRuntime(ctx context.Context, req *notebookspb.DiagnoseRuntimeRequest, opts ...gax.CallOption) (*DiagnoseRuntimeOperation, error)
- func (c *ManagedNotebookClient) DiagnoseRuntimeOperation(name string) *DiagnoseRuntimeOperation
- func (c *ManagedNotebookClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *ManagedNotebookClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
- func (c *ManagedNotebookClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
- func (c *ManagedNotebookClient) GetRuntime(ctx context.Context, req *notebookspb.GetRuntimeRequest, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- func (c *ManagedNotebookClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
- func (c *ManagedNotebookClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
- func (c *ManagedNotebookClient) ListRuntimes(ctx context.Context, req *notebookspb.ListRuntimesRequest, opts ...gax.CallOption) *RuntimeIterator
- func (c *ManagedNotebookClient) RefreshRuntimeTokenInternal(ctx context.Context, req *notebookspb.RefreshRuntimeTokenInternalRequest, opts ...gax.CallOption) (*notebookspb.RefreshRuntimeTokenInternalResponse, error)
- func (c *ManagedNotebookClient) ReportRuntimeEvent(ctx context.Context, req *notebookspb.ReportRuntimeEventRequest, opts ...gax.CallOption) (*ReportRuntimeEventOperation, error)
- func (c *ManagedNotebookClient) ReportRuntimeEventOperation(name string) *ReportRuntimeEventOperation
- func (c *ManagedNotebookClient) ResetRuntime(ctx context.Context, req *notebookspb.ResetRuntimeRequest, opts ...gax.CallOption) (*ResetRuntimeOperation, error)
- func (c *ManagedNotebookClient) ResetRuntimeOperation(name string) *ResetRuntimeOperation
- func (c *ManagedNotebookClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *ManagedNotebookClient) StartRuntime(ctx context.Context, req *notebookspb.StartRuntimeRequest, opts ...gax.CallOption) (*StartRuntimeOperation, error)
- func (c *ManagedNotebookClient) StartRuntimeOperation(name string) *StartRuntimeOperation
- func (c *ManagedNotebookClient) StopRuntime(ctx context.Context, req *notebookspb.StopRuntimeRequest, opts ...gax.CallOption) (*StopRuntimeOperation, error)
- func (c *ManagedNotebookClient) StopRuntimeOperation(name string) *StopRuntimeOperation
- func (c *ManagedNotebookClient) SwitchRuntime(ctx context.Context, req *notebookspb.SwitchRuntimeRequest, opts ...gax.CallOption) (*SwitchRuntimeOperation, error)
- func (c *ManagedNotebookClient) SwitchRuntimeOperation(name string) *SwitchRuntimeOperation
- func (c *ManagedNotebookClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
- func (c *ManagedNotebookClient) UpdateRuntime(ctx context.Context, req *notebookspb.UpdateRuntimeRequest, opts ...gax.CallOption) (*UpdateRuntimeOperation, error)
- func (c *ManagedNotebookClient) UpdateRuntimeOperation(name string) *UpdateRuntimeOperation
- func (c *ManagedNotebookClient) UpgradeRuntime(ctx context.Context, req *notebookspb.UpgradeRuntimeRequest, opts ...gax.CallOption) (*UpgradeRuntimeOperation, error)
- func (c *ManagedNotebookClient) UpgradeRuntimeOperation(name string) *UpgradeRuntimeOperation
- type NotebookCallOptions
- type NotebookClient
- func NewNotebookClient(ctx context.Context, opts ...option.ClientOption) (*NotebookClient, error)
- func (c *NotebookClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
- func (c *NotebookClient) Close() error
- func (c *NotebookClient) Connection() *grpc.ClientConn
- func (c *NotebookClient) CreateEnvironment(ctx context.Context, req *notebookspb.CreateEnvironmentRequest, opts ...gax.CallOption) (*CreateEnvironmentOperation, error)
- func (c *NotebookClient) CreateEnvironmentOperation(name string) *CreateEnvironmentOperation
- func (c *NotebookClient) CreateExecution(ctx context.Context, req *notebookspb.CreateExecutionRequest, opts ...gax.CallOption) (*CreateExecutionOperation, error)
- func (c *NotebookClient) CreateExecutionOperation(name string) *CreateExecutionOperation
- func (c *NotebookClient) CreateInstance(ctx context.Context, req *notebookspb.CreateInstanceRequest, opts ...gax.CallOption) (*CreateInstanceOperation, error)
- func (c *NotebookClient) CreateInstanceOperation(name string) *CreateInstanceOperation
- func (c *NotebookClient) CreateSchedule(ctx context.Context, req *notebookspb.CreateScheduleRequest, opts ...gax.CallOption) (*CreateScheduleOperation, error)
- func (c *NotebookClient) CreateScheduleOperation(name string) *CreateScheduleOperation
- func (c *NotebookClient) DeleteEnvironment(ctx context.Context, req *notebookspb.DeleteEnvironmentRequest, opts ...gax.CallOption) (*DeleteEnvironmentOperation, error)
- func (c *NotebookClient) DeleteEnvironmentOperation(name string) *DeleteEnvironmentOperation
- func (c *NotebookClient) DeleteExecution(ctx context.Context, req *notebookspb.DeleteExecutionRequest, opts ...gax.CallOption) (*DeleteExecutionOperation, error)
- func (c *NotebookClient) DeleteExecutionOperation(name string) *DeleteExecutionOperation
- func (c *NotebookClient) DeleteInstance(ctx context.Context, req *notebookspb.DeleteInstanceRequest, opts ...gax.CallOption) (*DeleteInstanceOperation, error)
- func (c *NotebookClient) DeleteInstanceOperation(name string) *DeleteInstanceOperation
- func (c *NotebookClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
- func (c *NotebookClient) DeleteSchedule(ctx context.Context, req *notebookspb.DeleteScheduleRequest, opts ...gax.CallOption) (*DeleteScheduleOperation, error)
- func (c *NotebookClient) DeleteScheduleOperation(name string) *DeleteScheduleOperation
- func (c *NotebookClient) DiagnoseInstance(ctx context.Context, req *notebookspb.DiagnoseInstanceRequest, opts ...gax.CallOption) (*DiagnoseInstanceOperation, error)
- func (c *NotebookClient) DiagnoseInstanceOperation(name string) *DiagnoseInstanceOperation
- func (c *NotebookClient) GetEnvironment(ctx context.Context, req *notebookspb.GetEnvironmentRequest, opts ...gax.CallOption) (*notebookspb.Environment, error)
- func (c *NotebookClient) GetExecution(ctx context.Context, req *notebookspb.GetExecutionRequest, opts ...gax.CallOption) (*notebookspb.Execution, error)
- func (c *NotebookClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *NotebookClient) GetInstance(ctx context.Context, req *notebookspb.GetInstanceRequest, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (c *NotebookClient) GetInstanceHealth(ctx context.Context, req *notebookspb.GetInstanceHealthRequest, opts ...gax.CallOption) (*notebookspb.GetInstanceHealthResponse, error)
- func (c *NotebookClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
- func (c *NotebookClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
- func (c *NotebookClient) GetSchedule(ctx context.Context, req *notebookspb.GetScheduleRequest, opts ...gax.CallOption) (*notebookspb.Schedule, error)
- func (c *NotebookClient) IsInstanceUpgradeable(ctx context.Context, req *notebookspb.IsInstanceUpgradeableRequest, opts ...gax.CallOption) (*notebookspb.IsInstanceUpgradeableResponse, error)
- func (c *NotebookClient) ListEnvironments(ctx context.Context, req *notebookspb.ListEnvironmentsRequest, opts ...gax.CallOption) *EnvironmentIterator
- func (c *NotebookClient) ListExecutions(ctx context.Context, req *notebookspb.ListExecutionsRequest, opts ...gax.CallOption) *ExecutionIterator
- func (c *NotebookClient) ListInstances(ctx context.Context, req *notebookspb.ListInstancesRequest, opts ...gax.CallOption) *InstanceIterator
- func (c *NotebookClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
- func (c *NotebookClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
- func (c *NotebookClient) ListSchedules(ctx context.Context, req *notebookspb.ListSchedulesRequest, opts ...gax.CallOption) *ScheduleIterator
- func (c *NotebookClient) RegisterInstance(ctx context.Context, req *notebookspb.RegisterInstanceRequest, opts ...gax.CallOption) (*RegisterInstanceOperation, error)
- func (c *NotebookClient) RegisterInstanceOperation(name string) *RegisterInstanceOperation
- func (c *NotebookClient) ReportInstanceInfo(ctx context.Context, req *notebookspb.ReportInstanceInfoRequest, opts ...gax.CallOption) (*ReportInstanceInfoOperation, error)
- func (c *NotebookClient) ReportInstanceInfoOperation(name string) *ReportInstanceInfoOperation
- func (c *NotebookClient) ResetInstance(ctx context.Context, req *notebookspb.ResetInstanceRequest, opts ...gax.CallOption) (*ResetInstanceOperation, error)
- func (c *NotebookClient) ResetInstanceOperation(name string) *ResetInstanceOperation
- func (c *NotebookClient) RollbackInstance(ctx context.Context, req *notebookspb.RollbackInstanceRequest, opts ...gax.CallOption) (*RollbackInstanceOperation, error)
- func (c *NotebookClient) RollbackInstanceOperation(name string) *RollbackInstanceOperation
- func (c *NotebookClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *NotebookClient) SetInstanceAccelerator(ctx context.Context, req *notebookspb.SetInstanceAcceleratorRequest, opts ...gax.CallOption) (*SetInstanceAcceleratorOperation, error)
- func (c *NotebookClient) SetInstanceAcceleratorOperation(name string) *SetInstanceAcceleratorOperation
- func (c *NotebookClient) SetInstanceLabels(ctx context.Context, req *notebookspb.SetInstanceLabelsRequest, opts ...gax.CallOption) (*SetInstanceLabelsOperation, error)
- func (c *NotebookClient) SetInstanceLabelsOperation(name string) *SetInstanceLabelsOperation
- func (c *NotebookClient) SetInstanceMachineType(ctx context.Context, req *notebookspb.SetInstanceMachineTypeRequest, opts ...gax.CallOption) (*SetInstanceMachineTypeOperation, error)
- func (c *NotebookClient) SetInstanceMachineTypeOperation(name string) *SetInstanceMachineTypeOperation
- func (c *NotebookClient) StartInstance(ctx context.Context, req *notebookspb.StartInstanceRequest, opts ...gax.CallOption) (*StartInstanceOperation, error)
- func (c *NotebookClient) StartInstanceOperation(name string) *StartInstanceOperation
- func (c *NotebookClient) StopInstance(ctx context.Context, req *notebookspb.StopInstanceRequest, opts ...gax.CallOption) (*StopInstanceOperation, error)
- func (c *NotebookClient) StopInstanceOperation(name string) *StopInstanceOperation
- func (c *NotebookClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
- func (c *NotebookClient) TriggerSchedule(ctx context.Context, req *notebookspb.TriggerScheduleRequest, opts ...gax.CallOption) (*TriggerScheduleOperation, error)
- func (c *NotebookClient) TriggerScheduleOperation(name string) *TriggerScheduleOperation
- func (c *NotebookClient) UpdateInstanceConfig(ctx context.Context, req *notebookspb.UpdateInstanceConfigRequest, opts ...gax.CallOption) (*UpdateInstanceConfigOperation, error)
- func (c *NotebookClient) UpdateInstanceConfigOperation(name string) *UpdateInstanceConfigOperation
- func (c *NotebookClient) UpdateInstanceMetadataItems(ctx context.Context, req *notebookspb.UpdateInstanceMetadataItemsRequest, opts ...gax.CallOption) (*notebookspb.UpdateInstanceMetadataItemsResponse, error)
- func (c *NotebookClient) UpdateShieldedInstanceConfig(ctx context.Context, req *notebookspb.UpdateShieldedInstanceConfigRequest, opts ...gax.CallOption) (*UpdateShieldedInstanceConfigOperation, error)
- func (c *NotebookClient) UpdateShieldedInstanceConfigOperation(name string) *UpdateShieldedInstanceConfigOperation
- func (c *NotebookClient) UpgradeInstance(ctx context.Context, req *notebookspb.UpgradeInstanceRequest, opts ...gax.CallOption) (*UpgradeInstanceOperation, error)
- func (c *NotebookClient) UpgradeInstanceInternal(ctx context.Context, req *notebookspb.UpgradeInstanceInternalRequest, opts ...gax.CallOption) (*UpgradeInstanceInternalOperation, error)
- func (c *NotebookClient) UpgradeInstanceInternalOperation(name string) *UpgradeInstanceInternalOperation
- func (c *NotebookClient) UpgradeInstanceOperation(name string) *UpgradeInstanceOperation
- type OperationIterator
- func (it *OperationIterator) All() iter.Seq2[*longrunningpb.Operation, error]
- func (it *OperationIterator) Next() (*longrunningpb.Operation, error)
- func (it *OperationIterator) PageInfo() *iterator.PageInfo
- type RegisterInstanceOperation
- func (op *RegisterInstanceOperation) Done() bool
- func (op *RegisterInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *RegisterInstanceOperation) Name() string
- func (op *RegisterInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *RegisterInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type ReportInstanceInfoOperation
- func (op *ReportInstanceInfoOperation) Done() bool
- func (op *ReportInstanceInfoOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *ReportInstanceInfoOperation) Name() string
- func (op *ReportInstanceInfoOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *ReportInstanceInfoOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type ReportRuntimeEventOperation
- func (op *ReportRuntimeEventOperation) Done() bool
- func (op *ReportRuntimeEventOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *ReportRuntimeEventOperation) Name() string
- func (op *ReportRuntimeEventOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- func (op *ReportRuntimeEventOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- type ResetInstanceOperation
- func (op *ResetInstanceOperation) Done() bool
- func (op *ResetInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *ResetInstanceOperation) Name() string
- func (op *ResetInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *ResetInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type ResetRuntimeOperation
- func (op *ResetRuntimeOperation) Done() bool
- func (op *ResetRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *ResetRuntimeOperation) Name() string
- func (op *ResetRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- func (op *ResetRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- type RollbackInstanceOperation
- func (op *RollbackInstanceOperation) Done() bool
- func (op *RollbackInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *RollbackInstanceOperation) Name() string
- func (op *RollbackInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *RollbackInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type RuntimeIterator
- func (it *RuntimeIterator) All() iter.Seq2[*notebookspb.Runtime, error]
- func (it *RuntimeIterator) Next() (*notebookspb.Runtime, error)
- func (it *RuntimeIterator) PageInfo() *iterator.PageInfo
- type ScheduleIterator
- func (it *ScheduleIterator) All() iter.Seq2[*notebookspb.Schedule, error]
- func (it *ScheduleIterator) Next() (*notebookspb.Schedule, error)
- func (it *ScheduleIterator) PageInfo() *iterator.PageInfo
- type SetInstanceAcceleratorOperation
- func (op *SetInstanceAcceleratorOperation) Done() bool
- func (op *SetInstanceAcceleratorOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *SetInstanceAcceleratorOperation) Name() string
- func (op *SetInstanceAcceleratorOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *SetInstanceAcceleratorOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type SetInstanceLabelsOperation
- func (op *SetInstanceLabelsOperation) Done() bool
- func (op *SetInstanceLabelsOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *SetInstanceLabelsOperation) Name() string
- func (op *SetInstanceLabelsOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *SetInstanceLabelsOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type SetInstanceMachineTypeOperation
- func (op *SetInstanceMachineTypeOperation) Done() bool
- func (op *SetInstanceMachineTypeOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *SetInstanceMachineTypeOperation) Name() string
- func (op *SetInstanceMachineTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *SetInstanceMachineTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type StartInstanceOperation
- func (op *StartInstanceOperation) Done() bool
- func (op *StartInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *StartInstanceOperation) Name() string
- func (op *StartInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *StartInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type StartRuntimeOperation
- func (op *StartRuntimeOperation) Done() bool
- func (op *StartRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *StartRuntimeOperation) Name() string
- func (op *StartRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- func (op *StartRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- type StopInstanceOperation
- func (op *StopInstanceOperation) Done() bool
- func (op *StopInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *StopInstanceOperation) Name() string
- func (op *StopInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *StopInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type StopRuntimeOperation
- func (op *StopRuntimeOperation) Done() bool
- func (op *StopRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *StopRuntimeOperation) Name() string
- func (op *StopRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- func (op *StopRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- type SwitchRuntimeOperation
- func (op *SwitchRuntimeOperation) Done() bool
- func (op *SwitchRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *SwitchRuntimeOperation) Name() string
- func (op *SwitchRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- func (op *SwitchRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- type TriggerScheduleOperation
- func (op *TriggerScheduleOperation) Done() bool
- func (op *TriggerScheduleOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *TriggerScheduleOperation) Name() string
- func (op *TriggerScheduleOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Schedule, error)
- func (op *TriggerScheduleOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Schedule, error)
- type UpdateInstanceConfigOperation
- func (op *UpdateInstanceConfigOperation) Done() bool
- func (op *UpdateInstanceConfigOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *UpdateInstanceConfigOperation) Name() string
- func (op *UpdateInstanceConfigOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *UpdateInstanceConfigOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type UpdateRuntimeOperation
- func (op *UpdateRuntimeOperation) Done() bool
- func (op *UpdateRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *UpdateRuntimeOperation) Name() string
- func (op *UpdateRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- func (op *UpdateRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- type UpdateShieldedInstanceConfigOperation
- func (op *UpdateShieldedInstanceConfigOperation) Done() bool
- func (op *UpdateShieldedInstanceConfigOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *UpdateShieldedInstanceConfigOperation) Name() string
- func (op *UpdateShieldedInstanceConfigOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *UpdateShieldedInstanceConfigOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type UpgradeInstanceInternalOperation
- func (op *UpgradeInstanceInternalOperation) Done() bool
- func (op *UpgradeInstanceInternalOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *UpgradeInstanceInternalOperation) Name() string
- func (op *UpgradeInstanceInternalOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *UpgradeInstanceInternalOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type UpgradeInstanceOperation
- func (op *UpgradeInstanceOperation) Done() bool
- func (op *UpgradeInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *UpgradeInstanceOperation) Name() string
- func (op *UpgradeInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- func (op *UpgradeInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
- type UpgradeRuntimeOperation
- func (op *UpgradeRuntimeOperation) Done() bool
- func (op *UpgradeRuntimeOperation) Metadata() (*notebookspb.OperationMetadata, error)
- func (op *UpgradeRuntimeOperation) Name() string
- func (op *UpgradeRuntimeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
- func (op *UpgradeRuntimeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Runtime, error)
Examples ¶
- ManagedNotebookClient.CancelOperation
- ManagedNotebookClient.CreateRuntime
- ManagedNotebookClient.DeleteOperation
- ManagedNotebookClient.DeleteRuntime
- ManagedNotebookClient.DiagnoseRuntime
- ManagedNotebookClient.GetIamPolicy
- ManagedNotebookClient.GetLocation
- ManagedNotebookClient.GetOperation
- ManagedNotebookClient.GetRuntime
- ManagedNotebookClient.ListLocations
- ManagedNotebookClient.ListLocations (All)
- ManagedNotebookClient.ListOperations
- ManagedNotebookClient.ListOperations (All)
- ManagedNotebookClient.ListRuntimes
- ManagedNotebookClient.ListRuntimes (All)
- ManagedNotebookClient.RefreshRuntimeTokenInternal
- ManagedNotebookClient.ReportRuntimeEvent
- ManagedNotebookClient.ResetRuntime
- ManagedNotebookClient.SetIamPolicy
- ManagedNotebookClient.StartRuntime
- ManagedNotebookClient.StopRuntime
- ManagedNotebookClient.SwitchRuntime
- ManagedNotebookClient.TestIamPermissions
- ManagedNotebookClient.UpdateRuntime
- ManagedNotebookClient.UpgradeRuntime
- NewManagedNotebookClient
- NewNotebookClient
- NotebookClient.CancelOperation
- NotebookClient.CreateEnvironment
- NotebookClient.CreateExecution
- NotebookClient.CreateInstance
- NotebookClient.CreateSchedule
- NotebookClient.DeleteEnvironment
- NotebookClient.DeleteExecution
- NotebookClient.DeleteInstance
- NotebookClient.DeleteOperation
- NotebookClient.DeleteSchedule
- NotebookClient.DiagnoseInstance
- NotebookClient.GetEnvironment
- NotebookClient.GetExecution
- NotebookClient.GetIamPolicy
- NotebookClient.GetInstance
- NotebookClient.GetInstanceHealth
- NotebookClient.GetLocation
- NotebookClient.GetOperation
- NotebookClient.GetSchedule
- NotebookClient.IsInstanceUpgradeable
- NotebookClient.ListEnvironments
- NotebookClient.ListEnvironments (All)
- NotebookClient.ListExecutions
- NotebookClient.ListExecutions (All)
- NotebookClient.ListInstances
- NotebookClient.ListInstances (All)
- NotebookClient.ListLocations
- NotebookClient.ListLocations (All)
- NotebookClient.ListOperations
- NotebookClient.ListOperations (All)
- NotebookClient.ListSchedules
- NotebookClient.ListSchedules (All)
- NotebookClient.RegisterInstance
- NotebookClient.ReportInstanceInfo
- NotebookClient.ResetInstance
- NotebookClient.RollbackInstance
- NotebookClient.SetIamPolicy
- NotebookClient.SetInstanceAccelerator
- NotebookClient.SetInstanceLabels
- NotebookClient.SetInstanceMachineType
- NotebookClient.StartInstance
- NotebookClient.StopInstance
- NotebookClient.TestIamPermissions
- NotebookClient.TriggerSchedule
- NotebookClient.UpdateInstanceConfig
- NotebookClient.UpdateInstanceMetadataItems
- NotebookClient.UpdateShieldedInstanceConfig
- NotebookClient.UpgradeInstance
- NotebookClient.UpgradeInstanceInternal
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type CreateEnvironmentOperation ¶
type CreateEnvironmentOperation struct {
// contains filtered or unexported fields
}
CreateEnvironmentOperation manages a long-running operation from CreateEnvironment.
func (*CreateEnvironmentOperation) Done ¶
func (op *CreateEnvironmentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateEnvironmentOperation) Metadata ¶
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.
type 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.
type CreateInstanceOperation ¶
type CreateInstanceOperation struct {
// contains filtered or unexported fields
}
CreateInstanceOperation manages a long-running operation from CreateInstance.
func (*CreateInstanceOperation) Done ¶
func (op *CreateInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateInstanceOperation) Metadata ¶
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.
type 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.
type 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.
type DeleteEnvironmentOperation ¶
type DeleteEnvironmentOperation struct {
// contains filtered or unexported fields
}
DeleteEnvironmentOperation manages a long-running operation from DeleteEnvironment.
func (*DeleteEnvironmentOperation) Done ¶
func (op *DeleteEnvironmentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteEnvironmentOperation) Metadata ¶
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.
type 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.
type DeleteInstanceOperation ¶
type DeleteInstanceOperation struct {
// contains filtered or unexported fields
}
DeleteInstanceOperation manages a long-running operation from DeleteInstance.
func (*DeleteInstanceOperation) Done ¶
func (op *DeleteInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteInstanceOperation) Metadata ¶
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.
type 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.
type 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.
type 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.
type 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.
type EnvironmentIterator ¶
type EnvironmentIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*notebookspb.Environment, nextPageToken string, err error) // contains filtered or unexported fields }
EnvironmentIterator manages a stream of *notebookspb.Environment.
func (*EnvironmentIterator) 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.
type 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.
type InstanceIterator ¶
type InstanceIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*notebookspb.Instance, nextPageToken string, err error) // contains filtered or unexported fields }
InstanceIterator manages a stream of *notebookspb.Instance.
func (*InstanceIterator) 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.
type 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.
type 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.
type 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.
Code:play
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.
Code:play
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 ¶
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
Code:play
Example¶
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)
}
}
Example (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 and break/return/continue. Iteration will stop after any 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.
Code:play
Code:play
Example¶
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)
}
}
Example (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 and break/return/continue. Iteration will stop after any 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.
Code:play
Code:play
Example¶
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)
}
}
Example (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 and break/return/continue. Iteration will stop after any 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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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)
Code:play
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)
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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.
type 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.
type 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.
Code:play
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.
Code:play
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 ¶
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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
Code:play
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.
Code:play
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.
Code:play
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
Code:play
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.
Code:play
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.
Code:play
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
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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.
Code:play
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
Code:play
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.
Code:play
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.
Code:play
Code:play
Example¶
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)
}
}
Example (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 and break/return/continue. Iteration will stop after any 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
Code:play
Code:play
Example¶
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)
}
}
Example (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 and break/return/continue. Iteration will stop after any 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.
Code:play
Code:play
Example¶
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)
}
}
Example (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 and break/return/continue. Iteration will stop after any 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.
Code:play
Code:play
Example¶
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)
}
}
Example (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 and break/return/continue. Iteration will stop after any 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.
Code:play
Code:play
Example¶
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)
}
}
Example (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 and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*NotebookClient) ListSchedules ¶
func (c *NotebookClient) ListSchedules(ctx context.Context, req *notebookspb.ListSchedulesRequest, opts ...gax.CallOption) *ScheduleIterator
ListSchedules lists schedules in a given project and location.
Code:play
Code:play
Example¶
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.ListSchedulesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#ListSchedulesRequest.
}
it := c.ListSchedules(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// 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.ListSchedulesResponse)
}
}
Example (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.ListSchedulesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#ListSchedulesRequest.
}
for resp, err := range c.ListSchedules(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*NotebookClient) RegisterInstance ¶
func (c *NotebookClient) RegisterInstance(ctx context.Context, req *notebookspb.RegisterInstanceRequest, opts ...gax.CallOption) (*RegisterInstanceOperation, error)
RegisterInstance registers an existing legacy notebook instance to the Notebooks API server.
Legacy instances are instances created with the legacy Compute Engine
calls. They are not manageable by the Notebooks API out of the box. This
call makes these instances manageable by the Notebooks API.
Code:play
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.RegisterInstanceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#RegisterInstanceRequest.
}
op, err := c.RegisterInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) RegisterInstanceOperation ¶
func (c *NotebookClient) RegisterInstanceOperation(name string) *RegisterInstanceOperation
RegisterInstanceOperation returns a new RegisterInstanceOperation from a given name. The name must be that of a previously created RegisterInstanceOperation, possibly from a different process.
func (*NotebookClient) ReportInstanceInfo ¶
func (c *NotebookClient) ReportInstanceInfo(ctx context.Context, req *notebookspb.ReportInstanceInfoRequest, opts ...gax.CallOption) (*ReportInstanceInfoOperation, error)
ReportInstanceInfo allows notebook instances to
report their latest instance information to the Notebooks
API server. The server will merge the reported information to
the instance metadata store. Do not use this method directly.
Code:play
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.ReportInstanceInfoRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#ReportInstanceInfoRequest.
}
op, err := c.ReportInstanceInfo(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) ReportInstanceInfoOperation ¶
func (c *NotebookClient) ReportInstanceInfoOperation(name string) *ReportInstanceInfoOperation
ReportInstanceInfoOperation returns a new ReportInstanceInfoOperation from a given name. The name must be that of a previously created ReportInstanceInfoOperation, possibly from a different process.
func (*NotebookClient) ResetInstance ¶
func (c *NotebookClient) ResetInstance(ctx context.Context, req *notebookspb.ResetInstanceRequest, opts ...gax.CallOption) (*ResetInstanceOperation, error)
ResetInstance resets a notebook instance.
Code:play
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.ResetInstanceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#ResetInstanceRequest.
}
op, err := c.ResetInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) ResetInstanceOperation ¶
func (c *NotebookClient) ResetInstanceOperation(name string) *ResetInstanceOperation
ResetInstanceOperation returns a new ResetInstanceOperation from a given name. The name must be that of a previously created ResetInstanceOperation, possibly from a different process.
func (*NotebookClient) RollbackInstance ¶
func (c *NotebookClient) RollbackInstance(ctx context.Context, req *notebookspb.RollbackInstanceRequest, opts ...gax.CallOption) (*RollbackInstanceOperation, error)
RollbackInstance rollbacks a notebook instance to the previous version.
Code:play
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.RollbackInstanceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#RollbackInstanceRequest.
}
op, err := c.RollbackInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) RollbackInstanceOperation ¶
func (c *NotebookClient) RollbackInstanceOperation(name string) *RollbackInstanceOperation
RollbackInstanceOperation returns a new RollbackInstanceOperation from a given name. The name must be that of a previously created RollbackInstanceOperation, possibly from a different process.
func (*NotebookClient) SetIamPolicy ¶
func (c *NotebookClient) 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.
Code:play
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.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 (*NotebookClient) SetInstanceAccelerator ¶
func (c *NotebookClient) SetInstanceAccelerator(ctx context.Context, req *notebookspb.SetInstanceAcceleratorRequest, opts ...gax.CallOption) (*SetInstanceAcceleratorOperation, error)
SetInstanceAccelerator updates the guest accelerators of a single Instance.
Code:play
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.SetInstanceAcceleratorRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#SetInstanceAcceleratorRequest.
}
op, err := c.SetInstanceAccelerator(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) SetInstanceAcceleratorOperation ¶
func (c *NotebookClient) SetInstanceAcceleratorOperation(name string) *SetInstanceAcceleratorOperation
SetInstanceAcceleratorOperation returns a new SetInstanceAcceleratorOperation from a given name. The name must be that of a previously created SetInstanceAcceleratorOperation, possibly from a different process.
func (*NotebookClient) SetInstanceLabels ¶
func (c *NotebookClient) SetInstanceLabels(ctx context.Context, req *notebookspb.SetInstanceLabelsRequest, opts ...gax.CallOption) (*SetInstanceLabelsOperation, error)
SetInstanceLabels replaces all the labels of an Instance.
Code:play
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.SetInstanceLabelsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#SetInstanceLabelsRequest.
}
op, err := c.SetInstanceLabels(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) SetInstanceLabelsOperation ¶
func (c *NotebookClient) SetInstanceLabelsOperation(name string) *SetInstanceLabelsOperation
SetInstanceLabelsOperation returns a new SetInstanceLabelsOperation from a given name. The name must be that of a previously created SetInstanceLabelsOperation, possibly from a different process.
func (*NotebookClient) SetInstanceMachineType ¶
func (c *NotebookClient) SetInstanceMachineType(ctx context.Context, req *notebookspb.SetInstanceMachineTypeRequest, opts ...gax.CallOption) (*SetInstanceMachineTypeOperation, error)
SetInstanceMachineType updates the machine type of a single Instance.
Code:play
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.SetInstanceMachineTypeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#SetInstanceMachineTypeRequest.
}
op, err := c.SetInstanceMachineType(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) SetInstanceMachineTypeOperation ¶
func (c *NotebookClient) SetInstanceMachineTypeOperation(name string) *SetInstanceMachineTypeOperation
SetInstanceMachineTypeOperation returns a new SetInstanceMachineTypeOperation from a given name. The name must be that of a previously created SetInstanceMachineTypeOperation, possibly from a different process.
func (*NotebookClient) StartInstance ¶
func (c *NotebookClient) StartInstance(ctx context.Context, req *notebookspb.StartInstanceRequest, opts ...gax.CallOption) (*StartInstanceOperation, error)
StartInstance starts a notebook instance.
Code:play
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.StartInstanceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#StartInstanceRequest.
}
op, err := c.StartInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) StartInstanceOperation ¶
func (c *NotebookClient) StartInstanceOperation(name string) *StartInstanceOperation
StartInstanceOperation returns a new StartInstanceOperation from a given name. The name must be that of a previously created StartInstanceOperation, possibly from a different process.
func (*NotebookClient) StopInstance ¶
func (c *NotebookClient) StopInstance(ctx context.Context, req *notebookspb.StopInstanceRequest, opts ...gax.CallOption) (*StopInstanceOperation, error)
StopInstance stops a notebook instance.
Code:play
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.StopInstanceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#StopInstanceRequest.
}
op, err := c.StopInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) StopInstanceOperation ¶
func (c *NotebookClient) StopInstanceOperation(name string) *StopInstanceOperation
StopInstanceOperation returns a new StopInstanceOperation from a given name. The name must be that of a previously created StopInstanceOperation, possibly from a different process.
func (*NotebookClient) TestIamPermissions ¶
func (c *NotebookClient) 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.
Code:play
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.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 (*NotebookClient) TriggerSchedule ¶
func (c *NotebookClient) TriggerSchedule(ctx context.Context, req *notebookspb.TriggerScheduleRequest, opts ...gax.CallOption) (*TriggerScheduleOperation, error)
TriggerSchedule triggers execution of an existing schedule.
Code:play
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.TriggerScheduleRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#TriggerScheduleRequest.
}
op, err := c.TriggerSchedule(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) TriggerScheduleOperation ¶
func (c *NotebookClient) TriggerScheduleOperation(name string) *TriggerScheduleOperation
TriggerScheduleOperation returns a new TriggerScheduleOperation from a given name. The name must be that of a previously created TriggerScheduleOperation, possibly from a different process.
func (*NotebookClient) UpdateInstanceConfig ¶
func (c *NotebookClient) UpdateInstanceConfig(ctx context.Context, req *notebookspb.UpdateInstanceConfigRequest, opts ...gax.CallOption) (*UpdateInstanceConfigOperation, error)
UpdateInstanceConfig update Notebook Instance configurations.
Code:play
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.UpdateInstanceConfigRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#UpdateInstanceConfigRequest.
}
op, err := c.UpdateInstanceConfig(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) UpdateInstanceConfigOperation ¶
func (c *NotebookClient) UpdateInstanceConfigOperation(name string) *UpdateInstanceConfigOperation
UpdateInstanceConfigOperation returns a new UpdateInstanceConfigOperation from a given name. The name must be that of a previously created UpdateInstanceConfigOperation, possibly from a different process.
func (*NotebookClient) UpdateInstanceMetadataItems ¶
func (c *NotebookClient) UpdateInstanceMetadataItems(ctx context.Context, req *notebookspb.UpdateInstanceMetadataItemsRequest, opts ...gax.CallOption) (*notebookspb.UpdateInstanceMetadataItemsResponse, error)
UpdateInstanceMetadataItems add/update metadata items for an instance.
Code:play
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.UpdateInstanceMetadataItemsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#UpdateInstanceMetadataItemsRequest.
}
resp, err := c.UpdateInstanceMetadataItems(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) UpdateShieldedInstanceConfig ¶
func (c *NotebookClient) UpdateShieldedInstanceConfig(ctx context.Context, req *notebookspb.UpdateShieldedInstanceConfigRequest, opts ...gax.CallOption) (*UpdateShieldedInstanceConfigOperation, error)
UpdateShieldedInstanceConfig updates the Shielded instance configuration of a single Instance.
Code:play
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.UpdateShieldedInstanceConfigRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#UpdateShieldedInstanceConfigRequest.
}
op, err := c.UpdateShieldedInstanceConfig(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) UpdateShieldedInstanceConfigOperation ¶
func (c *NotebookClient) UpdateShieldedInstanceConfigOperation(name string) *UpdateShieldedInstanceConfigOperation
UpdateShieldedInstanceConfigOperation returns a new UpdateShieldedInstanceConfigOperation from a given name. The name must be that of a previously created UpdateShieldedInstanceConfigOperation, possibly from a different process.
func (*NotebookClient) UpgradeInstance ¶
func (c *NotebookClient) UpgradeInstance(ctx context.Context, req *notebookspb.UpgradeInstanceRequest, opts ...gax.CallOption) (*UpgradeInstanceOperation, error)
UpgradeInstance upgrades a notebook instance to the latest version.
Code:play
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.UpgradeInstanceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#UpgradeInstanceRequest.
}
op, err := c.UpgradeInstance(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) UpgradeInstanceInternal ¶
func (c *NotebookClient) UpgradeInstanceInternal(ctx context.Context, req *notebookspb.UpgradeInstanceInternalRequest, opts ...gax.CallOption) (*UpgradeInstanceInternalOperation, error)
UpgradeInstanceInternal allows notebook instances to
call this endpoint to upgrade themselves. Do not use this method directly.
Code:play
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.UpgradeInstanceInternalRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/notebooks/apiv1/notebookspb#UpgradeInstanceInternalRequest.
}
op, err := c.UpgradeInstanceInternal(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*NotebookClient) UpgradeInstanceInternalOperation ¶
func (c *NotebookClient) UpgradeInstanceInternalOperation(name string) *UpgradeInstanceInternalOperation
UpgradeInstanceInternalOperation returns a new UpgradeInstanceInternalOperation from a given name. The name must be that of a previously created UpgradeInstanceInternalOperation, possibly from a different process.
func (*NotebookClient) UpgradeInstanceOperation ¶
func (c *NotebookClient) UpgradeInstanceOperation(name string) *UpgradeInstanceOperation
UpgradeInstanceOperation returns a new UpgradeInstanceOperation from a given name. The name must be that of a previously created UpgradeInstanceOperation, possibly from a different process.
type OperationIterator ¶
type OperationIterator 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 []*longrunningpb.Operation, nextPageToken string, err error) // contains filtered or unexported fields }
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All ¶
func (it *OperationIterator) All() iter.Seq2[*longrunningpb.Operation, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*OperationIterator) Next ¶
func (it *OperationIterator) Next() (*longrunningpb.Operation, 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 (*OperationIterator) PageInfo ¶
func (it *OperationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type RegisterInstanceOperation ¶
type RegisterInstanceOperation struct {
// contains filtered or unexported fields
}
RegisterInstanceOperation manages a long-running operation from RegisterInstance.
func (*RegisterInstanceOperation) Done ¶
func (op *RegisterInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*RegisterInstanceOperation) Metadata ¶
func (op *RegisterInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*RegisterInstanceOperation) Name ¶
func (op *RegisterInstanceOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*RegisterInstanceOperation) Poll ¶
func (op *RegisterInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*RegisterInstanceOperation) Wait ¶
func (op *RegisterInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type ReportInstanceInfoOperation ¶
type ReportInstanceInfoOperation struct {
// contains filtered or unexported fields
}
ReportInstanceInfoOperation manages a long-running operation from ReportInstanceInfo.
func (*ReportInstanceInfoOperation) Done ¶
func (op *ReportInstanceInfoOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*ReportInstanceInfoOperation) Metadata ¶
func (op *ReportInstanceInfoOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ReportInstanceInfoOperation) Name ¶
func (op *ReportInstanceInfoOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ReportInstanceInfoOperation) Poll ¶
func (op *ReportInstanceInfoOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ReportInstanceInfoOperation) Wait ¶
func (op *ReportInstanceInfoOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type ReportRuntimeEventOperation ¶
type ReportRuntimeEventOperation struct {
// contains filtered or unexported fields
}
ReportRuntimeEventOperation manages a long-running operation from ReportRuntimeEvent.
func (*ReportRuntimeEventOperation) Done ¶
func (op *ReportRuntimeEventOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*ReportRuntimeEventOperation) Metadata ¶
func (op *ReportRuntimeEventOperation) 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 (*ReportRuntimeEventOperation) Name ¶
func (op *ReportRuntimeEventOperation) 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 (*ReportRuntimeEventOperation) Poll ¶
func (op *ReportRuntimeEventOperation) 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 (*ReportRuntimeEventOperation) Wait ¶
func (op *ReportRuntimeEventOperation) 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.
type ResetInstanceOperation ¶
type ResetInstanceOperation struct {
// contains filtered or unexported fields
}
ResetInstanceOperation manages a long-running operation from ResetInstance.
func (*ResetInstanceOperation) Done ¶
func (op *ResetInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*ResetInstanceOperation) Metadata ¶
func (op *ResetInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ResetInstanceOperation) Name ¶
func (op *ResetInstanceOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ResetInstanceOperation) Poll ¶
func (op *ResetInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ResetInstanceOperation) Wait ¶
func (op *ResetInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type ResetRuntimeOperation ¶
type ResetRuntimeOperation struct {
// contains filtered or unexported fields
}
ResetRuntimeOperation manages a long-running operation from ResetRuntime.
func (*ResetRuntimeOperation) Done ¶
func (op *ResetRuntimeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*ResetRuntimeOperation) Metadata ¶
func (op *ResetRuntimeOperation) 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 (*ResetRuntimeOperation) Name ¶
func (op *ResetRuntimeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ResetRuntimeOperation) Poll ¶
func (op *ResetRuntimeOperation) 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 (*ResetRuntimeOperation) Wait ¶
func (op *ResetRuntimeOperation) 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.
type RollbackInstanceOperation ¶
type RollbackInstanceOperation struct {
// contains filtered or unexported fields
}
RollbackInstanceOperation manages a long-running operation from RollbackInstance.
func (*RollbackInstanceOperation) Done ¶
func (op *RollbackInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*RollbackInstanceOperation) Metadata ¶
func (op *RollbackInstanceOperation) 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 (*RollbackInstanceOperation) Name ¶
func (op *RollbackInstanceOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*RollbackInstanceOperation) Poll ¶
func (op *RollbackInstanceOperation) 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 (*RollbackInstanceOperation) Wait ¶
func (op *RollbackInstanceOperation) 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.
type RuntimeIterator ¶
type RuntimeIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*notebookspb.Runtime, nextPageToken string, err error) // contains filtered or unexported fields }
RuntimeIterator manages a stream of *notebookspb.Runtime.
func (*RuntimeIterator) All ¶
func (it *RuntimeIterator) All() iter.Seq2[*notebookspb.Runtime, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*RuntimeIterator) Next ¶
func (it *RuntimeIterator) Next() (*notebookspb.Runtime, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*RuntimeIterator) PageInfo ¶
func (it *RuntimeIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type ScheduleIterator ¶
type ScheduleIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*notebookspb.Schedule, nextPageToken string, err error) // contains filtered or unexported fields }
ScheduleIterator manages a stream of *notebookspb.Schedule.
func (*ScheduleIterator) All ¶
func (it *ScheduleIterator) All() iter.Seq2[*notebookspb.Schedule, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ScheduleIterator) Next ¶
func (it *ScheduleIterator) Next() (*notebookspb.Schedule, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ScheduleIterator) PageInfo ¶
func (it *ScheduleIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type SetInstanceAcceleratorOperation ¶
type SetInstanceAcceleratorOperation struct {
// contains filtered or unexported fields
}
SetInstanceAcceleratorOperation manages a long-running operation from SetInstanceAccelerator.
func (*SetInstanceAcceleratorOperation) Done ¶
func (op *SetInstanceAcceleratorOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*SetInstanceAcceleratorOperation) Metadata ¶
func (op *SetInstanceAcceleratorOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*SetInstanceAcceleratorOperation) Name ¶
func (op *SetInstanceAcceleratorOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*SetInstanceAcceleratorOperation) Poll ¶
func (op *SetInstanceAcceleratorOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*SetInstanceAcceleratorOperation) Wait ¶
func (op *SetInstanceAcceleratorOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type SetInstanceLabelsOperation ¶
type SetInstanceLabelsOperation struct {
// contains filtered or unexported fields
}
SetInstanceLabelsOperation manages a long-running operation from SetInstanceLabels.
func (*SetInstanceLabelsOperation) Done ¶
func (op *SetInstanceLabelsOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*SetInstanceLabelsOperation) Metadata ¶
func (op *SetInstanceLabelsOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*SetInstanceLabelsOperation) Name ¶
func (op *SetInstanceLabelsOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*SetInstanceLabelsOperation) Poll ¶
func (op *SetInstanceLabelsOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*SetInstanceLabelsOperation) Wait ¶
func (op *SetInstanceLabelsOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type SetInstanceMachineTypeOperation ¶
type SetInstanceMachineTypeOperation struct {
// contains filtered or unexported fields
}
SetInstanceMachineTypeOperation manages a long-running operation from SetInstanceMachineType.
func (*SetInstanceMachineTypeOperation) Done ¶
func (op *SetInstanceMachineTypeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*SetInstanceMachineTypeOperation) Metadata ¶
func (op *SetInstanceMachineTypeOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*SetInstanceMachineTypeOperation) Name ¶
func (op *SetInstanceMachineTypeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*SetInstanceMachineTypeOperation) Poll ¶
func (op *SetInstanceMachineTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*SetInstanceMachineTypeOperation) Wait ¶
func (op *SetInstanceMachineTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type StartInstanceOperation ¶
type StartInstanceOperation struct {
// contains filtered or unexported fields
}
StartInstanceOperation manages a long-running operation from StartInstance.
func (*StartInstanceOperation) Done ¶
func (op *StartInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*StartInstanceOperation) Metadata ¶
func (op *StartInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*StartInstanceOperation) Name ¶
func (op *StartInstanceOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*StartInstanceOperation) Poll ¶
func (op *StartInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*StartInstanceOperation) Wait ¶
func (op *StartInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type StartRuntimeOperation ¶
type StartRuntimeOperation struct {
// contains filtered or unexported fields
}
StartRuntimeOperation manages a long-running operation from StartRuntime.
func (*StartRuntimeOperation) Done ¶
func (op *StartRuntimeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*StartRuntimeOperation) Metadata ¶
func (op *StartRuntimeOperation) 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 (*StartRuntimeOperation) Name ¶
func (op *StartRuntimeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*StartRuntimeOperation) Poll ¶
func (op *StartRuntimeOperation) 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 (*StartRuntimeOperation) Wait ¶
func (op *StartRuntimeOperation) 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.
type StopInstanceOperation ¶
type StopInstanceOperation struct {
// contains filtered or unexported fields
}
StopInstanceOperation manages a long-running operation from StopInstance.
func (*StopInstanceOperation) Done ¶
func (op *StopInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*StopInstanceOperation) Metadata ¶
func (op *StopInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*StopInstanceOperation) Name ¶
func (op *StopInstanceOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*StopInstanceOperation) Poll ¶
func (op *StopInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*StopInstanceOperation) Wait ¶
func (op *StopInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type StopRuntimeOperation ¶
type StopRuntimeOperation struct {
// contains filtered or unexported fields
}
StopRuntimeOperation manages a long-running operation from StopRuntime.
func (*StopRuntimeOperation) Done ¶
func (op *StopRuntimeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*StopRuntimeOperation) Metadata ¶
func (op *StopRuntimeOperation) 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 (*StopRuntimeOperation) Name ¶
func (op *StopRuntimeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*StopRuntimeOperation) Poll ¶
func (op *StopRuntimeOperation) 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 (*StopRuntimeOperation) Wait ¶
func (op *StopRuntimeOperation) 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.
type SwitchRuntimeOperation ¶
type SwitchRuntimeOperation struct {
// contains filtered or unexported fields
}
SwitchRuntimeOperation manages a long-running operation from SwitchRuntime.
func (*SwitchRuntimeOperation) Done ¶
func (op *SwitchRuntimeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*SwitchRuntimeOperation) Metadata ¶
func (op *SwitchRuntimeOperation) 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 (*SwitchRuntimeOperation) Name ¶
func (op *SwitchRuntimeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*SwitchRuntimeOperation) Poll ¶
func (op *SwitchRuntimeOperation) 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 (*SwitchRuntimeOperation) Wait ¶
func (op *SwitchRuntimeOperation) 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.
type TriggerScheduleOperation ¶
type TriggerScheduleOperation struct {
// contains filtered or unexported fields
}
TriggerScheduleOperation manages a long-running operation from TriggerSchedule.
func (*TriggerScheduleOperation) Done ¶
func (op *TriggerScheduleOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*TriggerScheduleOperation) Metadata ¶
func (op *TriggerScheduleOperation) 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 (*TriggerScheduleOperation) Name ¶
func (op *TriggerScheduleOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*TriggerScheduleOperation) Poll ¶
func (op *TriggerScheduleOperation) 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 (*TriggerScheduleOperation) Wait ¶
func (op *TriggerScheduleOperation) 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.
type UpdateInstanceConfigOperation ¶
type UpdateInstanceConfigOperation struct {
// contains filtered or unexported fields
}
UpdateInstanceConfigOperation manages a long-running operation from UpdateInstanceConfig.
func (*UpdateInstanceConfigOperation) Done ¶
func (op *UpdateInstanceConfigOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateInstanceConfigOperation) Metadata ¶
func (op *UpdateInstanceConfigOperation) 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 (*UpdateInstanceConfigOperation) Name ¶
func (op *UpdateInstanceConfigOperation) 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 (*UpdateInstanceConfigOperation) Poll ¶
func (op *UpdateInstanceConfigOperation) 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 (*UpdateInstanceConfigOperation) Wait ¶
func (op *UpdateInstanceConfigOperation) 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.
type UpdateRuntimeOperation ¶
type UpdateRuntimeOperation struct {
// contains filtered or unexported fields
}
UpdateRuntimeOperation manages a long-running operation from UpdateRuntime.
func (*UpdateRuntimeOperation) Done ¶
func (op *UpdateRuntimeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateRuntimeOperation) Metadata ¶
func (op *UpdateRuntimeOperation) 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 (*UpdateRuntimeOperation) Name ¶
func (op *UpdateRuntimeOperation) 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 (*UpdateRuntimeOperation) Poll ¶
func (op *UpdateRuntimeOperation) 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 (*UpdateRuntimeOperation) Wait ¶
func (op *UpdateRuntimeOperation) 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.
type UpdateShieldedInstanceConfigOperation ¶
type UpdateShieldedInstanceConfigOperation struct {
// contains filtered or unexported fields
}
UpdateShieldedInstanceConfigOperation manages a long-running operation from UpdateShieldedInstanceConfig.
func (*UpdateShieldedInstanceConfigOperation) Done ¶
func (op *UpdateShieldedInstanceConfigOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateShieldedInstanceConfigOperation) Metadata ¶
func (op *UpdateShieldedInstanceConfigOperation) 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 (*UpdateShieldedInstanceConfigOperation) Name ¶
func (op *UpdateShieldedInstanceConfigOperation) 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 (*UpdateShieldedInstanceConfigOperation) Poll ¶
func (op *UpdateShieldedInstanceConfigOperation) 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 (*UpdateShieldedInstanceConfigOperation) Wait ¶
func (op *UpdateShieldedInstanceConfigOperation) 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.
type UpgradeInstanceInternalOperation ¶
type UpgradeInstanceInternalOperation struct {
// contains filtered or unexported fields
}
UpgradeInstanceInternalOperation manages a long-running operation from UpgradeInstanceInternal.
func (*UpgradeInstanceInternalOperation) Done ¶
func (op *UpgradeInstanceInternalOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpgradeInstanceInternalOperation) Metadata ¶
func (op *UpgradeInstanceInternalOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpgradeInstanceInternalOperation) Name ¶
func (op *UpgradeInstanceInternalOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpgradeInstanceInternalOperation) Poll ¶
func (op *UpgradeInstanceInternalOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpgradeInstanceInternalOperation) Wait ¶
func (op *UpgradeInstanceInternalOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpgradeInstanceOperation ¶
type UpgradeInstanceOperation struct {
// contains filtered or unexported fields
}
UpgradeInstanceOperation manages a long-running operation from UpgradeInstance.
func (*UpgradeInstanceOperation) Done ¶
func (op *UpgradeInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpgradeInstanceOperation) Metadata ¶
func (op *UpgradeInstanceOperation) Metadata() (*notebookspb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpgradeInstanceOperation) Name ¶
func (op *UpgradeInstanceOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpgradeInstanceOperation) Poll ¶
func (op *UpgradeInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpgradeInstanceOperation) Wait ¶
func (op *UpgradeInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*notebookspb.Instance, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpgradeRuntimeOperation ¶
type UpgradeRuntimeOperation struct {
// contains filtered or unexported fields
}
UpgradeRuntimeOperation manages a long-running operation from UpgradeRuntime.
func (*UpgradeRuntimeOperation) Done ¶
func (op *UpgradeRuntimeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpgradeRuntimeOperation) Metadata ¶
func (op *UpgradeRuntimeOperation) 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 (*UpgradeRuntimeOperation) Name ¶
func (op *UpgradeRuntimeOperation) 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 (*UpgradeRuntimeOperation) Poll ¶
func (op *UpgradeRuntimeOperation) 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 (*UpgradeRuntimeOperation) Wait ¶
func (op *UpgradeRuntimeOperation) 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.
Source Files ¶
auxiliary.go auxiliary_go123.go doc.go helpers.go managed_notebook_client.go notebook_client.go version.go
Directories ¶
Path | Synopsis |
---|---|
apiv1/notebookspb |
- Version
- v1.12.3 (latest)
- Published
- Jan 2, 2025
- Platform
- linux/amd64
- Imports
- 24 packages
- Last checked
- 5 days ago –
Tools for package owners.