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

A client to Notebooks API

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

NotebookServiceClient

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

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()) {
   GetInstanceRequest request = GetInstanceRequest.newBuilder().setName("name3373707").build();
   Instance response = notebookServiceClient.getInstance(request);
 }

Classes

ContainerImage

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

Protobuf type google.cloud.notebooks.v1beta1.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.v1beta1.ContainerImage

CreateEnvironmentRequest

Request for creating a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.CreateEnvironmentRequest

CreateEnvironmentRequest.Builder

Request for creating a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.CreateEnvironmentRequest

CreateInstanceRequest

Request for creating a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.CreateInstanceRequest

CreateInstanceRequest.Builder

Request for creating a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.CreateInstanceRequest

DeleteEnvironmentRequest

Request for deleting a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.DeleteEnvironmentRequest

DeleteEnvironmentRequest.Builder

Request for deleting a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.DeleteEnvironmentRequest

DeleteInstanceRequest

Request for deleting a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.DeleteInstanceRequest

DeleteInstanceRequest.Builder

Request for deleting a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.DeleteInstanceRequest

Environment

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

Protobuf type google.cloud.notebooks.v1beta1.Environment

Environment.Builder

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

Protobuf type google.cloud.notebooks.v1beta1.Environment

GetEnvironmentRequest

Request for getting a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.GetEnvironmentRequest

GetEnvironmentRequest.Builder

Request for getting a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.GetEnvironmentRequest

GetInstanceRequest

Request for getting a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.GetInstanceRequest

GetInstanceRequest.Builder

Request for getting a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.GetInstanceRequest

Instance

The definition of a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.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.v1beta1.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.v1beta1.Instance.AcceleratorConfig

Instance.Builder

The definition of a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.Instance

IsInstanceUpgradeableRequest

Request for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1beta1.IsInstanceUpgradeableRequest

IsInstanceUpgradeableRequest.Builder

Request for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1beta1.IsInstanceUpgradeableRequest

IsInstanceUpgradeableResponse

Response for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse

IsInstanceUpgradeableResponse.Builder

Response for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse

ListEnvironmentsRequest

Request for listing environments.

Protobuf type google.cloud.notebooks.v1beta1.ListEnvironmentsRequest

ListEnvironmentsRequest.Builder

Request for listing environments.

Protobuf type google.cloud.notebooks.v1beta1.ListEnvironmentsRequest

ListEnvironmentsResponse

Response for listing environments.

Protobuf type google.cloud.notebooks.v1beta1.ListEnvironmentsResponse

ListEnvironmentsResponse.Builder

Response for listing environments.

Protobuf type google.cloud.notebooks.v1beta1.ListEnvironmentsResponse

ListInstancesRequest

Request for listing notebook instances.

Protobuf type google.cloud.notebooks.v1beta1.ListInstancesRequest

ListInstancesRequest.Builder

Request for listing notebook instances.

Protobuf type google.cloud.notebooks.v1beta1.ListInstancesRequest

ListInstancesResponse

Response for listing notebook instances.

Protobuf type google.cloud.notebooks.v1beta1.ListInstancesResponse

ListInstancesResponse.Builder

Response for listing notebook instances.

Protobuf type google.cloud.notebooks.v1beta1.ListInstancesResponse

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:


 // 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()) {
   GetInstanceRequest request = GetInstanceRequest.newBuilder().setName("name3373707").build();
   Instance response = notebookServiceClient.getInstance(request);
 }

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);

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

NotebookServiceClient.ListEnvironmentsFixedSizeCollection

NotebookServiceClient.ListEnvironmentsPage

NotebookServiceClient.ListEnvironmentsPagedResponse

NotebookServiceClient.ListInstancesFixedSizeCollection

NotebookServiceClient.ListInstancesPage

NotebookServiceClient.ListInstancesPagedResponse