Package com.google.cloud.notebooks.v1 (1.40.0)

GitHub Repository

This package is not the recommended entry point to using this client library!

For this library, we recommend using com.google.cloud.notebooks.v2 for new applications.

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.notebooks.v1.ManagedNotebookServiceClient Service Description: API v1 service for Managed Notebooks.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

com.google.cloud.notebooks.v1.NotebookServiceClient Service Description: API v1 service for Cloud AI Platform Notebooks.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.notebooks.v1.ManagedNotebookServiceSettings Settings class to configure an instance of ManagedNotebookServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.notebooks.v1.NotebookServiceSettings Settings class to configure an instance of NotebookServiceClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.notebooks.v1.ContainerImage Definition of a container image for starting a notebook instance with the environment installed in a container.
com.google.cloud.notebooks.v1.ContainerImage.Builder Definition of a container image for starting a notebook instance with the environment installed in a container.
com.google.cloud.notebooks.v1.CreateEnvironmentRequest Request for creating a notebook environment.
com.google.cloud.notebooks.v1.CreateEnvironmentRequest.Builder Request for creating a notebook environment.
com.google.cloud.notebooks.v1.CreateExecutionRequest Request to create notebook execution
com.google.cloud.notebooks.v1.CreateExecutionRequest.Builder Request to create notebook execution
com.google.cloud.notebooks.v1.CreateInstanceRequest Request for creating a notebook instance.
com.google.cloud.notebooks.v1.CreateInstanceRequest.Builder Request for creating a notebook instance.
com.google.cloud.notebooks.v1.CreateRuntimeRequest Request for creating a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.CreateRuntimeRequest.Builder Request for creating a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.CreateScheduleRequest Request for created scheduled notebooks
com.google.cloud.notebooks.v1.CreateScheduleRequest.Builder Request for created scheduled notebooks
com.google.cloud.notebooks.v1.DeleteEnvironmentRequest Request for deleting a notebook environment.
com.google.cloud.notebooks.v1.DeleteEnvironmentRequest.Builder Request for deleting a notebook environment.
com.google.cloud.notebooks.v1.DeleteExecutionRequest Request for deleting a scheduled notebook execution
com.google.cloud.notebooks.v1.DeleteExecutionRequest.Builder Request for deleting a scheduled notebook execution
com.google.cloud.notebooks.v1.DeleteInstanceRequest Request for deleting a notebook instance.
com.google.cloud.notebooks.v1.DeleteInstanceRequest.Builder Request for deleting a notebook instance.
com.google.cloud.notebooks.v1.DeleteRuntimeRequest Request for deleting a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.DeleteRuntimeRequest.Builder Request for deleting a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.DeleteScheduleRequest Request for deleting an Schedule
com.google.cloud.notebooks.v1.DeleteScheduleRequest.Builder Request for deleting an Schedule
com.google.cloud.notebooks.v1.DiagnoseInstanceRequest Request for creating a notebook instance diagnostic file.
com.google.cloud.notebooks.v1.DiagnoseInstanceRequest.Builder Request for creating a notebook instance diagnostic file.
com.google.cloud.notebooks.v1.DiagnoseRuntimeRequest Request for creating a notebook instance diagnostic file.
com.google.cloud.notebooks.v1.DiagnoseRuntimeRequest.Builder Request for creating a notebook instance diagnostic file.
com.google.cloud.notebooks.v1.DiagnosticConfig Defines flags that are used to run the diagnostic tool
com.google.cloud.notebooks.v1.DiagnosticConfig.Builder Defines flags that are used to run the diagnostic tool
com.google.cloud.notebooks.v1.DiagnosticConfigProto
com.google.cloud.notebooks.v1.EncryptionConfig Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.
com.google.cloud.notebooks.v1.EncryptionConfig.Builder Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.
com.google.cloud.notebooks.v1.Environment Definition of a software environment that is used to start a notebook instance.
com.google.cloud.notebooks.v1.Environment.Builder Definition of a software environment that is used to start a notebook instance.
com.google.cloud.notebooks.v1.EnvironmentProto
com.google.cloud.notebooks.v1.Event The definition of an Event for a managed / semi-managed notebook instance.
com.google.cloud.notebooks.v1.Event.Builder The definition of an Event for a managed / semi-managed notebook instance.
com.google.cloud.notebooks.v1.EventProto
com.google.cloud.notebooks.v1.Execution The definition of a single executed notebook.
com.google.cloud.notebooks.v1.Execution.Builder The definition of a single executed notebook.
com.google.cloud.notebooks.v1.ExecutionName
com.google.cloud.notebooks.v1.ExecutionName.Builder Builder for projects/{project}/location/{location}/executions/{execution}.
com.google.cloud.notebooks.v1.ExecutionProto
com.google.cloud.notebooks.v1.ExecutionTemplate The description a notebook execution workload.
com.google.cloud.notebooks.v1.ExecutionTemplate.Builder The description a notebook execution workload.
com.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters Parameters used in Dataproc JobType executions.
com.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters.Builder Parameters used in Dataproc JobType executions.
com.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. Check GPUs on Compute Engine to find a valid
com.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig.Builder Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. Check GPUs on Compute Engine to find a valid
com.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters Parameters used in Vertex AI JobType executions.
com.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters.Builder Parameters used in Vertex AI JobType executions.
com.google.cloud.notebooks.v1.GetEnvironmentRequest Request for getting a notebook environment.
com.google.cloud.notebooks.v1.GetEnvironmentRequest.Builder Request for getting a notebook environment.
com.google.cloud.notebooks.v1.GetExecutionRequest Request for getting scheduled notebook execution
com.google.cloud.notebooks.v1.GetExecutionRequest.Builder Request for getting scheduled notebook execution
com.google.cloud.notebooks.v1.GetInstanceHealthRequest Request for checking if a notebook instance is healthy.
com.google.cloud.notebooks.v1.GetInstanceHealthRequest.Builder Request for checking if a notebook instance is healthy.
com.google.cloud.notebooks.v1.GetInstanceHealthResponse Response for checking if a notebook instance is healthy.
com.google.cloud.notebooks.v1.GetInstanceHealthResponse.Builder Response for checking if a notebook instance is healthy.
com.google.cloud.notebooks.v1.GetInstanceRequest Request for getting a notebook instance.
com.google.cloud.notebooks.v1.GetInstanceRequest.Builder Request for getting a notebook instance.
com.google.cloud.notebooks.v1.GetRuntimeRequest Request for getting a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.GetRuntimeRequest.Builder Request for getting a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.GetScheduleRequest Request for getting scheduled notebook.
com.google.cloud.notebooks.v1.GetScheduleRequest.Builder Request for getting scheduled notebook.
com.google.cloud.notebooks.v1.Instance The definition of a notebook instance.
com.google.cloud.notebooks.v1.Instance.AcceleratorConfig Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. Check GPUs on Compute Engine to find a
com.google.cloud.notebooks.v1.Instance.AcceleratorConfig.Builder Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. Check GPUs on Compute Engine to find a
com.google.cloud.notebooks.v1.Instance.Builder The definition of a notebook instance.
com.google.cloud.notebooks.v1.Instance.Disk An instance-attached disk resource.
com.google.cloud.notebooks.v1.Instance.Disk.Builder An instance-attached disk resource.
com.google.cloud.notebooks.v1.Instance.Disk.GuestOsFeature Guest OS features for boot disk.
com.google.cloud.notebooks.v1.Instance.Disk.GuestOsFeature.Builder Guest OS features for boot disk.
com.google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig A set of Shielded Instance options. Check Images using supported Shielded VM features.
com.google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig.Builder A set of Shielded Instance options. Check Images using supported Shielded VM features.
com.google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry The entry of VM image upgrade history.
com.google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry.Builder The entry of VM image upgrade history.
com.google.cloud.notebooks.v1.InstanceConfig Notebook instance configurations that can be updated.
com.google.cloud.notebooks.v1.InstanceConfig.Builder Notebook instance configurations that can be updated.
com.google.cloud.notebooks.v1.InstanceConfigProto
com.google.cloud.notebooks.v1.InstanceName
com.google.cloud.notebooks.v1.InstanceName.Builder Builder for projects/{project}/instances/{instance}.
com.google.cloud.notebooks.v1.InstanceProto
com.google.cloud.notebooks.v1.IsInstanceUpgradeableRequest Request for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v1.IsInstanceUpgradeableRequest.Builder Request for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v1.IsInstanceUpgradeableResponse Response for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v1.IsInstanceUpgradeableResponse.Builder Response for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v1.ListEnvironmentsRequest Request for listing environments.
com.google.cloud.notebooks.v1.ListEnvironmentsRequest.Builder Request for listing environments.
com.google.cloud.notebooks.v1.ListEnvironmentsResponse Response for listing environments.
com.google.cloud.notebooks.v1.ListEnvironmentsResponse.Builder Response for listing environments.
com.google.cloud.notebooks.v1.ListExecutionsRequest Request for listing scheduled notebook executions.
com.google.cloud.notebooks.v1.ListExecutionsRequest.Builder Request for listing scheduled notebook executions.
com.google.cloud.notebooks.v1.ListExecutionsResponse Response for listing scheduled notebook executions
com.google.cloud.notebooks.v1.ListExecutionsResponse.Builder Response for listing scheduled notebook executions
com.google.cloud.notebooks.v1.ListInstancesRequest Request for listing notebook instances.
com.google.cloud.notebooks.v1.ListInstancesRequest.Builder Request for listing notebook instances.
com.google.cloud.notebooks.v1.ListInstancesResponse Response for listing notebook instances.
com.google.cloud.notebooks.v1.ListInstancesResponse.Builder Response for listing notebook instances.
com.google.cloud.notebooks.v1.ListRuntimesRequest Request for listing Managed Notebook Runtimes.
com.google.cloud.notebooks.v1.ListRuntimesRequest.Builder Request for listing Managed Notebook Runtimes.
com.google.cloud.notebooks.v1.ListRuntimesResponse Response for listing Managed Notebook Runtimes.
com.google.cloud.notebooks.v1.ListRuntimesResponse.Builder Response for listing Managed Notebook Runtimes.
com.google.cloud.notebooks.v1.ListSchedulesRequest Request for listing scheduled notebook job.
com.google.cloud.notebooks.v1.ListSchedulesRequest.Builder Request for listing scheduled notebook job.
com.google.cloud.notebooks.v1.ListSchedulesResponse Response for listing scheduled notebook job.
com.google.cloud.notebooks.v1.ListSchedulesResponse.Builder Response for listing scheduled notebook job.
com.google.cloud.notebooks.v1.LocalDisk A Local attached disk resource.
com.google.cloud.notebooks.v1.LocalDisk.Builder A Local attached disk resource.
com.google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system
com.google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature.Builder Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system
com.google.cloud.notebooks.v1.LocalDiskInitializeParams Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime.
com.google.cloud.notebooks.v1.LocalDiskInitializeParams.Builder Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime.
com.google.cloud.notebooks.v1.LocationName
com.google.cloud.notebooks.v1.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.notebooks.v1.ManagedNotebookServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.notebooks.v1.ManagedNotebookServiceClient.ListLocationsPage
com.google.cloud.notebooks.v1.ManagedNotebookServiceClient.ListLocationsPagedResponse
com.google.cloud.notebooks.v1.ManagedNotebookServiceClient.ListRuntimesFixedSizeCollection
com.google.cloud.notebooks.v1.ManagedNotebookServiceClient.ListRuntimesPage
com.google.cloud.notebooks.v1.ManagedNotebookServiceClient.ListRuntimesPagedResponse
com.google.cloud.notebooks.v1.ManagedNotebookServiceGrpc API v1 service for Managed Notebooks.
com.google.cloud.notebooks.v1.ManagedNotebookServiceGrpc.ManagedNotebookServiceImplBase Base class for the server implementation of the service ManagedNotebookService. API v1 service for Managed Notebooks.
com.google.cloud.notebooks.v1.ManagedNotebookServiceSettings.Builder Builder for ManagedNotebookServiceSettings.
com.google.cloud.notebooks.v1.ManagedNotebooksProto
com.google.cloud.notebooks.v1.NotebookServiceClient.ListEnvironmentsFixedSizeCollection
com.google.cloud.notebooks.v1.NotebookServiceClient.ListEnvironmentsPage
com.google.cloud.notebooks.v1.NotebookServiceClient.ListEnvironmentsPagedResponse
com.google.cloud.notebooks.v1.NotebookServiceClient.ListExecutionsFixedSizeCollection
com.google.cloud.notebooks.v1.NotebookServiceClient.ListExecutionsPage
com.google.cloud.notebooks.v1.NotebookServiceClient.ListExecutionsPagedResponse
com.google.cloud.notebooks.v1.NotebookServiceClient.ListInstancesFixedSizeCollection
com.google.cloud.notebooks.v1.NotebookServiceClient.ListInstancesPage
com.google.cloud.notebooks.v1.NotebookServiceClient.ListInstancesPagedResponse
com.google.cloud.notebooks.v1.NotebookServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.notebooks.v1.NotebookServiceClient.ListLocationsPage
com.google.cloud.notebooks.v1.NotebookServiceClient.ListLocationsPagedResponse
com.google.cloud.notebooks.v1.NotebookServiceClient.ListSchedulesFixedSizeCollection
com.google.cloud.notebooks.v1.NotebookServiceClient.ListSchedulesPage
com.google.cloud.notebooks.v1.NotebookServiceClient.ListSchedulesPagedResponse
com.google.cloud.notebooks.v1.NotebookServiceGrpc API v1 service for Cloud AI Platform Notebooks.
com.google.cloud.notebooks.v1.NotebookServiceGrpc.NotebookServiceImplBase Base class for the server implementation of the service NotebookService. API v1 service for Cloud AI Platform Notebooks.
com.google.cloud.notebooks.v1.NotebookServiceSettings.Builder Builder for NotebookServiceSettings.
com.google.cloud.notebooks.v1.NotebooksProto
com.google.cloud.notebooks.v1.OperationMetadata Represents the metadata of the long-running operation.
com.google.cloud.notebooks.v1.OperationMetadata.Builder Represents the metadata of the long-running operation.
com.google.cloud.notebooks.v1.RefreshRuntimeTokenInternalRequest Request for getting a new access token.
com.google.cloud.notebooks.v1.RefreshRuntimeTokenInternalRequest.Builder Request for getting a new access token.
com.google.cloud.notebooks.v1.RefreshRuntimeTokenInternalResponse Response with a new access token.
com.google.cloud.notebooks.v1.RefreshRuntimeTokenInternalResponse.Builder Response with a new access token.
com.google.cloud.notebooks.v1.RegisterInstanceRequest Request for registering a notebook instance.
com.google.cloud.notebooks.v1.RegisterInstanceRequest.Builder Request for registering a notebook instance.
com.google.cloud.notebooks.v1.ReportInstanceInfoRequest Request for notebook instances to report information to Notebooks API.
com.google.cloud.notebooks.v1.ReportInstanceInfoRequest.Builder Request for notebook instances to report information to Notebooks API.
com.google.cloud.notebooks.v1.ReportRuntimeEventRequest Request for reporting a Managed Notebook Event.
com.google.cloud.notebooks.v1.ReportRuntimeEventRequest.Builder Request for reporting a Managed Notebook Event.
com.google.cloud.notebooks.v1.ReservationAffinity Reservation Affinity for consuming Zonal reservation.
com.google.cloud.notebooks.v1.ReservationAffinity.Builder Reservation Affinity for consuming Zonal reservation.
com.google.cloud.notebooks.v1.ResetInstanceRequest Request for resetting a notebook instance
com.google.cloud.notebooks.v1.ResetInstanceRequest.Builder Request for resetting a notebook instance
com.google.cloud.notebooks.v1.ResetRuntimeRequest Request for resetting a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.ResetRuntimeRequest.Builder Request for resetting a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.RollbackInstanceRequest Request for rollbacking a notebook instance
com.google.cloud.notebooks.v1.RollbackInstanceRequest.Builder Request for rollbacking a notebook instance
com.google.cloud.notebooks.v1.Runtime The definition of a Runtime for a managed notebook instance.
com.google.cloud.notebooks.v1.Runtime.Builder The definition of a Runtime for a managed notebook instance.
com.google.cloud.notebooks.v1.RuntimeAcceleratorConfig Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See Compute Engine
com.google.cloud.notebooks.v1.RuntimeAcceleratorConfig.Builder Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See Compute Engine
com.google.cloud.notebooks.v1.RuntimeAccessConfig Specifies the login configuration for Runtime
com.google.cloud.notebooks.v1.RuntimeAccessConfig.Builder Specifies the login configuration for Runtime
com.google.cloud.notebooks.v1.RuntimeMetrics Contains runtime daemon metrics, such as OS and kernels and sessions stats.
com.google.cloud.notebooks.v1.RuntimeMetrics.Builder Contains runtime daemon metrics, such as OS and kernels and sessions stats.
com.google.cloud.notebooks.v1.RuntimeName
com.google.cloud.notebooks.v1.RuntimeName.Builder Builder for projects/{project}/locations/{location}/runtimes/{runtime}.
com.google.cloud.notebooks.v1.RuntimeProto
com.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig A set of Shielded Instance options. Check Images using supported Shielded VM features.
com.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig.Builder A set of Shielded Instance options. Check Images using supported Shielded VM features.
com.google.cloud.notebooks.v1.RuntimeSoftwareConfig Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in key:value format, for example:
com.google.cloud.notebooks.v1.RuntimeSoftwareConfig.Builder Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in key:value format, for example:
com.google.cloud.notebooks.v1.Schedule The definition of a schedule.
com.google.cloud.notebooks.v1.Schedule.Builder The definition of a schedule.
com.google.cloud.notebooks.v1.ScheduleName
com.google.cloud.notebooks.v1.ScheduleName.Builder Builder for projects/{project}/location/{location}/schedules/{schedule}.
com.google.cloud.notebooks.v1.ScheduleProto
com.google.cloud.notebooks.v1.SetInstanceAcceleratorRequest Request for setting instance accelerator.
com.google.cloud.notebooks.v1.SetInstanceAcceleratorRequest.Builder Request for setting instance accelerator.
com.google.cloud.notebooks.v1.SetInstanceLabelsRequest Request for setting instance labels.
com.google.cloud.notebooks.v1.SetInstanceLabelsRequest.Builder Request for setting instance labels.
com.google.cloud.notebooks.v1.SetInstanceMachineTypeRequest Request for setting instance machine type.
com.google.cloud.notebooks.v1.SetInstanceMachineTypeRequest.Builder Request for setting instance machine type.
com.google.cloud.notebooks.v1.StartInstanceRequest Request for starting a notebook instance
com.google.cloud.notebooks.v1.StartInstanceRequest.Builder Request for starting a notebook instance
com.google.cloud.notebooks.v1.StartRuntimeRequest Request for starting a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.StartRuntimeRequest.Builder Request for starting a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.StopInstanceRequest Request for stopping a notebook instance
com.google.cloud.notebooks.v1.StopInstanceRequest.Builder Request for stopping a notebook instance
com.google.cloud.notebooks.v1.StopRuntimeRequest Request for stopping a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.StopRuntimeRequest.Builder Request for stopping a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.SwitchRuntimeRequest Request for switching a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.SwitchRuntimeRequest.Builder Request for switching a Managed Notebook Runtime.
com.google.cloud.notebooks.v1.TriggerScheduleRequest Request for created scheduled notebooks
com.google.cloud.notebooks.v1.TriggerScheduleRequest.Builder Request for created scheduled notebooks
com.google.cloud.notebooks.v1.UpdateInstanceConfigRequest Request for updating instance configurations.
com.google.cloud.notebooks.v1.UpdateInstanceConfigRequest.Builder Request for updating instance configurations.
com.google.cloud.notebooks.v1.UpdateInstanceMetadataItemsRequest Request for adding/changing metadata items for an instance.
com.google.cloud.notebooks.v1.UpdateInstanceMetadataItemsRequest.Builder Request for adding/changing metadata items for an instance.
com.google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponse Response for adding/changing metadata items for an instance.
com.google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponse.Builder Response for adding/changing metadata items for an instance.
com.google.cloud.notebooks.v1.UpdateRuntimeRequest Request for updating a Managed Notebook configuration.
com.google.cloud.notebooks.v1.UpdateRuntimeRequest.Builder Request for updating a Managed Notebook configuration.
com.google.cloud.notebooks.v1.UpdateShieldedInstanceConfigRequest Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance
com.google.cloud.notebooks.v1.UpdateShieldedInstanceConfigRequest.Builder Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance
com.google.cloud.notebooks.v1.UpgradeInstanceInternalRequest Request for upgrading a notebook instance from within the VM
com.google.cloud.notebooks.v1.UpgradeInstanceInternalRequest.Builder Request for upgrading a notebook instance from within the VM
com.google.cloud.notebooks.v1.UpgradeInstanceRequest Request for upgrading a notebook instance
com.google.cloud.notebooks.v1.UpgradeInstanceRequest.Builder Request for upgrading a notebook instance
com.google.cloud.notebooks.v1.UpgradeRuntimeRequest Request for upgrading a Managed Notebook Runtime to the latest version. option (google.api.message_visibility).restriction = "TRUSTED_TESTER,SPECIAL_TESTER";
com.google.cloud.notebooks.v1.UpgradeRuntimeRequest.Builder Request for upgrading a Managed Notebook Runtime to the latest version. option (google.api.message_visibility).restriction = "TRUSTED_TESTER,SPECIAL_TESTER";
com.google.cloud.notebooks.v1.VirtualMachine Runtime using Virtual Machine for computing.
com.google.cloud.notebooks.v1.VirtualMachine.Builder Runtime using Virtual Machine for computing.
com.google.cloud.notebooks.v1.VirtualMachineConfig The config settings for virtual machine.
com.google.cloud.notebooks.v1.VirtualMachineConfig.BootImage Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.
com.google.cloud.notebooks.v1.VirtualMachineConfig.BootImage.Builder Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.
com.google.cloud.notebooks.v1.VirtualMachineConfig.Builder The config settings for virtual machine.
com.google.cloud.notebooks.v1.VmImage Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.
com.google.cloud.notebooks.v1.VmImage.Builder Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.

