@Generated("by gapic-generator-java")
Package com.google.cloud.notebooks.v1
A client to Notebooks API
The interfaces provided are listed below, along with usage samples.
======================= ManagedNotebookServiceClient =======================
Service Description: API v1 service for Managed Notebooks.
Sample for ManagedNotebookServiceClient:
// 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 (ManagedNotebookServiceClient managedNotebookServiceClient =
ManagedNotebookServiceClient.create()) {
RuntimeName name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]");
Runtime response = managedNotebookServiceClient.getRuntime(name);
}
======================= NotebookServiceClient =======================
Service Description: API v1 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()) {
String name = "name3373707";
Instance response = notebookServiceClient.getInstance(name);
}
-
Class Summary Class Description ContainerImage Definition of a container image for starting a notebook instance with the environment installed in a container.ContainerImage.Builder Definition of a container image for starting a notebook instance with the environment installed in a container.CreateEnvironmentRequest Request for creating a notebook environment.CreateEnvironmentRequest.Builder Request for creating a notebook environment.CreateExecutionRequest Request to create notebook executionCreateExecutionRequest.Builder Request to create notebook executionCreateInstanceRequest Request for creating a notebook instance.CreateInstanceRequest.Builder Request for creating a notebook instance.CreateRuntimeRequest Request for creating a Managed Notebook Runtime.CreateRuntimeRequest.Builder Request for creating a Managed Notebook Runtime.CreateScheduleRequest Request for created scheduled notebooksCreateScheduleRequest.Builder Request for created scheduled notebooksDeleteEnvironmentRequest Request for deleting a notebook environment.DeleteEnvironmentRequest.Builder Request for deleting a notebook environment.DeleteExecutionRequest Request for deleting a scheduled notebook executionDeleteExecutionRequest.Builder Request for deleting a scheduled notebook executionDeleteInstanceRequest Request for deleting a notebook instance.DeleteInstanceRequest.Builder Request for deleting a notebook instance.DeleteRuntimeRequest Request for deleting a Managed Notebook Runtime.DeleteRuntimeRequest.Builder Request for deleting a Managed Notebook Runtime.DeleteScheduleRequest Request for deleting an ScheduleDeleteScheduleRequest.Builder Request for deleting an ScheduleDiagnoseInstanceRequest Request for creating a notebook instance diagnostic file.DiagnoseInstanceRequest.Builder Request for creating a notebook instance diagnostic file.DiagnoseRuntimeRequest Request for creating a notebook instance diagnostic file.DiagnoseRuntimeRequest.Builder Request for creating a notebook instance diagnostic file.DiagnosticConfig Defines flags that are used to run the diagnostic toolDiagnosticConfig.Builder Defines flags that are used to run the diagnostic toolDiagnosticConfigProto EncryptionConfig Represents a custom encryption key configuration that can be applied to a resource.EncryptionConfig.Builder Represents a custom encryption key configuration that can be applied to a resource.Environment Definition of a software environment that is used to start a notebook instance.Environment.Builder Definition of a software environment that is used to start a notebook instance.EnvironmentProto Event The definition of an Event for a managed / semi-managed notebook instance.Event.Builder The definition of an Event for a managed / semi-managed notebook instance.EventProto Execution The definition of a single executed notebook.Execution.Builder The definition of a single executed notebook.ExecutionName ExecutionName.Builder Builder for projects/{project}/location/{location}/executions/{execution}.ExecutionProto ExecutionTemplate The description a notebook execution workload.ExecutionTemplate.Builder The description a notebook execution workload.ExecutionTemplate.DataprocParameters Parameters used in Dataproc JobType executions.ExecutionTemplate.DataprocParameters.Builder Parameters used in Dataproc JobType executions.ExecutionTemplate.SchedulerAcceleratorConfig Definition of a hardware accelerator.ExecutionTemplate.SchedulerAcceleratorConfig.Builder Definition of a hardware accelerator.ExecutionTemplate.VertexAIParameters Parameters used in Vertex AI JobType executions.ExecutionTemplate.VertexAIParameters.Builder Parameters used in Vertex AI JobType executions.GetEnvironmentRequest Request for getting a notebook environment.GetEnvironmentRequest.Builder Request for getting a notebook environment.GetExecutionRequest Request for getting scheduled notebook executionGetExecutionRequest.Builder Request for getting scheduled notebook executionGetInstanceHealthRequest Request for checking if a notebook instance is healthy.GetInstanceHealthRequest.Builder Request for checking if a notebook instance is healthy.GetInstanceHealthResponse Response for checking if a notebook instance is healthy.GetInstanceHealthResponse.Builder Response for checking if a notebook instance is healthy.GetInstanceRequest Request for getting a notebook instance.GetInstanceRequest.Builder Request for getting a notebook instance.GetRuntimeRequest Request for getting a Managed Notebook Runtime.GetRuntimeRequest.Builder Request for getting a Managed Notebook Runtime.GetScheduleRequest Request for getting scheduled notebook.GetScheduleRequest.Builder Request for getting scheduled notebook.Instance The definition of a notebook instance.Instance.AcceleratorConfig Definition of a hardware accelerator.Instance.AcceleratorConfig.Builder Definition of a hardware accelerator.Instance.Builder The definition of a notebook instance.Instance.Disk An instance-attached disk resource.Instance.Disk.Builder An instance-attached disk resource.Instance.Disk.GuestOsFeature Guest OS features for boot disk.Instance.Disk.GuestOsFeature.Builder Guest OS features for boot disk.Instance.ShieldedInstanceConfig A set of Shielded Instance options.Instance.ShieldedInstanceConfig.Builder A set of Shielded Instance options.Instance.UpgradeHistoryEntry The entry of VM image upgrade history.Instance.UpgradeHistoryEntry.Builder The entry of VM image upgrade history.InstanceConfig Notebook instance configurations that can be updated.InstanceConfig.Builder Notebook instance configurations that can be updated.InstanceConfigProto InstanceName InstanceName.Builder Builder for projects/{project}/instances/{instance}.InstanceProto IsInstanceUpgradeableRequest Request for checking if a notebook instance is upgradeable.IsInstanceUpgradeableRequest.Builder Request for checking if a notebook instance is upgradeable.IsInstanceUpgradeableResponse Response for checking if a notebook instance is upgradeable.IsInstanceUpgradeableResponse.Builder Response for checking if a notebook instance is upgradeable.ListEnvironmentsRequest Request for listing environments.ListEnvironmentsRequest.Builder Request for listing environments.ListEnvironmentsResponse Response for listing environments.ListEnvironmentsResponse.Builder Response for listing environments.ListExecutionsRequest Request for listing scheduled notebook executions.ListExecutionsRequest.Builder Request for listing scheduled notebook executions.ListExecutionsResponse Response for listing scheduled notebook executionsListExecutionsResponse.Builder Response for listing scheduled notebook executionsListInstancesRequest Request for listing notebook instances.ListInstancesRequest.Builder Request for listing notebook instances.ListInstancesResponse Response for listing notebook instances.ListInstancesResponse.Builder Response for listing notebook instances.ListRuntimesRequest Request for listing Managed Notebook Runtimes.ListRuntimesRequest.Builder Request for listing Managed Notebook Runtimes.ListRuntimesResponse Response for listing Managed Notebook Runtimes.ListRuntimesResponse.Builder Response for listing Managed Notebook Runtimes.ListSchedulesRequest Request for listing scheduled notebook job.ListSchedulesRequest.Builder Request for listing scheduled notebook job.ListSchedulesResponse Response for listing scheduled notebook job.ListSchedulesResponse.Builder Response for listing scheduled notebook job.LocalDisk A Local attached disk resource.LocalDisk.Builder A Local attached disk resource.LocalDisk.RuntimeGuestOsFeature Optional.LocalDisk.RuntimeGuestOsFeature.Builder Optional.LocalDiskInitializeParams Input only.LocalDiskInitializeParams.Builder Input only.LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.ManagedNotebookServiceClient Service Description: API v1 service for Managed Notebooks.ManagedNotebookServiceClient.ListLocationsFixedSizeCollection ManagedNotebookServiceClient.ListLocationsPage ManagedNotebookServiceClient.ListLocationsPagedResponse ManagedNotebookServiceClient.ListRuntimesFixedSizeCollection ManagedNotebookServiceClient.ListRuntimesPage ManagedNotebookServiceClient.ListRuntimesPagedResponse ManagedNotebookServiceGrpc API v1 service for Managed Notebooks.ManagedNotebookServiceGrpc.ManagedNotebookServiceBlockingStub A stub to allow clients to do synchronous rpc calls to service ManagedNotebookService.ManagedNotebookServiceGrpc.ManagedNotebookServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service ManagedNotebookService.ManagedNotebookServiceGrpc.ManagedNotebookServiceImplBase Base class for the server implementation of the service ManagedNotebookService.ManagedNotebookServiceGrpc.ManagedNotebookServiceStub A stub to allow clients to do asynchronous rpc calls to service ManagedNotebookService.ManagedNotebookServiceSettings Settings class to configure an instance ofManagedNotebookServiceClient
.ManagedNotebookServiceSettings.Builder Builder for ManagedNotebookServiceSettings.ManagedNotebooksProto NotebookServiceClient Service Description: API v1 service for Cloud AI Platform Notebooks.NotebookServiceClient.ListEnvironmentsFixedSizeCollection NotebookServiceClient.ListEnvironmentsPage NotebookServiceClient.ListEnvironmentsPagedResponse NotebookServiceClient.ListExecutionsFixedSizeCollection NotebookServiceClient.ListExecutionsPage NotebookServiceClient.ListExecutionsPagedResponse NotebookServiceClient.ListInstancesFixedSizeCollection NotebookServiceClient.ListInstancesPage NotebookServiceClient.ListInstancesPagedResponse NotebookServiceClient.ListLocationsFixedSizeCollection NotebookServiceClient.ListLocationsPage NotebookServiceClient.ListLocationsPagedResponse NotebookServiceClient.ListSchedulesFixedSizeCollection NotebookServiceClient.ListSchedulesPage NotebookServiceClient.ListSchedulesPagedResponse NotebookServiceGrpc API v1 service for Cloud AI Platform Notebooks.NotebookServiceGrpc.NotebookServiceBlockingStub A stub to allow clients to do synchronous rpc calls to service NotebookService.NotebookServiceGrpc.NotebookServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service NotebookService.NotebookServiceGrpc.NotebookServiceImplBase Base class for the server implementation of the service NotebookService.NotebookServiceGrpc.NotebookServiceStub A stub to allow clients to do asynchronous rpc calls to service NotebookService.NotebookServiceSettings Settings class to configure an instance ofNotebookServiceClient
.NotebookServiceSettings.Builder Builder for NotebookServiceSettings.NotebooksProto OperationMetadata Represents the metadata of the long-running operation.OperationMetadata.Builder Represents the metadata of the long-running operation.RefreshRuntimeTokenInternalRequest Request for getting a new access token.RefreshRuntimeTokenInternalRequest.Builder Request for getting a new access token.RefreshRuntimeTokenInternalResponse Response with a new access token.RefreshRuntimeTokenInternalResponse.Builder Response with a new access token.RegisterInstanceRequest Request for registering a notebook instance.RegisterInstanceRequest.Builder Request for registering a notebook instance.ReportInstanceInfoRequest Request for notebook instances to report information to Notebooks API.ReportInstanceInfoRequest.Builder Request for notebook instances to report information to Notebooks API.ReportRuntimeEventRequest Request for reporting a Managed Notebook Event.ReportRuntimeEventRequest.Builder Request for reporting a Managed Notebook Event.ReservationAffinity Reservation Affinity for consuming Zonal reservation.ReservationAffinity.Builder Reservation Affinity for consuming Zonal reservation.ResetInstanceRequest Request for resetting a notebook instanceResetInstanceRequest.Builder Request for resetting a notebook instanceResetRuntimeRequest Request for resetting a Managed Notebook Runtime.ResetRuntimeRequest.Builder Request for resetting a Managed Notebook Runtime.RollbackInstanceRequest Request for rollbacking a notebook instanceRollbackInstanceRequest.Builder Request for rollbacking a notebook instanceRuntime The definition of a Runtime for a managed notebook instance.Runtime.Builder The definition of a Runtime for a managed notebook instance.RuntimeAcceleratorConfig Definition of the types of hardware accelerators that can be used.RuntimeAcceleratorConfig.Builder Definition of the types of hardware accelerators that can be used.RuntimeAccessConfig Specifies the login configuration for RuntimeRuntimeAccessConfig.Builder Specifies the login configuration for RuntimeRuntimeMetrics Contains runtime daemon metrics, such as OS and kernels and sessions stats.RuntimeMetrics.Builder Contains runtime daemon metrics, such as OS and kernels and sessions stats.RuntimeName RuntimeName.Builder Builder for projects/{project}/locations/{location}/runtimes/{runtime}.RuntimeProto RuntimeShieldedInstanceConfig A set of Shielded Instance options.RuntimeShieldedInstanceConfig.Builder A set of Shielded Instance options.RuntimeSoftwareConfig Specifies the selection and configuration of software inside the runtime.RuntimeSoftwareConfig.Builder Specifies the selection and configuration of software inside the runtime.Schedule The definition of a schedule.Schedule.Builder The definition of a schedule.ScheduleName ScheduleName.Builder Builder for projects/{project}/location/{location}/schedules/{schedule}.ScheduleProto SetInstanceAcceleratorRequest Request for setting instance accelerator.SetInstanceAcceleratorRequest.Builder Request for setting instance accelerator.SetInstanceLabelsRequest Request for setting instance labels.SetInstanceLabelsRequest.Builder Request for setting instance labels.SetInstanceMachineTypeRequest Request for setting instance machine type.SetInstanceMachineTypeRequest.Builder Request for setting instance machine type.StartInstanceRequest Request for starting a notebook instanceStartInstanceRequest.Builder Request for starting a notebook instanceStartRuntimeRequest Request for starting a Managed Notebook Runtime.StartRuntimeRequest.Builder Request for starting a Managed Notebook Runtime.StopInstanceRequest Request for stopping a notebook instanceStopInstanceRequest.Builder Request for stopping a notebook instanceStopRuntimeRequest Request for stopping a Managed Notebook Runtime.StopRuntimeRequest.Builder Request for stopping a Managed Notebook Runtime.SwitchRuntimeRequest Request for switching a Managed Notebook Runtime.SwitchRuntimeRequest.Builder Request for switching a Managed Notebook Runtime.TriggerScheduleRequest Request for created scheduled notebooksTriggerScheduleRequest.Builder Request for created scheduled notebooksUpdateInstanceConfigRequest Request for updating instance configurations.UpdateInstanceConfigRequest.Builder Request for updating instance configurations.UpdateInstanceMetadataItemsRequest Request for adding/changing metadata items for an instance.UpdateInstanceMetadataItemsRequest.Builder Request for adding/changing metadata items for an instance.UpdateInstanceMetadataItemsResponse Response for adding/changing metadata items for an instance.UpdateInstanceMetadataItemsResponse.Builder Response for adding/changing metadata items for an instance.UpdateRuntimeRequest Request for updating a Managed Notebook configuration.UpdateRuntimeRequest.Builder Request for updating a Managed Notebook configuration.UpdateShieldedInstanceConfigRequest Request for updating the Shielded Instance config for a notebook instance.UpdateShieldedInstanceConfigRequest.Builder Request for updating the Shielded Instance config for a notebook instance.UpgradeInstanceInternalRequest Request for upgrading a notebook instance from within the VMUpgradeInstanceInternalRequest.Builder Request for upgrading a notebook instance from within the VMUpgradeInstanceRequest Request for upgrading a notebook instanceUpgradeInstanceRequest.Builder Request for upgrading a notebook instanceUpgradeRuntimeRequest Request for upgrading a Managed Notebook Runtime to the latest version.UpgradeRuntimeRequest.Builder Request for upgrading a Managed Notebook Runtime to the latest version.VirtualMachine Runtime using Virtual Machine for computing.VirtualMachine.Builder Runtime using Virtual Machine for computing.VirtualMachineConfig The config settings for virtual machine.VirtualMachineConfig.BootImage Definition of the boot image used by the Runtime.VirtualMachineConfig.BootImage.Builder Definition of the boot image used by the Runtime.VirtualMachineConfig.Builder The config settings for virtual machine.VmImage Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.VmImage.Builder Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. -
Enum Summary Enum Description Environment.ImageTypeCase Event.EventType The definition of the event types.Execution.State Enum description of the state of the underlying AIP job.ExecutionTemplate.JobParametersCase ExecutionTemplate.JobType The backend used for this execution.ExecutionTemplate.ScaleTier Required.ExecutionTemplate.SchedulerAcceleratorType Hardware accelerator types for AI Platform Training jobs.GetInstanceHealthResponse.HealthState If an instance is healthy or not.Instance.AcceleratorType Definition of the types of hardware accelerators that can be used on this instance.Instance.DiskEncryption Definition of the disk encryption options.Instance.DiskType Possible disk types for notebook instances.Instance.EnvironmentCase Instance.NicType The type of vNIC driver.Instance.State The definition of the states of this instance.Instance.UpgradeHistoryEntry.Action The definition of operations of this upgrade history entry.Instance.UpgradeHistoryEntry.State The definition of the states of this upgrade history entry.LocalDiskInitializeParams.DiskType Possible disk types.ReservationAffinity.Type Indicates whether to consume capacity from an reservation or not.Runtime.HealthState The runtime substate.Runtime.RuntimeTypeCase Runtime.State The definition of the states of this runtime.RuntimeAcceleratorConfig.AcceleratorType Type of this accelerator.RuntimeAccessConfig.RuntimeAccessType Possible ways to access runtime.RuntimeSoftwareConfig.PostStartupScriptBehavior Behavior for the post startup script.Schedule.State State of the job.UpgradeType Definition of the types of upgrade that can be used on this instance.VirtualMachineConfig.NicType The type of vNIC driver.VmImage.ImageCase