Package com.google.cloud.notebooks.v1

A client to Notebooks API

The interfaces provided are listed below, along with usage samples.

ManagedNotebookServiceClient

Service Description: API v1 service for Managed Notebooks.

Sample for ManagedNotebookServiceClient:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   RuntimeName name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]");
   Runtime response = managedNotebookServiceClient.getRuntime(name);
 }
 

NotebookServiceClient

Service Description: API v1 service for Cloud AI Platform Notebooks.

Sample for NotebookServiceClient:


 try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   String name = "name3373707";
   Instance response = notebookServiceClient.getInstance(name);
 }
 

Classes

ContainerImage

Definition of a container image for starting a notebook instance with the environment installed in a container.

Protobuf type google.cloud.notebooks.v1.ContainerImage

ContainerImage.Builder

Definition of a container image for starting a notebook instance with the environment installed in a container.

Protobuf type google.cloud.notebooks.v1.ContainerImage

CreateEnvironmentRequest

Request for creating a notebook environment.

Protobuf type google.cloud.notebooks.v1.CreateEnvironmentRequest

CreateEnvironmentRequest.Builder

Request for creating a notebook environment.

Protobuf type google.cloud.notebooks.v1.CreateEnvironmentRequest

CreateExecutionRequest

Request to create notebook execution

Protobuf type google.cloud.notebooks.v1.CreateExecutionRequest

CreateExecutionRequest.Builder

Request to create notebook execution

Protobuf type google.cloud.notebooks.v1.CreateExecutionRequest

CreateInstanceRequest

Request for creating a notebook instance.

Protobuf type google.cloud.notebooks.v1.CreateInstanceRequest

CreateInstanceRequest.Builder

Request for creating a notebook instance.

Protobuf type google.cloud.notebooks.v1.CreateInstanceRequest

CreateRuntimeRequest

Request for creating a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.CreateRuntimeRequest

CreateRuntimeRequest.Builder

Request for creating a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.CreateRuntimeRequest

CreateScheduleRequest

Request for created scheduled notebooks

Protobuf type google.cloud.notebooks.v1.CreateScheduleRequest

CreateScheduleRequest.Builder

Request for created scheduled notebooks

Protobuf type google.cloud.notebooks.v1.CreateScheduleRequest

DeleteEnvironmentRequest

Request for deleting a notebook environment.

Protobuf type google.cloud.notebooks.v1.DeleteEnvironmentRequest

DeleteEnvironmentRequest.Builder

Request for deleting a notebook environment.

Protobuf type google.cloud.notebooks.v1.DeleteEnvironmentRequest

DeleteExecutionRequest

Request for deleting a scheduled notebook execution

Protobuf type google.cloud.notebooks.v1.DeleteExecutionRequest

DeleteExecutionRequest.Builder

Request for deleting a scheduled notebook execution

Protobuf type google.cloud.notebooks.v1.DeleteExecutionRequest

DeleteInstanceRequest

Request for deleting a notebook instance.

Protobuf type google.cloud.notebooks.v1.DeleteInstanceRequest

DeleteInstanceRequest.Builder

Request for deleting a notebook instance.

Protobuf type google.cloud.notebooks.v1.DeleteInstanceRequest

DeleteRuntimeRequest

Request for deleting a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.DeleteRuntimeRequest

DeleteRuntimeRequest.Builder

Request for deleting a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.DeleteRuntimeRequest

DeleteScheduleRequest

Request for deleting an Schedule

Protobuf type google.cloud.notebooks.v1.DeleteScheduleRequest

DeleteScheduleRequest.Builder

Request for deleting an Schedule

Protobuf type google.cloud.notebooks.v1.DeleteScheduleRequest

EncryptionConfig

Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.

Protobuf type google.cloud.notebooks.v1.EncryptionConfig

EncryptionConfig.Builder

Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.

Protobuf type google.cloud.notebooks.v1.EncryptionConfig

Environment

Definition of a software environment that is used to start a notebook instance.

Protobuf type google.cloud.notebooks.v1.Environment

Environment.Builder

Definition of a software environment that is used to start a notebook instance.

Protobuf type google.cloud.notebooks.v1.Environment

EnvironmentProto

Event

