Class ManagedNotebookServiceClient

public class ManagedNotebookServiceClient implements BackgroundResource

Service Description: API v1 service for Managed 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:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   RuntimeName name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]");
   Runtime response = managedNotebookServiceClient.getRuntime(name);
 }
 

Note: close() needs to be called on the ManagedNotebookServiceClient 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 ManagedNotebookServiceSettings to create(). For example:

To customize credentials:


 ManagedNotebookServiceSettings managedNotebookServiceSettings =
     ManagedNotebookServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create(managedNotebookServiceSettings);
 

To customize the endpoint:


 ManagedNotebookServiceSettings managedNotebookServiceSettings =
     ManagedNotebookServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create(managedNotebookServiceSettings);
 

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

Inheritance

java.lang.Object > ManagedNotebookServiceClient

Implements

BackgroundResource

Constructors

ManagedNotebookServiceClient(ManagedNotebookServiceSettings settings)

protected ManagedNotebookServiceClient(ManagedNotebookServiceSettings settings)

Constructs an instance of ManagedNotebookServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
NameDescription
settingsManagedNotebookServiceSettings

ManagedNotebookServiceClient(ManagedNotebookServiceStub stub)

protected ManagedNotebookServiceClient(ManagedNotebookServiceStub stub)
Parameter
NameDescription
stubManagedNotebookServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

create()

public static final ManagedNotebookServiceClient create()

Constructs an instance of ManagedNotebookServiceClient with default settings.

Returns
TypeDescription
ManagedNotebookServiceClient
Exceptions
TypeDescription
IOException

create(ManagedNotebookServiceSettings settings)

public static final ManagedNotebookServiceClient create(ManagedNotebookServiceSettings settings)

Constructs an instance of ManagedNotebookServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsManagedNotebookServiceSettings
Returns
TypeDescription
ManagedNotebookServiceClient
Exceptions
TypeDescription
IOException

create(ManagedNotebookServiceStub stub)

public static final ManagedNotebookServiceClient create(ManagedNotebookServiceStub stub)

Constructs an instance of ManagedNotebookServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ManagedNotebookServiceSettings).

Parameter
NameDescription
stubManagedNotebookServiceStub
Returns
TypeDescription
ManagedNotebookServiceClient

createRuntimeAsync(CreateRuntimeRequest request)

public final OperationFuture<Runtime,OperationMetadata> createRuntimeAsync(CreateRuntimeRequest request)

Creates a new Runtime in a given project and location.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   CreateRuntimeRequest request =
       CreateRuntimeRequest.newBuilder()
           .setParent(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .setRuntimeId("runtimeId121455379")
           .setRuntime(Runtime.newBuilder().build())
           .build();
   Runtime response = managedNotebookServiceClient.createRuntimeAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateRuntimeRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

createRuntimeAsync(RuntimeName parent, String runtimeId, Runtime runtime)

public final OperationFuture<Runtime,OperationMetadata> createRuntimeAsync(RuntimeName parent, String runtimeId, Runtime runtime)

Creates a new Runtime in a given project and location.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   RuntimeName parent = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]");
   String runtimeId = "runtimeId121455379";
   Runtime runtime = Runtime.newBuilder().build();
   Runtime response =
       managedNotebookServiceClient.createRuntimeAsync(parent, runtimeId, runtime).get();
 }
 
Parameters
NameDescription
parentRuntimeName

Required. Format: parent=projects/{project_id}/locations/{location}

runtimeIdString

Required. User-defined unique ID of this Runtime.

runtimeRuntime

Required. The Runtime to be created.

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

createRuntimeAsync(String parent, String runtimeId, Runtime runtime)

public final OperationFuture<Runtime,OperationMetadata> createRuntimeAsync(String parent, String runtimeId, Runtime runtime)

Creates a new Runtime in a given project and location.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   String parent = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString();
   String runtimeId = "runtimeId121455379";
   Runtime runtime = Runtime.newBuilder().build();
   Runtime response =
       managedNotebookServiceClient.createRuntimeAsync(parent, runtimeId, runtime).get();
 }
 
Parameters
NameDescription
parentString

Required. Format: parent=projects/{project_id}/locations/{location}

runtimeIdString

Required. User-defined unique ID of this Runtime.

runtimeRuntime

Required. The Runtime to be created.

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

createRuntimeCallable()

public final UnaryCallable<CreateRuntimeRequest,Operation> createRuntimeCallable()