Interfaces

Interface Description
com.google.cloud.notebooks.v1.ContainerImageOrBuilder
com.google.cloud.notebooks.v1.CreateEnvironmentRequestOrBuilder
com.google.cloud.notebooks.v1.CreateExecutionRequestOrBuilder
com.google.cloud.notebooks.v1.CreateInstanceRequestOrBuilder
com.google.cloud.notebooks.v1.CreateRuntimeRequestOrBuilder
com.google.cloud.notebooks.v1.CreateScheduleRequestOrBuilder
com.google.cloud.notebooks.v1.DeleteEnvironmentRequestOrBuilder
com.google.cloud.notebooks.v1.DeleteExecutionRequestOrBuilder
com.google.cloud.notebooks.v1.DeleteInstanceRequestOrBuilder
com.google.cloud.notebooks.v1.DeleteRuntimeRequestOrBuilder
com.google.cloud.notebooks.v1.DeleteScheduleRequestOrBuilder
com.google.cloud.notebooks.v1.DiagnoseInstanceRequestOrBuilder
com.google.cloud.notebooks.v1.DiagnoseRuntimeRequestOrBuilder
com.google.cloud.notebooks.v1.DiagnosticConfigOrBuilder
com.google.cloud.notebooks.v1.EncryptionConfigOrBuilder
com.google.cloud.notebooks.v1.EnvironmentOrBuilder
com.google.cloud.notebooks.v1.EventOrBuilder
com.google.cloud.notebooks.v1.ExecutionOrBuilder
com.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParametersOrBuilder
com.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfigOrBuilder
com.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParametersOrBuilder
com.google.cloud.notebooks.v1.ExecutionTemplateOrBuilder
com.google.cloud.notebooks.v1.GetEnvironmentRequestOrBuilder
com.google.cloud.notebooks.v1.GetExecutionRequestOrBuilder
com.google.cloud.notebooks.v1.GetInstanceHealthRequestOrBuilder
com.google.cloud.notebooks.v1.GetInstanceHealthResponseOrBuilder
com.google.cloud.notebooks.v1.GetInstanceRequestOrBuilder
com.google.cloud.notebooks.v1.GetRuntimeRequestOrBuilder
com.google.cloud.notebooks.v1.GetScheduleRequestOrBuilder
com.google.cloud.notebooks.v1.Instance.AcceleratorConfigOrBuilder
com.google.cloud.notebooks.v1.Instance.Disk.GuestOsFeatureOrBuilder
com.google.cloud.notebooks.v1.Instance.DiskOrBuilder
com.google.cloud.notebooks.v1.Instance.ShieldedInstanceConfigOrBuilder
com.google.cloud.notebooks.v1.Instance.UpgradeHistoryEntryOrBuilder
com.google.cloud.notebooks.v1.InstanceConfigOrBuilder
com.google.cloud.notebooks.v1.InstanceOrBuilder
com.google.cloud.notebooks.v1.IsInstanceUpgradeableRequestOrBuilder
com.google.cloud.notebooks.v1.IsInstanceUpgradeableResponseOrBuilder
com.google.cloud.notebooks.v1.ListEnvironmentsRequestOrBuilder
com.google.cloud.notebooks.v1.ListEnvironmentsResponseOrBuilder
com.google.cloud.notebooks.v1.ListExecutionsRequestOrBuilder
com.google.cloud.notebooks.v1.ListExecutionsResponseOrBuilder
com.google.cloud.notebooks.v1.ListInstancesRequestOrBuilder
com.google.cloud.notebooks.v1.ListInstancesResponseOrBuilder
com.google.cloud.notebooks.v1.ListRuntimesRequestOrBuilder
com.google.cloud.notebooks.v1.ListRuntimesResponseOrBuilder
com.google.cloud.notebooks.v1.ListSchedulesRequestOrBuilder
com.google.cloud.notebooks.v1.ListSchedulesResponseOrBuilder
com.google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeatureOrBuilder
com.google.cloud.notebooks.v1.LocalDiskInitializeParamsOrBuilder
com.google.cloud.notebooks.v1.LocalDiskOrBuilder
com.google.cloud.notebooks.v1.ManagedNotebookServiceGrpc.AsyncService API v1 service for Managed Notebooks.
com.google.cloud.notebooks.v1.NotebookServiceGrpc.AsyncService API v1 service for Cloud AI Platform Notebooks.
com.google.cloud.notebooks.v1.OperationMetadataOrBuilder
com.google.cloud.notebooks.v1.RefreshRuntimeTokenInternalRequestOrBuilder
com.google.cloud.notebooks.v1.RefreshRuntimeTokenInternalResponseOrBuilder
com.google.cloud.notebooks.v1.RegisterInstanceRequestOrBuilder
com.google.cloud.notebooks.v1.ReportInstanceInfoRequestOrBuilder
com.google.cloud.notebooks.v1.ReportRuntimeEventRequestOrBuilder
com.google.cloud.notebooks.v1.ReservationAffinityOrBuilder
com.google.cloud.notebooks.v1.ResetInstanceRequestOrBuilder
com.google.cloud.notebooks.v1.ResetRuntimeRequestOrBuilder
com.google.cloud.notebooks.v1.RollbackInstanceRequestOrBuilder
com.google.cloud.notebooks.v1.RuntimeAcceleratorConfigOrBuilder
com.google.cloud.notebooks.v1.RuntimeAccessConfigOrBuilder
com.google.cloud.notebooks.v1.RuntimeMetricsOrBuilder
com.google.cloud.notebooks.v1.RuntimeOrBuilder
com.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfigOrBuilder
com.google.cloud.notebooks.v1.RuntimeSoftwareConfigOrBuilder
com.google.cloud.notebooks.v1.ScheduleOrBuilder
com.google.cloud.notebooks.v1.SetInstanceAcceleratorRequestOrBuilder
com.google.cloud.notebooks.v1.SetInstanceLabelsRequestOrBuilder
com.google.cloud.notebooks.v1.SetInstanceMachineTypeRequestOrBuilder
com.google.cloud.notebooks.v1.StartInstanceRequestOrBuilder
com.google.cloud.notebooks.v1.StartRuntimeRequestOrBuilder
com.google.cloud.notebooks.v1.StopInstanceRequestOrBuilder
com.google.cloud.notebooks.v1.StopRuntimeRequestOrBuilder
com.google.cloud.notebooks.v1.SwitchRuntimeRequestOrBuilder
com.google.cloud.notebooks.v1.TriggerScheduleRequestOrBuilder
com.google.cloud.notebooks.v1.UpdateInstanceConfigRequestOrBuilder
com.google.cloud.notebooks.v1.UpdateInstanceMetadataItemsRequestOrBuilder
com.google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponseOrBuilder
com.google.cloud.notebooks.v1.UpdateRuntimeRequestOrBuilder
com.google.cloud.notebooks.v1.UpdateShieldedInstanceConfigRequestOrBuilder
com.google.cloud.notebooks.v1.UpgradeInstanceInternalRequestOrBuilder
com.google.cloud.notebooks.v1.UpgradeInstanceRequestOrBuilder
com.google.cloud.notebooks.v1.UpgradeRuntimeRequestOrBuilder
com.google.cloud.notebooks.v1.VirtualMachineConfig.BootImageOrBuilder
com.google.cloud.notebooks.v1.VirtualMachineConfigOrBuilder
com.google.cloud.notebooks.v1.VirtualMachineOrBuilder
com.google.cloud.notebooks.v1.VmImageOrBuilder

