Package com.google.cloud.notebooks.v2 (1.28.0)

GitHub Repository

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.v2.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:

Settings Classes

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

Settings Description
com.google.cloud.notebooks.v2.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.v2.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.
com.google.cloud.notebooks.v2.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.
com.google.cloud.notebooks.v2.BootDisk The definition of a boot disk.
com.google.cloud.notebooks.v2.BootDisk.Builder The definition of a boot disk.
com.google.cloud.notebooks.v2.CheckInstanceUpgradabilityRequest Request for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v2.CheckInstanceUpgradabilityRequest.Builder Request for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v2.CheckInstanceUpgradabilityResponse Response for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v2.CheckInstanceUpgradabilityResponse.Builder Response for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v2.ContainerImage Definition of a container image for starting a notebook instance with the environment installed in a container.
com.google.cloud.notebooks.v2.ContainerImage.Builder Definition of a container image for starting a notebook instance with the environment installed in a container.
com.google.cloud.notebooks.v2.CreateInstanceRequest Request for creating a notebook instance.
com.google.cloud.notebooks.v2.CreateInstanceRequest.Builder Request for creating a notebook instance.
com.google.cloud.notebooks.v2.DataDisk An instance-attached disk resource.
com.google.cloud.notebooks.v2.DataDisk.Builder An instance-attached disk resource.
com.google.cloud.notebooks.v2.DeleteInstanceRequest Request for deleting a notebook instance.
com.google.cloud.notebooks.v2.DeleteInstanceRequest.Builder Request for deleting a notebook instance.
com.google.cloud.notebooks.v2.DiagnoseInstanceRequest Request for creating a notebook instance diagnostic file.
com.google.cloud.notebooks.v2.DiagnoseInstanceRequest.Builder Request for creating a notebook instance diagnostic file.
com.google.cloud.notebooks.v2.DiagnosticConfig Defines flags that are used to run the diagnostic tool
com.google.cloud.notebooks.v2.DiagnosticConfig.Builder Defines flags that are used to run the diagnostic tool
com.google.cloud.notebooks.v2.DiagnosticConfigProto
com.google.cloud.notebooks.v2.Event The definition of an Event for a managed / semi-managed notebook instance.
com.google.cloud.notebooks.v2.Event.Builder The definition of an Event for a managed / semi-managed notebook instance.
com.google.cloud.notebooks.v2.EventProto
com.google.cloud.notebooks.v2.GPUDriverConfig A GPU driver configuration
com.google.cloud.notebooks.v2.GPUDriverConfig.Builder A GPU driver configuration
com.google.cloud.notebooks.v2.GceSetup The definition of how to configure a VM instance outside of Resources and Identity.
com.google.cloud.notebooks.v2.GceSetup.Builder The definition of how to configure a VM instance outside of Resources and Identity.
com.google.cloud.notebooks.v2.GceSetupProto
com.google.cloud.notebooks.v2.GetInstanceRequest Request for getting a notebook instance.
com.google.cloud.notebooks.v2.GetInstanceRequest.Builder Request for getting a notebook instance.
com.google.cloud.notebooks.v2.Instance The definition of a notebook instance.
com.google.cloud.notebooks.v2.Instance.Builder The definition of a notebook instance.
com.google.cloud.notebooks.v2.InstanceName
com.google.cloud.notebooks.v2.InstanceName.Builder Builder for projects/{project}/locations/{location}/instances/{instance}.
com.google.cloud.notebooks.v2.InstanceProto
com.google.cloud.notebooks.v2.ListInstancesRequest Request for listing notebook instances.
com.google.cloud.notebooks.v2.ListInstancesRequest.Builder Request for listing notebook instances.
com.google.cloud.notebooks.v2.ListInstancesResponse Response for listing notebook instances.
com.google.cloud.notebooks.v2.ListInstancesResponse.Builder Response for listing notebook instances.
com.google.cloud.notebooks.v2.LocationName
com.google.cloud.notebooks.v2.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.notebooks.v2.NetworkInterface The definition of a network interface resource attached to a VM.
com.google.cloud.notebooks.v2.NetworkInterface.Builder The definition of a network interface resource attached to a VM.
com.google.cloud.notebooks.v2.NotebookServiceClient.ListInstancesFixedSizeCollection
com.google.cloud.notebooks.v2.NotebookServiceClient.ListInstancesPage
com.google.cloud.notebooks.v2.NotebookServiceClient.ListInstancesPagedResponse
com.google.cloud.notebooks.v2.NotebookServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.notebooks.v2.NotebookServiceClient.ListLocationsPage
com.google.cloud.notebooks.v2.NotebookServiceClient.ListLocationsPagedResponse
com.google.cloud.notebooks.v2.NotebookServiceGrpc API v2 service for Workbench Notebooks Instances.
com.google.cloud.notebooks.v2.NotebookServiceGrpc.NotebookServiceImplBase Base class for the server implementation of the service NotebookService. API v2 service for Workbench Notebooks Instances.
com.google.cloud.notebooks.v2.NotebookServiceSettings.Builder Builder for NotebookServiceSettings.
com.google.cloud.notebooks.v2.OperationMetadata Represents the metadata of the long-running operation.
com.google.cloud.notebooks.v2.OperationMetadata.Builder Represents the metadata of the long-running operation.
com.google.cloud.notebooks.v2.ResetInstanceRequest Request for resetting a notebook instance
com.google.cloud.notebooks.v2.ResetInstanceRequest.Builder Request for resetting a notebook instance
com.google.cloud.notebooks.v2.RollbackInstanceRequest Request for rollbacking a notebook instance
com.google.cloud.notebooks.v2.RollbackInstanceRequest.Builder Request for rollbacking a notebook instance
com.google.cloud.notebooks.v2.ServiceAccount A service account that acts as an identity.
com.google.cloud.notebooks.v2.ServiceAccount.Builder A service account that acts as an identity.
com.google.cloud.notebooks.v2.ServiceProto
com.google.cloud.notebooks.v2.ShieldedInstanceConfig A set of Shielded Instance options. See Images using supported Shielded VM features.
com.google.cloud.notebooks.v2.ShieldedInstanceConfig.Builder A set of Shielded Instance options. See Images using supported Shielded VM features.
com.google.cloud.notebooks.v2.StartInstanceRequest Request for starting a notebook instance
com.google.cloud.notebooks.v2.StartInstanceRequest.Builder Request for starting a notebook instance
com.google.cloud.notebooks.v2.StopInstanceRequest Request for stopping a notebook instance
com.google.cloud.notebooks.v2.StopInstanceRequest.Builder Request for stopping a notebook instance
com.google.cloud.notebooks.v2.UpdateInstanceRequest Request for updating a notebook instance.
com.google.cloud.notebooks.v2.UpdateInstanceRequest.Builder Request for updating a notebook instance.
com.google.cloud.notebooks.v2.UpgradeHistoryEntry The entry of VM image upgrade history.
com.google.cloud.notebooks.v2.UpgradeHistoryEntry.Builder The entry of VM image upgrade history.
com.google.cloud.notebooks.v2.UpgradeInstanceRequest Request for upgrading a notebook instance
com.google.cloud.notebooks.v2.UpgradeInstanceRequest.Builder Request for upgrading a notebook instance
com.google.cloud.notebooks.v2.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.v2.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.v2.AcceleratorConfigOrBuilder
com.google.cloud.notebooks.v2.BootDiskOrBuilder
com.google.cloud.notebooks.v2.CheckInstanceUpgradabilityRequestOrBuilder
com.google.cloud.notebooks.v2.CheckInstanceUpgradabilityResponseOrBuilder
com.google.cloud.notebooks.v2.ContainerImageOrBuilder
com.google.cloud.notebooks.v2.CreateInstanceRequestOrBuilder
com.google.cloud.notebooks.v2.DataDiskOrBuilder
com.google.cloud.notebooks.v2.DeleteInstanceRequestOrBuilder
com.google.cloud.notebooks.v2.DiagnoseInstanceRequestOrBuilder
com.google.cloud.notebooks.v2.DiagnosticConfigOrBuilder
com.google.cloud.notebooks.v2.EventOrBuilder
com.google.cloud.notebooks.v2.GPUDriverConfigOrBuilder
com.google.cloud.notebooks.v2.GceSetupOrBuilder
com.google.cloud.notebooks.v2.GetInstanceRequestOrBuilder
com.google.cloud.notebooks.v2.InstanceOrBuilder
com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder
com.google.cloud.notebooks.v2.ListInstancesResponseOrBuilder
com.google.cloud.notebooks.v2.NetworkInterfaceOrBuilder
com.google.cloud.notebooks.v2.NotebookServiceGrpc.AsyncService API v2 service for Workbench Notebooks Instances.
com.google.cloud.notebooks.v2.OperationMetadataOrBuilder
com.google.cloud.notebooks.v2.ResetInstanceRequestOrBuilder
com.google.cloud.notebooks.v2.RollbackInstanceRequestOrBuilder
com.google.cloud.notebooks.v2.ServiceAccountOrBuilder
com.google.cloud.notebooks.v2.ShieldedInstanceConfigOrBuilder
com.google.cloud.notebooks.v2.StartInstanceRequestOrBuilder
com.google.cloud.notebooks.v2.StopInstanceRequestOrBuilder
com.google.cloud.notebooks.v2.UpdateInstanceRequestOrBuilder
com.google.cloud.notebooks.v2.UpgradeHistoryEntryOrBuilder
com.google.cloud.notebooks.v2.UpgradeInstanceRequestOrBuilder
com.google.cloud.notebooks.v2.VmImageOrBuilder

Enums

Enum Description
com.google.cloud.notebooks.v2.AcceleratorConfig.AcceleratorType Definition of the types of hardware accelerators that can be used on this instance.
com.google.cloud.notebooks.v2.DiskEncryption Definition of the disk encryption options.
com.google.cloud.notebooks.v2.DiskType Possible disk types.
com.google.cloud.notebooks.v2.Event.EventType The definition of the event types.
com.google.cloud.notebooks.v2.GceSetup.ImageCase
com.google.cloud.notebooks.v2.HealthState The instance health state.
com.google.cloud.notebooks.v2.Instance.InfrastructureCase
com.google.cloud.notebooks.v2.NetworkInterface.NicType The type of vNIC driver. Default should be NIC_TYPE_UNSPECIFIED.
com.google.cloud.notebooks.v2.State The definition of the states of this instance.
com.google.cloud.notebooks.v2.UpgradeHistoryEntry.Action The definition of operations of this upgrade history entry.
com.google.cloud.notebooks.v2.UpgradeHistoryEntry.State The definition of the states of this upgrade history entry.
com.google.cloud.notebooks.v2.VmImage.ImageCase