Creates a new Runtime in a given project and location.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   CreateRuntimeRequest request =
       CreateRuntimeRequest.newBuilder()
           .setParent(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .setRuntimeId("runtimeId121455379")
           .setRuntime(Runtime.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       managedNotebookServiceClient.createRuntimeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateRuntimeRequest,Operation>

createRuntimeOperationCallable()

public final OperationCallable<CreateRuntimeRequest,Runtime,OperationMetadata> createRuntimeOperationCallable()

Creates a new Runtime in a given project and location.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   CreateRuntimeRequest request =
       CreateRuntimeRequest.newBuilder()
           .setParent(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .setRuntimeId("runtimeId121455379")
           .setRuntime(Runtime.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<CreateRuntimeRequest,Runtime,OperationMetadata>

deleteRuntimeAsync(DeleteRuntimeRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteRuntimeAsync(DeleteRuntimeRequest request)

Deletes a single Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   DeleteRuntimeRequest request =
       DeleteRuntimeRequest.newBuilder()
           .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .build();
   managedNotebookServiceClient.deleteRuntimeAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteRuntimeRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteRuntimeAsync(RuntimeName name)

public final OperationFuture<Empty,OperationMetadata> deleteRuntimeAsync(RuntimeName name)

Deletes a single Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   RuntimeName name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]");
   managedNotebookServiceClient.deleteRuntimeAsync(name).get();
 }
 
Parameter
NameDescription
nameRuntimeName

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteRuntimeAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteRuntimeAsync(String name)

Deletes a single Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   String name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString();
   managedNotebookServiceClient.deleteRuntimeAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteRuntimeCallable()

public final UnaryCallable<DeleteRuntimeRequest,Operation> deleteRuntimeCallable()

Deletes a single Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   DeleteRuntimeRequest request =
       DeleteRuntimeRequest.newBuilder()
           .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .build();
   ApiFuture<Operation> future =
       managedNotebookServiceClient.deleteRuntimeCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteRuntimeRequest,Operation>

deleteRuntimeOperationCallable()

public final OperationCallable<DeleteRuntimeRequest,Empty,OperationMetadata> deleteRuntimeOperationCallable()

Deletes a single Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   DeleteRuntimeRequest request =
       DeleteRuntimeRequest.newBuilder()
           .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<DeleteRuntimeRequest,Empty,OperationMetadata>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getRuntime(GetRuntimeRequest request)

public final Runtime getRuntime(GetRuntimeRequest request)

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   GetRuntimeRequest request =
       GetRuntimeRequest.newBuilder()
           .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .build();
   Runtime response = managedNotebookServiceClient.getRuntime(request);
 }
 
Parameter
NameDescription
requestGetRuntimeRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Runtime

getRuntime(RuntimeName name)

public final Runtime getRuntime(RuntimeName name)

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   RuntimeName name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]");
   Runtime response = managedNotebookServiceClient.getRuntime(name);
 }
 
Parameter
NameDescription
nameRuntimeName

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns
TypeDescription
Runtime

getRuntime(String name)

public final Runtime getRuntime(String name)

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   String name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString();
   Runtime response = managedNotebookServiceClient.getRuntime(name);
 }
 
Parameter
NameDescription
nameString

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns
TypeDescription
Runtime

getRuntimeCallable()

public final UnaryCallable<GetRuntimeRequest,Runtime> getRuntimeCallable()

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   GetRuntimeRequest request =
       GetRuntimeRequest.newBuilder()
           .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .build();
   ApiFuture<Runtime> future =
       managedNotebookServiceClient.getRuntimeCallable().futureCall(request);
   // Do something.
   Runtime response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetRuntimeRequest,Runtime>

getSettings()

public final ManagedNotebookServiceSettings getSettings()
Returns
TypeDescription
ManagedNotebookServiceSettings

getStub()

public ManagedNotebookServiceStub getStub()
Returns
TypeDescription
ManagedNotebookServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listRuntimes(ListRuntimesRequest request)

public final ManagedNotebookServiceClient.ListRuntimesPagedResponse listRuntimes(ListRuntimesRequest request)

Lists Runtimes in a given project and location.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   ListRuntimesRequest request =
       ListRuntimesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Runtime element : managedNotebookServiceClient.listRuntimes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListRuntimesRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
ManagedNotebookServiceClient.ListRuntimesPagedResponse

listRuntimes(LocationName parent)

public final ManagedNotebookServiceClient.ListRuntimesPagedResponse listRuntimes(LocationName parent)

Lists Runtimes in a given project and location.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Runtime element : managedNotebookServiceClient.listRuntimes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. Format: parent=projects/{project_id}/locations/{location}

Returns
TypeDescription
ManagedNotebookServiceClient.ListRuntimesPagedResponse

listRuntimes(String parent)

public final ManagedNotebookServiceClient.ListRuntimesPagedResponse listRuntimes(String parent)

Lists Runtimes in a given project and location.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Runtime element : managedNotebookServiceClient.listRuntimes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. Format: parent=projects/{project_id}/locations/{location}