Enums

Enum Description
com.google.cloud.notebooks.v1.Environment.ImageTypeCase
com.google.cloud.notebooks.v1.Event.EventType The definition of the event types.
com.google.cloud.notebooks.v1.Execution.State Enum description of the state of the underlying AIP job.
com.google.cloud.notebooks.v1.ExecutionTemplate.JobParametersCase
com.google.cloud.notebooks.v1.ExecutionTemplate.JobType The backend used for this execution.
com.google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier Required. Specifies the machine types, the number of replicas for workers and parameter servers.
com.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorType Hardware accelerator types for AI Platform Training jobs.
com.google.cloud.notebooks.v1.GetInstanceHealthResponse.HealthState If an instance is healthy or not.
com.google.cloud.notebooks.v1.Instance.AcceleratorType Definition of the types of hardware accelerators that can be used on this instance.
com.google.cloud.notebooks.v1.Instance.DiskEncryption Definition of the disk encryption options.
com.google.cloud.notebooks.v1.Instance.DiskType Possible disk types for notebook instances.
com.google.cloud.notebooks.v1.Instance.EnvironmentCase
com.google.cloud.notebooks.v1.Instance.NicType The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.
com.google.cloud.notebooks.v1.Instance.State The definition of the states of this instance.
com.google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry.Action The definition of operations of this upgrade history entry.
com.google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry.State The definition of the states of this upgrade history entry.
com.google.cloud.notebooks.v1.LocalDiskInitializeParams.DiskType Possible disk types.
com.google.cloud.notebooks.v1.ReservationAffinity.Type Indicates whether to consume capacity from an reservation or not.
com.google.cloud.notebooks.v1.Runtime.HealthState The runtime substate.
com.google.cloud.notebooks.v1.Runtime.RuntimeTypeCase
com.google.cloud.notebooks.v1.Runtime.State The definition of the states of this runtime.
com.google.cloud.notebooks.v1.RuntimeAcceleratorConfig.AcceleratorType Type of this accelerator.
com.google.cloud.notebooks.v1.RuntimeAccessConfig.RuntimeAccessType Possible ways to access runtime. Authentication mode. Currently supports: Single User only.
com.google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior Behavior for the post startup script.
com.google.cloud.notebooks.v1.Schedule.State State of the job.
com.google.cloud.notebooks.v1.UpgradeType Definition of the types of upgrade that can be used on this instance.
com.google.cloud.notebooks.v1.VirtualMachineConfig.NicType The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.
com.google.cloud.notebooks.v1.VmImage.ImageCase