A client to Notebooks API
The interfaces provided are listed below, along with usage samples.
NotebookServiceClient
Service Description: API v2 service for Workbench Notebooks Instances.
Sample for NotebookServiceClient:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = notebookServiceClient.getInstance(name);
}
Classes
AcceleratorConfig
An accelerator configuration for a VM instance
Definition of a hardware accelerator. Note that there is no check on type
and core_count combinations. TPUs are not supported.
See GPUs on Compute
Engine to find a
valid combination.
Protobuf type google.cloud.notebooks.v2.AcceleratorConfig
AcceleratorConfig.Builder
An accelerator configuration for a VM instance
Definition of a hardware accelerator. Note that there is no check on type
and core_count combinations. TPUs are not supported.
See GPUs on Compute
Engine to find a
valid combination.
Protobuf type google.cloud.notebooks.v2.AcceleratorConfig
BootDisk
The definition of a boot disk.
Protobuf type google.cloud.notebooks.v2.BootDisk
BootDisk.Builder
The definition of a boot disk.
Protobuf type google.cloud.notebooks.v2.BootDisk
CheckInstanceUpgradabilityRequest
Request for checking if a notebook instance is upgradeable.
Protobuf type google.cloud.notebooks.v2.CheckInstanceUpgradabilityRequest
CheckInstanceUpgradabilityRequest.Builder
Request for checking if a notebook instance is upgradeable.
Protobuf type google.cloud.notebooks.v2.CheckInstanceUpgradabilityRequest
CheckInstanceUpgradabilityResponse
Response for checking if a notebook instance is upgradeable.
Protobuf type google.cloud.notebooks.v2.CheckInstanceUpgradabilityResponse
CheckInstanceUpgradabilityResponse.Builder
Response for checking if a notebook instance is upgradeable.
Protobuf type google.cloud.notebooks.v2.CheckInstanceUpgradabilityResponse
ContainerImage
Definition of a container image for starting a notebook instance with the environment installed in a container.
Protobuf type google.cloud.notebooks.v2.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.v2.ContainerImage
CreateInstanceRequest
Request for creating a notebook instance.
Protobuf type google.cloud.notebooks.v2.CreateInstanceRequest
CreateInstanceRequest.Builder
Request for creating a notebook instance.
Protobuf type google.cloud.notebooks.v2.CreateInstanceRequest
DataDisk
An instance-attached disk resource.
Protobuf type google.cloud.notebooks.v2.DataDisk
DataDisk.Builder
An instance-attached disk resource.
Protobuf type google.cloud.notebooks.v2.DataDisk
DeleteInstanceRequest
Request for deleting a notebook instance.
Protobuf type google.cloud.notebooks.v2.DeleteInstanceRequest
DeleteInstanceRequest.Builder
Request for deleting a notebook instance.
Protobuf type google.cloud.notebooks.v2.DeleteInstanceRequest
DiagnoseInstanceRequest
Request for creating a notebook instance diagnostic file.
Protobuf type google.cloud.notebooks.v2.DiagnoseInstanceRequest
DiagnoseInstanceRequest.Builder
Request for creating a notebook instance diagnostic file.
Protobuf type google.cloud.notebooks.v2.DiagnoseInstanceRequest
DiagnosticConfig
Defines flags that are used to run the diagnostic tool
Protobuf type google.cloud.notebooks.v2.DiagnosticConfig
DiagnosticConfig.Builder
Defines flags that are used to run the diagnostic tool
Protobuf type google.cloud.notebooks.v2.DiagnosticConfig
DiagnosticConfigProto
Event
The definition of an Event for a managed / semi-managed notebook instance.
Protobuf type google.cloud.notebooks.v2.Event
Event.Builder
The definition of an Event for a managed / semi-managed notebook instance.
Protobuf type google.cloud.notebooks.v2.Event
EventProto
GPUDriverConfig
A GPU driver configuration
Protobuf type google.cloud.notebooks.v2.GPUDriverConfig
GPUDriverConfig.Builder
A GPU driver configuration
Protobuf type google.cloud.notebooks.v2.GPUDriverConfig
GceSetup
The definition of how to configure a VM instance outside of Resources and Identity.
Protobuf type google.cloud.notebooks.v2.GceSetup
GceSetup.Builder
The definition of how to configure a VM instance outside of Resources and Identity.
Protobuf type google.cloud.notebooks.v2.GceSetup
GceSetupProto
GetInstanceRequest
Request for getting a notebook instance.
Protobuf type google.cloud.notebooks.v2.GetInstanceRequest
GetInstanceRequest.Builder
Request for getting a notebook instance.
Protobuf type google.cloud.notebooks.v2.GetInstanceRequest
Instance
The definition of a notebook instance.
Protobuf type google.cloud.notebooks.v2.Instance
Instance.Builder
The definition of a notebook instance.
Protobuf type google.cloud.notebooks.v2.Instance
InstanceName
InstanceName.Builder
Builder for projects/{project}/locations/{location}/instances/{instance}.
InstanceProto
ListInstancesRequest
Request for listing notebook instances.
Protobuf type google.cloud.notebooks.v2.ListInstancesRequest
ListInstancesRequest.Builder
Request for listing notebook instances.
Protobuf type google.cloud.notebooks.v2.ListInstancesRequest
ListInstancesResponse
Response for listing notebook instances.
Protobuf type google.cloud.notebooks.v2.ListInstancesResponse
ListInstancesResponse.Builder
Response for listing notebook instances.
Protobuf type google.cloud.notebooks.v2.ListInstancesResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
NetworkInterface
The definition of a network interface resource attached to a VM.
Protobuf type google.cloud.notebooks.v2.NetworkInterface
NetworkInterface.Builder
The definition of a network interface resource attached to a VM.
Protobuf type google.cloud.notebooks.v2.NetworkInterface
NotebookServiceClient
Service Description: API v2 service for Workbench Notebooks Instances.
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:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
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:
- 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.
- 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.
- 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:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
NotebookServiceSettings notebookServiceSettings =
NotebookServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
NotebookServiceClient notebookServiceClient =
NotebookServiceClient.create(notebookServiceSettings);
To customize the endpoint:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
NotebookServiceSettings notebookServiceSettings =
NotebookServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
NotebookServiceClient notebookServiceClient =
NotebookServiceClient.create(notebookServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
NotebookServiceSettings notebookServiceSettings =
NotebookServiceSettings.newHttpJsonBuilder().build();
NotebookServiceClient notebookServiceClient =
NotebookServiceClient.create(notebookServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
NotebookServiceClient.ListInstancesFixedSizeCollection
NotebookServiceClient.ListInstancesPage
NotebookServiceClient.ListInstancesPagedResponse
NotebookServiceClient.ListLocationsFixedSizeCollection
NotebookServiceClient.ListLocationsPage
NotebookServiceClient.ListLocationsPagedResponse
NotebookServiceGrpc
API v2 service for Workbench Notebooks Instances.
NotebookServiceGrpc.NotebookServiceBlockingStub
A stub to allow clients to do synchronous rpc calls to service NotebookService.
API v2 service for Workbench Notebooks Instances.
NotebookServiceGrpc.NotebookServiceFutureStub
A stub to allow clients to do ListenableFuture-style rpc calls to service NotebookService.
API v2 service for Workbench Notebooks Instances.
NotebookServiceGrpc.NotebookServiceImplBase
Base class for the server implementation of the service NotebookService.
API v2 service for Workbench Notebooks Instances.
NotebookServiceGrpc.NotebookServiceStub
A stub to allow clients to do asynchronous rpc calls to service NotebookService.
API v2 service for Workbench Notebooks Instances.
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:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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.
OperationMetadata
Represents the metadata of the long-running operation.
Protobuf type google.cloud.notebooks.v2.OperationMetadata
OperationMetadata.Builder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.notebooks.v2.OperationMetadata
ResetInstanceRequest
Request for resetting a notebook instance
Protobuf type google.cloud.notebooks.v2.ResetInstanceRequest
ResetInstanceRequest.Builder
Request for resetting a notebook instance
Protobuf type google.cloud.notebooks.v2.ResetInstanceRequest
RollbackInstanceRequest
Request for rollbacking a notebook instance
Protobuf type google.cloud.notebooks.v2.RollbackInstanceRequest
RollbackInstanceRequest.Builder
Request for rollbacking a notebook instance
Protobuf type google.cloud.notebooks.v2.RollbackInstanceRequest
ServiceAccount
A service account that acts as an identity.
Protobuf type google.cloud.notebooks.v2.ServiceAccount
ServiceAccount.Builder
A service account that acts as an identity.
Protobuf type google.cloud.notebooks.v2.ServiceAccount
ServiceProto
ShieldedInstanceConfig
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
Protobuf type google.cloud.notebooks.v2.ShieldedInstanceConfig
ShieldedInstanceConfig.Builder
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
Protobuf type google.cloud.notebooks.v2.ShieldedInstanceConfig
StartInstanceRequest
Request for starting a notebook instance
Protobuf type google.cloud.notebooks.v2.StartInstanceRequest
StartInstanceRequest.Builder
Request for starting a notebook instance
Protobuf type google.cloud.notebooks.v2.StartInstanceRequest
StopInstanceRequest
Request for stopping a notebook instance
Protobuf type google.cloud.notebooks.v2.StopInstanceRequest
StopInstanceRequest.Builder
Request for stopping a notebook instance
Protobuf type google.cloud.notebooks.v2.StopInstanceRequest
UpdateInstanceRequest
Request for updating a notebook instance.
Protobuf type google.cloud.notebooks.v2.UpdateInstanceRequest
UpdateInstanceRequest.Builder
Request for updating a notebook instance.
Protobuf type google.cloud.notebooks.v2.UpdateInstanceRequest
UpgradeHistoryEntry
The entry of VM image upgrade history.
Protobuf type google.cloud.notebooks.v2.UpgradeHistoryEntry
UpgradeHistoryEntry.Builder
The entry of VM image upgrade history.
Protobuf type google.cloud.notebooks.v2.UpgradeHistoryEntry
UpgradeInstanceRequest
Request for upgrading a notebook instance
Protobuf type google.cloud.notebooks.v2.UpgradeInstanceRequest
UpgradeInstanceRequest.Builder
Request for upgrading a notebook instance
Protobuf type google.cloud.notebooks.v2.UpgradeInstanceRequest
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.v2.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.v2.VmImage
Interfaces
AcceleratorConfigOrBuilder
BootDiskOrBuilder
CheckInstanceUpgradabilityRequestOrBuilder
CheckInstanceUpgradabilityResponseOrBuilder
ContainerImageOrBuilder
CreateInstanceRequestOrBuilder
DataDiskOrBuilder
DeleteInstanceRequestOrBuilder
DiagnoseInstanceRequestOrBuilder
DiagnosticConfigOrBuilder
EventOrBuilder
GPUDriverConfigOrBuilder
GceSetupOrBuilder
GetInstanceRequestOrBuilder
InstanceOrBuilder
ListInstancesRequestOrBuilder
ListInstancesResponseOrBuilder
NetworkInterfaceOrBuilder
NotebookServiceGrpc.AsyncService
API v2 service for Workbench Notebooks Instances.
OperationMetadataOrBuilder
ResetInstanceRequestOrBuilder
RollbackInstanceRequestOrBuilder
ServiceAccountOrBuilder
ShieldedInstanceConfigOrBuilder
StartInstanceRequestOrBuilder
StopInstanceRequestOrBuilder
UpdateInstanceRequestOrBuilder
UpgradeHistoryEntryOrBuilder
UpgradeInstanceRequestOrBuilder
VmImageOrBuilder
Enums
AcceleratorConfig.AcceleratorType
Definition of the types of hardware accelerators that can be used on this instance.
Protobuf enum google.cloud.notebooks.v2.AcceleratorConfig.AcceleratorType
DiskEncryption
Definition of the disk encryption options.
Protobuf enum google.cloud.notebooks.v2.DiskEncryption
DiskType
Possible disk types.
Protobuf enum google.cloud.notebooks.v2.DiskType
Event.EventType
The definition of the event types.
Protobuf enum google.cloud.notebooks.v2.Event.EventType
GceSetup.ImageCase
HealthState
The instance health state.
Protobuf enum google.cloud.notebooks.v2.HealthState
Instance.InfrastructureCase
NetworkInterface.NicType
The type of vNIC driver. Default should be NIC_TYPE_UNSPECIFIED.
Protobuf enum google.cloud.notebooks.v2.NetworkInterface.NicType
State
The definition of the states of this instance.
Protobuf enum google.cloud.notebooks.v2.State
UpgradeHistoryEntry.Action
The definition of operations of this upgrade history entry.
Protobuf enum google.cloud.notebooks.v2.UpgradeHistoryEntry.Action
UpgradeHistoryEntry.State
The definition of the states of this upgrade history entry.
Protobuf enum google.cloud.notebooks.v2.UpgradeHistoryEntry.State