Returns
TypeDescription
ManagedNotebookServiceClient.ListRuntimesPagedResponse

listRuntimesCallable()

public final UnaryCallable<ListRuntimesRequest,ListRuntimesResponse> listRuntimesCallable()

Lists Runtimes in a given project and location.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   ListRuntimesRequest request =
       ListRuntimesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRuntimesResponse response =
         managedNotebookServiceClient.listRuntimesCallable().call(request);
     for (Runtime element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListRuntimesRequest,ListRuntimesResponse>

listRuntimesPagedCallable()

public final UnaryCallable<ListRuntimesRequest,ManagedNotebookServiceClient.ListRuntimesPagedResponse> listRuntimesPagedCallable()

Lists Runtimes in a given project and location.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   ListRuntimesRequest request =
       ListRuntimesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Runtime> future =
       managedNotebookServiceClient.listRuntimesPagedCallable().futureCall(request);
   // Do something.
   for (Runtime element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListRuntimesRequest,ListRuntimesPagedResponse>

reportRuntimeEventAsync(ReportRuntimeEventRequest request)

public final OperationFuture<Runtime,OperationMetadata> reportRuntimeEventAsync(ReportRuntimeEventRequest request)

Report and process a runtime event.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   ReportRuntimeEventRequest request =
       ReportRuntimeEventRequest.newBuilder()
           .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .setVmId("vmId3622450")
           .setEvent(Event.newBuilder().build())
           .build();
   Runtime response = managedNotebookServiceClient.reportRuntimeEventAsync(request).get();
 }
 
Parameter
NameDescription
requestReportRuntimeEventRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

reportRuntimeEventAsync(RuntimeName name)

public final OperationFuture<Runtime,OperationMetadata> reportRuntimeEventAsync(RuntimeName name)

Report and process a runtime event.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   RuntimeName name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]");
   Runtime response = managedNotebookServiceClient.reportRuntimeEventAsync(name).get();
 }
 
Parameter
NameDescription
nameRuntimeName

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

reportRuntimeEventAsync(String name)

public final OperationFuture<Runtime,OperationMetadata> reportRuntimeEventAsync(String name)

Report and process a runtime event.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   String name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString();
   Runtime response = managedNotebookServiceClient.reportRuntimeEventAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

reportRuntimeEventCallable()

public final UnaryCallable<ReportRuntimeEventRequest,Operation> reportRuntimeEventCallable()

Report and process a runtime event.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   ReportRuntimeEventRequest request =
       ReportRuntimeEventRequest.newBuilder()
           .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .setVmId("vmId3622450")
           .setEvent(Event.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       managedNotebookServiceClient.reportRuntimeEventCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ReportRuntimeEventRequest,Operation>

reportRuntimeEventOperationCallable()

public final OperationCallable<ReportRuntimeEventRequest,Runtime,OperationMetadata> reportRuntimeEventOperationCallable()

Report and process a runtime event.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   ReportRuntimeEventRequest request =
       ReportRuntimeEventRequest.newBuilder()
           .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString())
           .setVmId("vmId3622450")
           .setEvent(Event.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<ReportRuntimeEventRequest,Runtime,OperationMetadata>

resetRuntimeAsync(ResetRuntimeRequest request)

public final OperationFuture<Runtime,OperationMetadata> resetRuntimeAsync(ResetRuntimeRequest request)

Resets a Managed Notebook Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   ResetRuntimeRequest request = ResetRuntimeRequest.newBuilder().setName("name3373707").build();
   Runtime response = managedNotebookServiceClient.resetRuntimeAsync(request).get();
 }
 
Parameter
NameDescription
requestResetRuntimeRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

resetRuntimeAsync(String name)

public final OperationFuture<Runtime,OperationMetadata> resetRuntimeAsync(String name)

Resets a Managed Notebook Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   String name = "name3373707";
   Runtime response = managedNotebookServiceClient.resetRuntimeAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

resetRuntimeCallable()

public final UnaryCallable<ResetRuntimeRequest,Operation> resetRuntimeCallable()

Resets a Managed Notebook Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   ResetRuntimeRequest request = ResetRuntimeRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Operation> future =
       managedNotebookServiceClient.resetRuntimeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ResetRuntimeRequest,Operation>

resetRuntimeOperationCallable()

public final OperationCallable<ResetRuntimeRequest,Runtime,OperationMetadata> resetRuntimeOperationCallable()

Resets a Managed Notebook Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   ResetRuntimeRequest request = ResetRuntimeRequest.newBuilder().setName("name3373707").build();
   OperationFuture
Returns
TypeDescription
OperationCallable<ResetRuntimeRequest,Runtime,OperationMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

startRuntimeAsync(StartRuntimeRequest request)