The definition of an Event for a managed / semi-managed notebook instance.

Protobuf type google.cloud.notebooks.v1.Event

Event.Builder

The definition of an Event for a managed / semi-managed notebook instance.

Protobuf type google.cloud.notebooks.v1.Event

EventProto

Execution

The definition of a single executed notebook.

Protobuf type google.cloud.notebooks.v1.Execution

Execution.Builder

The definition of a single executed notebook.

Protobuf type google.cloud.notebooks.v1.Execution

ExecutionName

ExecutionName.Builder

Builder for projects/{project}/location/{location}/executions/{execution}.

ExecutionProto

ExecutionTemplate

The description a notebook execution workload.

Protobuf type google.cloud.notebooks.v1.ExecutionTemplate

ExecutionTemplate.Builder

The description a notebook execution workload.

Protobuf type google.cloud.notebooks.v1.ExecutionTemplate

ExecutionTemplate.DataprocParameters

Parameters used in Dataproc JobType executions.

Protobuf type google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters

ExecutionTemplate.DataprocParameters.Builder

Parameters used in Dataproc JobType executions.

Protobuf type google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters

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 combination. TPUs are not supported.

Protobuf type google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig

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 combination. TPUs are not supported.

Protobuf type google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig

GetEnvironmentRequest

Request for getting a notebook environment.

Protobuf type google.cloud.notebooks.v1.GetEnvironmentRequest

GetEnvironmentRequest.Builder

Request for getting a notebook environment.

Protobuf type google.cloud.notebooks.v1.GetEnvironmentRequest

GetExecutionRequest

Request for getting scheduled notebook execution

Protobuf type google.cloud.notebooks.v1.GetExecutionRequest

GetExecutionRequest.Builder

Request for getting scheduled notebook execution

Protobuf type google.cloud.notebooks.v1.GetExecutionRequest

GetInstanceHealthRequest

Request for checking if a notebook instance is healthy.

Protobuf type google.cloud.notebooks.v1.GetInstanceHealthRequest

GetInstanceHealthRequest.Builder

Request for checking if a notebook instance is healthy.

Protobuf type google.cloud.notebooks.v1.GetInstanceHealthRequest

GetInstanceHealthResponse

Response for checking if a notebook instance is healthy.

Protobuf type google.cloud.notebooks.v1.GetInstanceHealthResponse

GetInstanceHealthResponse.Builder

Response for checking if a notebook instance is healthy.

Protobuf type google.cloud.notebooks.v1.GetInstanceHealthResponse

GetInstanceRequest

Request for getting a notebook instance.

Protobuf type google.cloud.notebooks.v1.GetInstanceRequest

GetInstanceRequest.Builder

Request for getting a notebook instance.

Protobuf type google.cloud.notebooks.v1.GetInstanceRequest

GetRuntimeRequest

Request for getting a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.GetRuntimeRequest

GetRuntimeRequest.Builder

Request for getting a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.GetRuntimeRequest

GetScheduleRequest

Request for getting scheduled notebook.

Protobuf type google.cloud.notebooks.v1.GetScheduleRequest

GetScheduleRequest.Builder

Request for getting scheduled notebook.

Protobuf type google.cloud.notebooks.v1.GetScheduleRequest

Instance

The definition of a notebook instance.

Protobuf type google.cloud.notebooks.v1.Instance

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 valid combination. TPUs are not supported.

Protobuf type google.cloud.notebooks.v1.Instance.AcceleratorConfig

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 valid combination. TPUs are not supported.

Protobuf type google.cloud.notebooks.v1.Instance.AcceleratorConfig

Instance.Builder

The definition of a notebook instance.

Protobuf type google.cloud.notebooks.v1.Instance

Instance.Disk

An instance-attached disk resource.

Protobuf type google.cloud.notebooks.v1.Instance.Disk

Instance.Disk.Builder

An instance-attached disk resource.

Protobuf type google.cloud.notebooks.v1.Instance.Disk

Instance.Disk.GuestOsFeature

Guest OS features for boot disk.

Protobuf type google.cloud.notebooks.v1.Instance.Disk.GuestOsFeature

Instance.Disk.GuestOsFeature.Builder

Guest OS features for boot disk.

