Package com.google.cloud.notebooks.v1beta1 (1.29.0)

GitHub Repository

This package is not the latest GA version!

For this library, we recommend using the package associated with API version v2 for new applications.

Prerelease Implications

This package is a prerelease version! Use with caution. Prerelease versions are considered unstable as they may be shut down. You can read more about Cloud API versioning strategy here. Each Cloud Java client library may contain multiple packages. Each package containing a version number in its name corresponds to a published version of the service. We recommend using the latest stable version for new production applications, which can be identified by the largest numeric version that does not contain a suffix. For example, if a client library has two packages: v1 and v2alpha, then the latest stable version is v1. If you use an unstable release, breaking changes may be introduced when upgrading.

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.v1beta1.NotebookServiceClient Service Description: API v1beta1 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.v1beta1.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.v1beta1.ContainerImage Definition of a container image for starting a notebook instance with the environment installed in a container.
com.google.cloud.notebooks.v1beta1.ContainerImage.Builder Definition of a container image for starting a notebook instance with the environment installed in a container.
com.google.cloud.notebooks.v1beta1.CreateEnvironmentRequest Request for creating a notebook environment.
com.google.cloud.notebooks.v1beta1.CreateEnvironmentRequest.Builder Request for creating a notebook environment.
com.google.cloud.notebooks.v1beta1.CreateInstanceRequest Request for creating a notebook instance.
com.google.cloud.notebooks.v1beta1.CreateInstanceRequest.Builder Request for creating a notebook instance.
com.google.cloud.notebooks.v1beta1.DeleteEnvironmentRequest Request for deleting a notebook environment.
com.google.cloud.notebooks.v1beta1.DeleteEnvironmentRequest.Builder Request for deleting a notebook environment.
com.google.cloud.notebooks.v1beta1.DeleteInstanceRequest Request for deleting a notebook instance.
com.google.cloud.notebooks.v1beta1.DeleteInstanceRequest.Builder Request for deleting a notebook instance.
com.google.cloud.notebooks.v1beta1.Environment Definition of a software environment that is used to start a notebook instance.
com.google.cloud.notebooks.v1beta1.Environment.Builder Definition of a software environment that is used to start a notebook instance.
com.google.cloud.notebooks.v1beta1.EnvironmentProto
com.google.cloud.notebooks.v1beta1.GetEnvironmentRequest Request for getting a notebook environment.
com.google.cloud.notebooks.v1beta1.GetEnvironmentRequest.Builder Request for getting a notebook environment.
com.google.cloud.notebooks.v1beta1.GetInstanceRequest Request for getting a notebook instance.
com.google.cloud.notebooks.v1beta1.GetInstanceRequest.Builder Request for getting a notebook instance.
com.google.cloud.notebooks.v1beta1.Instance The definition of a notebook instance.
com.google.cloud.notebooks.v1beta1.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.v1beta1.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.v1beta1.Instance.Builder The definition of a notebook instance.
com.google.cloud.notebooks.v1beta1.InstanceProto
com.google.cloud.notebooks.v1beta1.IsInstanceUpgradeableRequest Request for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v1beta1.IsInstanceUpgradeableRequest.Builder Request for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse Response for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse.Builder Response for checking if a notebook instance is upgradeable.
com.google.cloud.notebooks.v1beta1.ListEnvironmentsRequest Request for listing environments.
com.google.cloud.notebooks.v1beta1.ListEnvironmentsRequest.Builder Request for listing environments.
com.google.cloud.notebooks.v1beta1.ListEnvironmentsResponse Response for listing environments.
com.google.cloud.notebooks.v1beta1.ListEnvironmentsResponse.Builder Response for listing environments.
com.google.cloud.notebooks.v1beta1.ListInstancesRequest Request for listing notebook instances.
com.google.cloud.notebooks.v1beta1.ListInstancesRequest.Builder Request for listing notebook instances.
com.google.cloud.notebooks.v1beta1.ListInstancesResponse Response for listing notebook instances.
com.google.cloud.notebooks.v1beta1.ListInstancesResponse.Builder Response for listing notebook instances.
com.google.cloud.notebooks.v1beta1.NotebookServiceClient.ListEnvironmentsFixedSizeCollection
com.google.cloud.notebooks.v1beta1.NotebookServiceClient.ListEnvironmentsPage
com.google.cloud.notebooks.v1beta1.NotebookServiceClient.ListEnvironmentsPagedResponse
com.google.cloud.notebooks.v1beta1.NotebookServiceClient.ListInstancesFixedSizeCollection
com.google.cloud.notebooks.v1beta1.NotebookServiceClient.ListInstancesPage
com.google.cloud.notebooks.v1beta1.NotebookServiceClient.ListInstancesPagedResponse
com.google.cloud.notebooks.v1beta1.NotebookServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.notebooks.v1beta1.NotebookServiceClient.ListLocationsPage
com.google.cloud.notebooks.v1beta1.NotebookServiceClient.ListLocationsPagedResponse
com.google.cloud.notebooks.v1beta1.NotebookServiceGrpc API v1beta1 service for Cloud AI Platform Notebooks.
com.google.cloud.notebooks.v1beta1.NotebookServiceGrpc.NotebookServiceImplBase Base class for the server implementation of the service NotebookService. API v1beta1 service for Cloud AI Platform Notebooks.
com.google.cloud.notebooks.v1beta1.NotebookServiceSettings.Builder Builder for NotebookServiceSettings.
com.google.cloud.notebooks.v1beta1.NotebooksProto
com.google.cloud.notebooks.v1beta1.OperationMetadata Represents the metadata of the long-running operation.
com.google.cloud.notebooks.v1beta1.OperationMetadata.Builder Represents the metadata of the long-running operation.
com.google.cloud.notebooks.v1beta1.RegisterInstanceRequest Request for registering a notebook instance.
com.google.cloud.notebooks.v1beta1.RegisterInstanceRequest.Builder Request for registering a notebook instance.
com.google.cloud.notebooks.v1beta1.ReportInstanceInfoRequest Request for notebook instances to report information to Notebooks API.
com.google.cloud.notebooks.v1beta1.ReportInstanceInfoRequest.Builder Request for notebook instances to report information to Notebooks API.
com.google.cloud.notebooks.v1beta1.ReservationAffinity Reservation Affinity for consuming Zonal reservation.
com.google.cloud.notebooks.v1beta1.ReservationAffinity.Builder Reservation Affinity for consuming Zonal reservation.
com.google.cloud.notebooks.v1beta1.ResetInstanceRequest Request for reseting a notebook instance
com.google.cloud.notebooks.v1beta1.ResetInstanceRequest.Builder Request for reseting a notebook instance
com.google.cloud.notebooks.v1beta1.SetInstanceAcceleratorRequest Request for setting instance accelerator.
com.google.cloud.notebooks.v1beta1.SetInstanceAcceleratorRequest.Builder Request for setting instance accelerator.
com.google.cloud.notebooks.v1beta1.SetInstanceLabelsRequest Request for setting instance labels.
com.google.cloud.notebooks.v1beta1.SetInstanceLabelsRequest.Builder Request for setting instance labels.
com.google.cloud.notebooks.v1beta1.SetInstanceMachineTypeRequest Request for setting instance machine type.
com.google.cloud.notebooks.v1beta1.SetInstanceMachineTypeRequest.Builder Request for setting instance machine type.
com.google.cloud.notebooks.v1beta1.StartInstanceRequest Request for starting a notebook instance
com.google.cloud.notebooks.v1beta1.StartInstanceRequest.Builder Request for starting a notebook instance
com.google.cloud.notebooks.v1beta1.StopInstanceRequest Request for stopping a notebook instance
com.google.cloud.notebooks.v1beta1.StopInstanceRequest.Builder Request for stopping a notebook instance
com.google.cloud.notebooks.v1beta1.UpgradeInstanceInternalRequest Request for upgrading a notebook instance from within the VM
com.google.cloud.notebooks.v1beta1.UpgradeInstanceInternalRequest.Builder Request for upgrading a notebook instance from within the VM
com.google.cloud.notebooks.v1beta1.UpgradeInstanceRequest Request for upgrading a notebook instance
com.google.cloud.notebooks.v1beta1.UpgradeInstanceRequest.Builder Request for upgrading a notebook instance
com.google.cloud.notebooks.v1beta1.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.v1beta1.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.v1beta1.ContainerImageOrBuilder
com.google.cloud.notebooks.v1beta1.CreateEnvironmentRequestOrBuilder
com.google.cloud.notebooks.v1beta1.CreateInstanceRequestOrBuilder
com.google.cloud.notebooks.v1beta1.DeleteEnvironmentRequestOrBuilder
com.google.cloud.notebooks.v1beta1.DeleteInstanceRequestOrBuilder
com.google.cloud.notebooks.v1beta1.EnvironmentOrBuilder
com.google.cloud.notebooks.v1beta1.GetEnvironmentRequestOrBuilder
com.google.cloud.notebooks.v1beta1.GetInstanceRequestOrBuilder
com.google.cloud.notebooks.v1beta1.Instance.AcceleratorConfigOrBuilder
com.google.cloud.notebooks.v1beta1.InstanceOrBuilder
com.google.cloud.notebooks.v1beta1.IsInstanceUpgradeableRequestOrBuilder
com.google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponseOrBuilder
com.google.cloud.notebooks.v1beta1.ListEnvironmentsRequestOrBuilder
com.google.cloud.notebooks.v1beta1.ListEnvironmentsResponseOrBuilder
com.google.cloud.notebooks.v1beta1.ListInstancesRequestOrBuilder
com.google.cloud.notebooks.v1beta1.ListInstancesResponseOrBuilder
com.google.cloud.notebooks.v1beta1.NotebookServiceGrpc.AsyncService API v1beta1 service for Cloud AI Platform Notebooks.
com.google.cloud.notebooks.v1beta1.OperationMetadataOrBuilder
com.google.cloud.notebooks.v1beta1.RegisterInstanceRequestOrBuilder
com.google.cloud.notebooks.v1beta1.ReportInstanceInfoRequestOrBuilder
com.google.cloud.notebooks.v1beta1.ReservationAffinityOrBuilder
com.google.cloud.notebooks.v1beta1.ResetInstanceRequestOrBuilder
com.google.cloud.notebooks.v1beta1.SetInstanceAcceleratorRequestOrBuilder
com.google.cloud.notebooks.v1beta1.SetInstanceLabelsRequestOrBuilder
com.google.cloud.notebooks.v1beta1.SetInstanceMachineTypeRequestOrBuilder
com.google.cloud.notebooks.v1beta1.StartInstanceRequestOrBuilder
com.google.cloud.notebooks.v1beta1.StopInstanceRequestOrBuilder
com.google.cloud.notebooks.v1beta1.UpgradeInstanceInternalRequestOrBuilder
com.google.cloud.notebooks.v1beta1.UpgradeInstanceRequestOrBuilder
com.google.cloud.notebooks.v1beta1.VmImageOrBuilder

Enums

Enum Description
com.google.cloud.notebooks.v1beta1.Environment.ImageTypeCase
com.google.cloud.notebooks.v1beta1.Instance.AcceleratorType Definition of the types of hardware accelerators that can be used on this instance.
com.google.cloud.notebooks.v1beta1.Instance.DiskEncryption Definition of the disk encryption options.
com.google.cloud.notebooks.v1beta1.Instance.DiskType Possible disk types for notebook instances.
com.google.cloud.notebooks.v1beta1.Instance.EnvironmentCase
com.google.cloud.notebooks.v1beta1.Instance.NicType The type of vNIC driver.
com.google.cloud.notebooks.v1beta1.Instance.State The definition of the states of this instance.
com.google.cloud.notebooks.v1beta1.ReservationAffinity.Type Indicates whether to consume capacity from an reservation or not.
com.google.cloud.notebooks.v1beta1.VmImage.ImageCase