public final OperationFuture<Runtime,OperationMetadata> startRuntimeAsync(StartRuntimeRequest request)

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   StartRuntimeRequest request = StartRuntimeRequest.newBuilder().setName("name3373707").build();
   Runtime response = managedNotebookServiceClient.startRuntimeAsync(request).get();
 }
 
Parameter
NameDescription
requestStartRuntimeRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

startRuntimeAsync(String name)

public final OperationFuture<Runtime,OperationMetadata> startRuntimeAsync(String name)

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   String name = "name3373707";
   Runtime response = managedNotebookServiceClient.startRuntimeAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

startRuntimeCallable()

public final UnaryCallable<StartRuntimeRequest,Operation> startRuntimeCallable()

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   StartRuntimeRequest request = StartRuntimeRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Operation> future =
       managedNotebookServiceClient.startRuntimeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<StartRuntimeRequest,Operation>

startRuntimeOperationCallable()

public final OperationCallable<StartRuntimeRequest,Runtime,OperationMetadata> startRuntimeOperationCallable()

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   StartRuntimeRequest request = StartRuntimeRequest.newBuilder().setName("name3373707").build();
   OperationFuture
Returns
TypeDescription
OperationCallable<StartRuntimeRequest,Runtime,OperationMetadata>

stopRuntimeAsync(StopRuntimeRequest request)

public final OperationFuture<Runtime,OperationMetadata> stopRuntimeAsync(StopRuntimeRequest request)

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   StopRuntimeRequest request = StopRuntimeRequest.newBuilder().setName("name3373707").build();
   Runtime response = managedNotebookServiceClient.stopRuntimeAsync(request).get();
 }
 
Parameter
NameDescription
requestStopRuntimeRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

stopRuntimeAsync(String name)

public final OperationFuture<Runtime,OperationMetadata> stopRuntimeAsync(String name)

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   String name = "name3373707";
   Runtime response = managedNotebookServiceClient.stopRuntimeAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

stopRuntimeCallable()

public final UnaryCallable<StopRuntimeRequest,Operation> stopRuntimeCallable()

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   StopRuntimeRequest request = StopRuntimeRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Operation> future =
       managedNotebookServiceClient.stopRuntimeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<StopRuntimeRequest,Operation>

stopRuntimeOperationCallable()

public final OperationCallable<StopRuntimeRequest,Runtime,OperationMetadata> stopRuntimeOperationCallable()

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   StopRuntimeRequest request = StopRuntimeRequest.newBuilder().setName("name3373707").build();
   OperationFuture
Returns
TypeDescription
OperationCallable<StopRuntimeRequest,Runtime,OperationMetadata>

switchRuntimeAsync(SwitchRuntimeRequest request)

public final OperationFuture<Runtime,OperationMetadata> switchRuntimeAsync(SwitchRuntimeRequest request)

Switch a Managed Notebook Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   SwitchRuntimeRequest request =
       SwitchRuntimeRequest.newBuilder()
           .setName("name3373707")
           .setMachineType("machineType-218117087")
           .setAcceleratorConfig(RuntimeAcceleratorConfig.newBuilder().build())
           .build();
   Runtime response = managedNotebookServiceClient.switchRuntimeAsync(request).get();
 }
 
Parameter
NameDescription
requestSwitchRuntimeRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

switchRuntimeAsync(String name)

public final OperationFuture<Runtime,OperationMetadata> switchRuntimeAsync(String name)

Switch a Managed Notebook Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   String name = "name3373707";
   Runtime response = managedNotebookServiceClient.switchRuntimeAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Returns
TypeDescription
OperationFuture<Runtime,OperationMetadata>

switchRuntimeCallable()

public final UnaryCallable<SwitchRuntimeRequest,Operation> switchRuntimeCallable()

Switch a Managed Notebook Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   SwitchRuntimeRequest request =
       SwitchRuntimeRequest.newBuilder()
           .setName("name3373707")
           .setMachineType("machineType-218117087")
           .setAcceleratorConfig(RuntimeAcceleratorConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       managedNotebookServiceClient.switchRuntimeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<SwitchRuntimeRequest,Operation>

switchRuntimeOperationCallable()

public final OperationCallable<SwitchRuntimeRequest,Runtime,OperationMetadata> switchRuntimeOperationCallable()

Switch a Managed Notebook Runtime.

Sample code:


 try (ManagedNotebookServiceClient managedNotebookServiceClient =
     ManagedNotebookServiceClient.create()) {
   SwitchRuntimeRequest request =
       SwitchRuntimeRequest.newBuilder()
           .setName("name3373707")
           .setMachineType("machineType-218117087")
           .setAcceleratorConfig(RuntimeAcceleratorConfig.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<SwitchRuntimeRequest,Runtime,OperationMetadata>