Protobuf type google.cloud.notebooks.v1.Instance.Disk.GuestOsFeature

Instance.ShieldedInstanceConfig

A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid.

Protobuf type google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig

Instance.ShieldedInstanceConfig.Builder

A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid.

Protobuf type google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig

Instance.UpgradeHistoryEntry

The entry of VM image upgrade history.

Protobuf type google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry

Instance.UpgradeHistoryEntry.Builder

The entry of VM image upgrade history.

Protobuf type google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry

InstanceConfig

Notebook instance configurations that can be updated.

Protobuf type google.cloud.notebooks.v1.InstanceConfig

InstanceConfig.Builder

Notebook instance configurations that can be updated.

Protobuf type google.cloud.notebooks.v1.InstanceConfig

InstanceConfigProto

InstanceName

InstanceName.Builder

Builder for projects/{project}/instances/{instance}.

InstanceProto

IsInstanceUpgradeableRequest

Request for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1.IsInstanceUpgradeableRequest

IsInstanceUpgradeableRequest.Builder

Request for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1.IsInstanceUpgradeableRequest

IsInstanceUpgradeableResponse

Response for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1.IsInstanceUpgradeableResponse

IsInstanceUpgradeableResponse.Builder

Response for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1.IsInstanceUpgradeableResponse

ListEnvironmentsRequest

Request for listing environments.

Protobuf type google.cloud.notebooks.v1.ListEnvironmentsRequest

ListEnvironmentsRequest.Builder

Request for listing environments.

Protobuf type google.cloud.notebooks.v1.ListEnvironmentsRequest

ListEnvironmentsResponse

Response for listing environments.

Protobuf type google.cloud.notebooks.v1.ListEnvironmentsResponse

ListEnvironmentsResponse.Builder

Response for listing environments.

Protobuf type google.cloud.notebooks.v1.ListEnvironmentsResponse

ListExecutionsRequest

Request for listing scheduled notebook executions.

Protobuf type google.cloud.notebooks.v1.ListExecutionsRequest

ListExecutionsRequest.Builder

Request for listing scheduled notebook executions.

Protobuf type google.cloud.notebooks.v1.ListExecutionsRequest

ListExecutionsResponse

Response for listing scheduled notebook executions

Protobuf type google.cloud.notebooks.v1.ListExecutionsResponse

ListExecutionsResponse.Builder

Response for listing scheduled notebook executions

Protobuf type google.cloud.notebooks.v1.ListExecutionsResponse

ListInstancesRequest

Request for listing notebook instances.

Protobuf type google.cloud.notebooks.v1.ListInstancesRequest

ListInstancesRequest.Builder

Request for listing notebook instances.

Protobuf type google.cloud.notebooks.v1.ListInstancesRequest

ListInstancesResponse

Response for listing notebook instances.

Protobuf type google.cloud.notebooks.v1.ListInstancesResponse

ListInstancesResponse.Builder

Response for listing notebook instances.

Protobuf type google.cloud.notebooks.v1.ListInstancesResponse

ListRuntimesRequest

Request for listing Managed Notebook Runtimes.

Protobuf type google.cloud.notebooks.v1.ListRuntimesRequest

ListRuntimesRequest.Builder

Request for listing Managed Notebook Runtimes.

Protobuf type google.cloud.notebooks.v1.ListRuntimesRequest

ListRuntimesResponse

Response for listing Managed Notebook Runtimes.

Protobuf type google.cloud.notebooks.v1.ListRuntimesResponse

ListRuntimesResponse.Builder

Response for listing Managed Notebook Runtimes.

Protobuf type google.cloud.notebooks.v1.ListRuntimesResponse

ListSchedulesRequest

Request for listing scheduled notebook job.

Protobuf type google.cloud.notebooks.v1.ListSchedulesRequest

ListSchedulesRequest.Builder

Request for listing scheduled notebook job.

Protobuf type google.cloud.notebooks.v1.ListSchedulesRequest

ListSchedulesResponse

Response for listing scheduled notebook job.

Protobuf type google.cloud.notebooks.v1.ListSchedulesResponse

ListSchedulesResponse.Builder

Response for listing scheduled notebook job.

