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

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

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

Request for creating a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.CreateEnvironmentRequest

Request for creating a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.CreateEnvironmentRequest

Request for creating a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.CreateInstanceRequest

Request for creating a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.CreateInstanceRequest

Request for deleting a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.DeleteEnvironmentRequest

Request for deleting a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.DeleteEnvironmentRequest

Request for deleting a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.DeleteInstanceRequest

Request for deleting a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.DeleteInstanceRequest

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

Protobuf type google.cloud.notebooks.v1beta1.Environment

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

Protobuf type google.cloud.notebooks.v1beta1.Environment

Request for getting a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.GetEnvironmentRequest

Request for getting a notebook environment.

Protobuf type google.cloud.notebooks.v1beta1.GetEnvironmentRequest

Request for getting a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.GetInstanceRequest

Request for getting a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.GetInstanceRequest

The definition of a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.Instance

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

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

The definition of a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.Instance

Request for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1beta1.IsInstanceUpgradeableRequest

Request for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1beta1.IsInstanceUpgradeableRequest

Response for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse

Response for checking if a notebook instance is upgradeable.

Protobuf type google.cloud.notebooks.v1beta1.IsInstanceUpgradeableResponse

Request for listing environments.

Protobuf type google.cloud.notebooks.v1beta1.ListEnvironmentsRequest

Request for listing environments.

Protobuf type google.cloud.notebooks.v1beta1.ListEnvironmentsRequest

Response for listing environments.

Protobuf type google.cloud.notebooks.v1beta1.ListEnvironmentsResponse

Response for listing environments.

Protobuf type google.cloud.notebooks.v1beta1.ListEnvironmentsResponse

Request for listing notebook instances.

Protobuf type google.cloud.notebooks.v1beta1.ListInstancesRequest

Request for listing notebook instances.

Protobuf type google.cloud.notebooks.v1beta1.ListInstancesRequest

Response for listing notebook instances.

Protobuf type google.cloud.notebooks.v1beta1.ListInstancesResponse

Response for listing notebook instances.

Protobuf type google.cloud.notebooks.v1beta1.ListInstancesResponse

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:

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:

 // 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.

API v1beta1 service for Cloud AI Platform Notebooks.

API v1beta1 service for Cloud AI Platform Notebooks.

API v1beta1 service for Cloud AI Platform Notebooks.

API v1beta1 service for Cloud AI Platform Notebooks.

API v1beta1 service for Cloud AI Platform Notebooks.

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

Builder for NotebookServiceSettings.

Represents the metadata of the long-running operation.

Protobuf type google.cloud.notebooks.v1beta1.OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.notebooks.v1beta1.OperationMetadata

Request for registering a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.RegisterInstanceRequest

Request for registering a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.RegisterInstanceRequest

Request for notebook instances to report information to Notebooks API.

Protobuf type google.cloud.notebooks.v1beta1.ReportInstanceInfoRequest

Request for notebook instances to report information to Notebooks API.

Protobuf type google.cloud.notebooks.v1beta1.ReportInstanceInfoRequest

Reservation Affinity for consuming Zonal reservation.

Protobuf type google.cloud.notebooks.v1beta1.ReservationAffinity

Reservation Affinity for consuming Zonal reservation.

Protobuf type google.cloud.notebooks.v1beta1.ReservationAffinity

Request for reseting a notebook instance

Protobuf type google.cloud.notebooks.v1beta1.ResetInstanceRequest

Request for reseting a notebook instance

Protobuf type google.cloud.notebooks.v1beta1.ResetInstanceRequest

Request for setting instance accelerator.

Protobuf type google.cloud.notebooks.v1beta1.SetInstanceAcceleratorRequest

Request for setting instance accelerator.

Protobuf type google.cloud.notebooks.v1beta1.SetInstanceAcceleratorRequest

Request for setting instance labels.

Protobuf type google.cloud.notebooks.v1beta1.SetInstanceLabelsRequest

Request for setting instance labels.

Protobuf type google.cloud.notebooks.v1beta1.SetInstanceLabelsRequest

Request for setting instance machine type.

Protobuf type google.cloud.notebooks.v1beta1.SetInstanceMachineTypeRequest

Request for setting instance machine type.

Protobuf type google.cloud.notebooks.v1beta1.SetInstanceMachineTypeRequest

Request for starting a notebook instance

Protobuf type google.cloud.notebooks.v1beta1.StartInstanceRequest

Request for starting a notebook instance

Protobuf type google.cloud.notebooks.v1beta1.StartInstanceRequest

Request for stopping a notebook instance

Protobuf type google.cloud.notebooks.v1beta1.StopInstanceRequest

Request for stopping a notebook instance

Protobuf type google.cloud.notebooks.v1beta1.StopInstanceRequest

Request for upgrading a notebook instance from within the VM

Protobuf type google.cloud.notebooks.v1beta1.UpgradeInstanceInternalRequest

Request for upgrading a notebook instance from within the VM

Protobuf type google.cloud.notebooks.v1beta1.UpgradeInstanceInternalRequest

Request for upgrading a notebook instance

Protobuf type google.cloud.notebooks.v1beta1.UpgradeInstanceRequest

Request for upgrading a notebook instance

Protobuf type google.cloud.notebooks.v1beta1.UpgradeInstanceRequest

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.v1beta1.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.v1beta1.VmImage

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

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

Definition of the disk encryption options.

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

Possible disk types for notebook instances.

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

The type of vNIC driver.

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

The definition of the states of this instance.

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

Indicates whether to consume capacity from an reservation or not.

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