Protobuf type google.cloud.notebooks.v1.ListSchedulesResponse

LocalDisk

A Local attached disk resource.

Protobuf type google.cloud.notebooks.v1.LocalDisk

LocalDisk.Builder

A Local attached disk resource.

Protobuf type google.cloud.notebooks.v1.LocalDisk

LocalDisk.RuntimeGuestOsFeature

Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features for boot disk.

Protobuf type google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature

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 features to see a list of available options. Guest OS features for boot disk.

Protobuf type google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature

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. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Protobuf type google.cloud.notebooks.v1.LocalDiskInitializeParams

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. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Protobuf type google.cloud.notebooks.v1.LocalDiskInitializeParams

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

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:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   RuntimeName name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]");
   Runtime response = managedNotebookServiceClient.getRuntime(name);
 }
 

Note: close() needs to be called on the ManagedNotebookServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ManagedNotebookServiceSettings to create(). For example:

To customize credentials:


 ManagedNotebookServiceSettings managedNotebookServiceSettings =
     ManagedNotebookServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create(managedNotebookServiceSettings);
 

To customize the endpoint:


 ManagedNotebookServiceSettings managedNotebookServiceSettings =
     ManagedNotebookServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create(managedNotebookServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

ManagedNotebookServiceClient.ListRuntimesFixedSizeCollection

ManagedNotebookServiceClient.ListRuntimesPage

ManagedNotebookServiceClient.ListRuntimesPagedResponse

ManagedNotebookServiceGrpc

API v1 service for Managed Notebooks.

ManagedNotebookServiceGrpc.ManagedNotebookServiceBlockingStub

API v1 service for Managed Notebooks.

ManagedNotebookServiceGrpc.ManagedNotebookServiceFutureStub

API v1 service for Managed Notebooks.

ManagedNotebookServiceGrpc.ManagedNotebookServiceImplBase

API v1 service for Managed Notebooks.

ManagedNotebookServiceGrpc.ManagedNotebookServiceStub

API v1 service for Managed Notebooks.

ManagedNotebookServiceSettings

Settings class to configure an instance of ManagedNotebookServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (notebooks.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getRuntime to 30 seconds:


 ManagedNotebookServiceSettings.Builder managedNotebookServiceSettingsBuilder =
     ManagedNotebookServiceSettings.newBuilder();
 managedNotebookServiceSettingsBuilder
     .getRuntimeSettings()
     .setRetrySettings(
         managedNotebookServiceSettingsBuilder
             .getRuntimeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ManagedNotebookServiceSettings managedNotebookServiceSettings =
     managedNotebookServiceSettingsBuilder.build();
 

ManagedNotebookServiceSettings.Builder

Builder for ManagedNotebookServiceSettings.

ManagedNotebooksProto

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:


 try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   String name = "name3373707";
   Instance response = notebookServiceClient.getInstance(name);
 }
 

Note: close() needs to be called on the NotebookServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of NotebookServiceSettings to create(). For example:

To customize credentials:


 NotebookServiceSettings notebookServiceSettings =
     NotebookServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NotebookServiceClient notebookServiceClient =
     NotebookServiceClient.create(notebookServiceSettings);
 

To customize the endpoint:


 NotebookServiceSettings notebookServiceSettings =
     NotebookServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 NotebookServiceClient notebookServiceClient =
     NotebookServiceClient.create(notebookServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

NotebookServiceClient.ListEnvironmentsFixedSizeCollection

NotebookServiceClient.ListEnvironmentsPage

NotebookServiceClient.ListEnvironmentsPagedResponse

NotebookServiceClient.ListExecutionsFixedSizeCollection

NotebookServiceClient.ListExecutionsPage

NotebookServiceClient.ListExecutionsPagedResponse

NotebookServiceClient.ListInstancesFixedSizeCollection

NotebookServiceClient.ListInstancesPage

NotebookServiceClient.ListInstancesPagedResponse

NotebookServiceClient.ListSchedulesFixedSizeCollection

NotebookServiceClient.ListSchedulesPage

NotebookServiceClient.ListSchedulesPagedResponse

NotebookServiceGrpc

API v1 service for Cloud AI Platform Notebooks.

NotebookServiceGrpc.NotebookServiceBlockingStub

API v1 service for Cloud AI Platform Notebooks.

NotebookServiceGrpc.NotebookServiceFutureStub

API v1 service for Cloud AI Platform Notebooks.

NotebookServiceGrpc.NotebookServiceImplBase

API v1 service for Cloud AI Platform Notebooks.

NotebookServiceGrpc.NotebookServiceStub

API v1 service for Cloud AI Platform Notebooks.

NotebookServiceSettings

Settings class to configure an instance of NotebookServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (notebooks.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getInstance to 30 seconds:


 NotebookServiceSettings.Builder notebookServiceSettingsBuilder =
     NotebookServiceSettings.newBuilder();
 notebookServiceSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         notebookServiceSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 NotebookServiceSettings notebookServiceSettings = notebookServiceSettingsBuilder.build();
 

NotebookServiceSettings.Builder

Builder for NotebookServiceSettings.

NotebooksProto

OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.notebooks.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.notebooks.v1.OperationMetadata

RegisterInstanceRequest

Request for registering a notebook instance.

Protobuf type google.cloud.notebooks.v1.RegisterInstanceRequest

RegisterInstanceRequest.Builder

Request for registering a notebook instance.

Protobuf type google.cloud.notebooks.v1.RegisterInstanceRequest

ReportInstanceInfoRequest

Request for notebook instances to report information to Notebooks API.

Protobuf type google.cloud.notebooks.v1.ReportInstanceInfoRequest

ReportInstanceInfoRequest.Builder

Request for notebook instances to report information to Notebooks API.

Protobuf type google.cloud.notebooks.v1.ReportInstanceInfoRequest

ReportRuntimeEventRequest

Request for reporting a Managed Notebook Event.

Protobuf type google.cloud.notebooks.v1.ReportRuntimeEventRequest

ReportRuntimeEventRequest.Builder

Request for reporting a Managed Notebook Event.

Protobuf type google.cloud.notebooks.v1.ReportRuntimeEventRequest

ReservationAffinity

Reservation Affinity for consuming Zonal reservation.

Protobuf type google.cloud.notebooks.v1.ReservationAffinity

ReservationAffinity.Builder

Reservation Affinity for consuming Zonal reservation.

Protobuf type google.cloud.notebooks.v1.ReservationAffinity

ResetInstanceRequest

Request for reseting a notebook instance

Protobuf type google.cloud.notebooks.v1.ResetInstanceRequest

ResetInstanceRequest.Builder

Request for reseting a notebook instance

Protobuf type google.cloud.notebooks.v1.ResetInstanceRequest

ResetRuntimeRequest

Request for reseting a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.ResetRuntimeRequest

ResetRuntimeRequest.Builder

Request for reseting a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.ResetRuntimeRequest

RollbackInstanceRequest

Request for rollbacking a notebook instance

Protobuf type google.cloud.notebooks.v1.RollbackInstanceRequest

RollbackInstanceRequest.Builder

Request for rollbacking a notebook instance

Protobuf type google.cloud.notebooks.v1.RollbackInstanceRequest

Runtime

The definition of a Runtime for a managed notebook instance.

Protobuf type google.cloud.notebooks.v1.Runtime

Runtime.Builder

The definition of a Runtime for a managed notebook instance.

Protobuf type google.cloud.notebooks.v1.Runtime

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 AcceleratorTypes. Examples:

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-t4
  • nvidia-tesla-a100

Protobuf type google.cloud.notebooks.v1.RuntimeAcceleratorConfig

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 AcceleratorTypes. Examples:

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-t4
  • nvidia-tesla-a100

Protobuf type google.cloud.notebooks.v1.RuntimeAcceleratorConfig

RuntimeAccessConfig

Specifies the login configuration for Runtime

Protobuf type google.cloud.notebooks.v1.RuntimeAccessConfig

RuntimeAccessConfig.Builder

Specifies the login configuration for Runtime

Protobuf type google.cloud.notebooks.v1.RuntimeAccessConfig

RuntimeMetrics

Contains runtime daemon metrics, such as OS and kernels and sessions stats.

Protobuf type google.cloud.notebooks.v1.RuntimeMetrics

RuntimeMetrics.Builder

Contains runtime daemon metrics, such as OS and kernels and sessions stats.

Protobuf type google.cloud.notebooks.v1.RuntimeMetrics

RuntimeName

RuntimeName.Builder

Builder for projects/{project}/locations/{location}/runtimes/{runtime}.

RuntimeProto

RuntimeShieldedInstanceConfig

A set of Shielded Instance options. Check Images using supported Shielded VM features. Not all combinations are valid.

Protobuf type google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig

RuntimeShieldedInstanceConfig.Builder

A set of Shielded Instance options. Check Images using supported Shielded VM features. Not all combinations are valid.

Protobuf type google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig

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:

  • idle_shutdown: true
  • idle_shutdown_timeout: 180
  • report-system-health: true

Protobuf type google.cloud.notebooks.v1.RuntimeSoftwareConfig

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:

  • idle_shutdown: true
  • idle_shutdown_timeout: 180
  • report-system-health: true

Protobuf type google.cloud.notebooks.v1.RuntimeSoftwareConfig

Schedule

The definition of a schedule.

Protobuf type google.cloud.notebooks.v1.Schedule

Schedule.Builder

The definition of a schedule.

Protobuf type google.cloud.notebooks.v1.Schedule

ScheduleName

ScheduleName.Builder

Builder for projects/{project}/location/{location}/schedules/{schedule}.

ScheduleProto

SetInstanceAcceleratorRequest

Request for setting instance accelerator.

Protobuf type google.cloud.notebooks.v1.SetInstanceAcceleratorRequest

SetInstanceAcceleratorRequest.Builder

Request for setting instance accelerator.

Protobuf type google.cloud.notebooks.v1.SetInstanceAcceleratorRequest

SetInstanceLabelsRequest

Request for setting instance labels.

Protobuf type google.cloud.notebooks.v1.SetInstanceLabelsRequest

SetInstanceLabelsRequest.Builder

Request for setting instance labels.

Protobuf type google.cloud.notebooks.v1.SetInstanceLabelsRequest

SetInstanceMachineTypeRequest

Request for setting instance machine type.

Protobuf type google.cloud.notebooks.v1.SetInstanceMachineTypeRequest

SetInstanceMachineTypeRequest.Builder

Request for setting instance machine type.

Protobuf type google.cloud.notebooks.v1.SetInstanceMachineTypeRequest

StartInstanceRequest

Request for starting a notebook instance

Protobuf type google.cloud.notebooks.v1.StartInstanceRequest

StartInstanceRequest.Builder

Request for starting a notebook instance

Protobuf type google.cloud.notebooks.v1.StartInstanceRequest

StartRuntimeRequest

Request for starting a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.StartRuntimeRequest

StartRuntimeRequest.Builder

Request for starting a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.StartRuntimeRequest

StopInstanceRequest

Request for stopping a notebook instance

Protobuf type google.cloud.notebooks.v1.StopInstanceRequest

StopInstanceRequest.Builder

Request for stopping a notebook instance

Protobuf type google.cloud.notebooks.v1.StopInstanceRequest

StopRuntimeRequest

Request for stopping a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.StopRuntimeRequest

StopRuntimeRequest.Builder

Request for stopping a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.StopRuntimeRequest

SwitchRuntimeRequest

Request for switching a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.SwitchRuntimeRequest

SwitchRuntimeRequest.Builder

Request for switching a Managed Notebook Runtime.

Protobuf type google.cloud.notebooks.v1.SwitchRuntimeRequest

TriggerScheduleRequest

Request for created scheduled notebooks

Protobuf type google.cloud.notebooks.v1.TriggerScheduleRequest

TriggerScheduleRequest.Builder

Request for created scheduled notebooks

Protobuf type google.cloud.notebooks.v1.TriggerScheduleRequest

UpdateInstanceConfigRequest

Request for updating instance configurations.

Protobuf type google.cloud.notebooks.v1.UpdateInstanceConfigRequest

UpdateInstanceConfigRequest.Builder

Request for updating instance configurations.

Protobuf type google.cloud.notebooks.v1.UpdateInstanceConfigRequest

UpdateShieldedInstanceConfigRequest

Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance

Protobuf type google.cloud.notebooks.v1.UpdateShieldedInstanceConfigRequest

UpdateShieldedInstanceConfigRequest.Builder

Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance

Protobuf type google.cloud.notebooks.v1.UpdateShieldedInstanceConfigRequest

UpgradeInstanceInternalRequest

Request for upgrading a notebook instance from within the VM

Protobuf type google.cloud.notebooks.v1.UpgradeInstanceInternalRequest

UpgradeInstanceInternalRequest.Builder

Request for upgrading a notebook instance from within the VM

Protobuf type google.cloud.notebooks.v1.UpgradeInstanceInternalRequest

UpgradeInstanceRequest

Request for upgrading a notebook instance

Protobuf type google.cloud.notebooks.v1.UpgradeInstanceRequest

UpgradeInstanceRequest.Builder

Request for upgrading a notebook instance

Protobuf type google.cloud.notebooks.v1.UpgradeInstanceRequest

VirtualMachine

Runtime using Virtual Machine for computing.

Protobuf type google.cloud.notebooks.v1.VirtualMachine

VirtualMachine.Builder

Runtime using Virtual Machine for computing.

Protobuf type google.cloud.notebooks.v1.VirtualMachine

VirtualMachineConfig

The config settings for virtual machine.

Protobuf type google.cloud.notebooks.v1.VirtualMachineConfig

VirtualMachineConfig.Builder

The config settings for virtual machine.

Protobuf type google.cloud.notebooks.v1.VirtualMachineConfig

VmImage

Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.

Protobuf type google.cloud.notebooks.v1.VmImage

VmImage.Builder

Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.

Protobuf type google.cloud.notebooks.v1.VmImage

Interfaces

ContainerImageOrBuilder

CreateEnvironmentRequestOrBuilder

CreateExecutionRequestOrBuilder

CreateInstanceRequestOrBuilder

CreateRuntimeRequestOrBuilder

CreateScheduleRequestOrBuilder

DeleteEnvironmentRequestOrBuilder

DeleteExecutionRequestOrBuilder

DeleteInstanceRequestOrBuilder

DeleteRuntimeRequestOrBuilder

DeleteScheduleRequestOrBuilder

EncryptionConfigOrBuilder

EnvironmentOrBuilder

EventOrBuilder

ExecutionOrBuilder

ExecutionTemplate.DataprocParametersOrBuilder

ExecutionTemplate.SchedulerAcceleratorConfigOrBuilder

ExecutionTemplateOrBuilder

GetEnvironmentRequestOrBuilder

GetExecutionRequestOrBuilder

GetInstanceHealthRequestOrBuilder

GetInstanceHealthResponseOrBuilder

GetInstanceRequestOrBuilder

GetRuntimeRequestOrBuilder

GetScheduleRequestOrBuilder

Instance.AcceleratorConfigOrBuilder

Instance.Disk.GuestOsFeatureOrBuilder

Instance.DiskOrBuilder

Instance.ShieldedInstanceConfigOrBuilder

Instance.UpgradeHistoryEntryOrBuilder

InstanceConfigOrBuilder

InstanceOrBuilder

IsInstanceUpgradeableRequestOrBuilder

IsInstanceUpgradeableResponseOrBuilder

ListEnvironmentsRequestOrBuilder

ListEnvironmentsResponseOrBuilder

ListExecutionsRequestOrBuilder

ListExecutionsResponseOrBuilder

ListInstancesRequestOrBuilder

ListInstancesResponseOrBuilder

ListRuntimesRequestOrBuilder

ListRuntimesResponseOrBuilder

ListSchedulesRequestOrBuilder

ListSchedulesResponseOrBuilder

LocalDisk.RuntimeGuestOsFeatureOrBuilder

LocalDiskInitializeParamsOrBuilder

LocalDiskOrBuilder

OperationMetadataOrBuilder

RegisterInstanceRequestOrBuilder

ReportInstanceInfoRequestOrBuilder

ReportRuntimeEventRequestOrBuilder

ReservationAffinityOrBuilder

ResetInstanceRequestOrBuilder

ResetRuntimeRequestOrBuilder

RollbackInstanceRequestOrBuilder

RuntimeAcceleratorConfigOrBuilder

RuntimeAccessConfigOrBuilder

RuntimeMetricsOrBuilder

RuntimeOrBuilder

RuntimeShieldedInstanceConfigOrBuilder

RuntimeSoftwareConfigOrBuilder

ScheduleOrBuilder

SetInstanceAcceleratorRequestOrBuilder

SetInstanceLabelsRequestOrBuilder

SetInstanceMachineTypeRequestOrBuilder

StartInstanceRequestOrBuilder

StartRuntimeRequestOrBuilder

StopInstanceRequestOrBuilder

StopRuntimeRequestOrBuilder

SwitchRuntimeRequestOrBuilder

TriggerScheduleRequestOrBuilder

UpdateInstanceConfigRequestOrBuilder

UpdateShieldedInstanceConfigRequestOrBuilder

UpgradeInstanceInternalRequestOrBuilder

UpgradeInstanceRequestOrBuilder

VirtualMachineConfigOrBuilder

VirtualMachineOrBuilder

VmImageOrBuilder

Enums

Environment.ImageTypeCase

Event.EventType

The definition of the even types.

Protobuf enum google.cloud.notebooks.v1.Event.EventType

Execution.State

Enum description of the state of the underlying AIP job.

Protobuf enum google.cloud.notebooks.v1.Execution.State

ExecutionTemplate.JobParametersCase

ExecutionTemplate.JobType

The backend used for this execution.

Protobuf enum google.cloud.notebooks.v1.ExecutionTemplate.JobType

ExecutionTemplate.ScaleTier

Required. Specifies the machine types, the number of replicas for workers and parameter servers.

Protobuf enum google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier

ExecutionTemplate.SchedulerAcceleratorType

Hardware accelerator types for AI Platform Training jobs.

Protobuf enum google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorType

GetInstanceHealthResponse.HealthState

If an instance is healthy or not.

Protobuf enum google.cloud.notebooks.v1.GetInstanceHealthResponse.HealthState

Instance.AcceleratorType

Definition of the types of hardware accelerators that can be used on this instance.

Protobuf enum google.cloud.notebooks.v1.Instance.AcceleratorType

Instance.DiskEncryption

Definition of the disk encryption options.

Protobuf enum google.cloud.notebooks.v1.Instance.DiskEncryption

Instance.DiskType

Possible disk types for notebook instances.

Protobuf enum google.cloud.notebooks.v1.Instance.DiskType

Instance.EnvironmentCase

Instance.NicType

The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.

Protobuf enum google.cloud.notebooks.v1.Instance.NicType

Instance.State

The definition of the states of this instance.

Protobuf enum google.cloud.notebooks.v1.Instance.State

Instance.UpgradeHistoryEntry.Action

The definition of operations of this upgrade history entry.

Protobuf enum google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry.Action

Instance.UpgradeHistoryEntry.State

The definition of the states of this upgrade history entry.

Protobuf enum google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry.State

LocalDiskInitializeParams.DiskType

Possible disk types.

Protobuf enum google.cloud.notebooks.v1.LocalDiskInitializeParams.DiskType

ReservationAffinity.Type

Indicates whether to consume capacity from an reservation or not.

Protobuf enum google.cloud.notebooks.v1.ReservationAffinity.Type

Runtime.HealthState

The runtime substate.

Protobuf enum google.cloud.notebooks.v1.Runtime.HealthState

Runtime.RuntimeTypeCase

Runtime.State

The definition of the states of this runtime.

Protobuf enum google.cloud.notebooks.v1.Runtime.State

RuntimeAcceleratorConfig.AcceleratorType

Type of this accelerator.

Protobuf enum google.cloud.notebooks.v1.RuntimeAcceleratorConfig.AcceleratorType

RuntimeAccessConfig.RuntimeAccessType

Possible ways to access runtime. Authentication mode. Currently supports: Single User only.

Protobuf enum google.cloud.notebooks.v1.RuntimeAccessConfig.RuntimeAccessType

Schedule.State

State of the job.

Protobuf enum google.cloud.notebooks.v1.Schedule.State

VirtualMachineConfig.NicType

The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.

Protobuf enum google.cloud.notebooks.v1.VirtualMachineConfig.NicType

VmImage.ImageCase