Class ManagedNotebookServiceClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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 (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().
| Method | Description | Method Variants |
|---|---|---|
ListRuntimes |
Lists Runtimes in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetRuntime |
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateRuntime |
Creates a new Runtime in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateRuntime |
Update Notebook Runtime configuration. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteRuntime |
Deletes a single Runtime. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
StartRuntime |
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 |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
StopRuntime |
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 |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SwitchRuntime |
Switch a Managed Notebook Runtime. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ResetRuntime |
Resets a Managed Notebook Runtime. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpgradeRuntime |
Upgrades a Managed Notebook Runtime to the latest version. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ReportRuntimeEvent |
Report and process a runtime event. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RefreshRuntimeTokenInternal |
Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DiagnoseRuntime |
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy |
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
TestIamPermissions |
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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:
// 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
ManagedNotebookServiceSettings managedNotebookServiceSettings =
ManagedNotebookServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ManagedNotebookServiceClient managedNotebookServiceClient =
ManagedNotebookServiceClient.create(managedNotebookServiceSettings);
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
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructs an instance of ManagedNotebookServiceClient, using the given settings.protected -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final voidclose()static final ManagedNotebookServiceClientcreate()Constructs an instance of ManagedNotebookServiceClient with default settings.static final ManagedNotebookServiceClientcreate(ManagedNotebookServiceSettings settings) Constructs an instance of ManagedNotebookServiceClient, using the given settings.static final ManagedNotebookServiceClientConstructs an instance of ManagedNotebookServiceClient, using the given stub for making calls.createRuntimeAsync(CreateRuntimeRequest request) Creates a new Runtime in a given project and location.createRuntimeAsync(RuntimeName parent, String runtimeId, Runtime runtime) Creates a new Runtime in a given project and location.createRuntimeAsync(String parent, String runtimeId, Runtime runtime) Creates a new Runtime in a given project and location.Creates a new Runtime in a given project and location.Creates a new Runtime in a given project and location.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteRuntimeAsync(DeleteRuntimeRequest request) Deletes a single Runtime.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Deletes a single Runtime.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteRuntimeAsync(String name) Deletes a single Runtime.Deletes a single Runtime.final OperationCallable<DeleteRuntimeRequest,com.google.protobuf.Empty, OperationMetadata> Deletes a single Runtime.Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.diagnoseRuntimeAsync(RuntimeName name, DiagnosticConfig diagnosticConfig) Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.diagnoseRuntimeAsync(String name, DiagnosticConfig diagnosticConfig) Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.final PolicygetIamPolicy(GetIamPolicyRequest request) Gets the access control policy for a resource.Gets the access control policy for a resource.final LocationgetLocation(GetLocationRequest request) Gets information about a location.Gets information about a location.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final RuntimegetRuntime(GetRuntimeRequest request) Gets details of a single Runtime.final RuntimegetRuntime(RuntimeName name) Gets details of a single Runtime.final RuntimegetRuntime(String name) Gets details of a single Runtime.Gets details of a single Runtime.getStub()booleanbooleanlistLocations(ListLocationsRequest request) Lists information about the supported locations for this service.Lists information about the supported locations for this service.Lists information about the supported locations for this service.listRuntimes(ListRuntimesRequest request) Lists Runtimes in a given project and location.listRuntimes(LocationName parent) Lists Runtimes in a given project and location.listRuntimes(String parent) Lists Runtimes in a given project and location.Lists Runtimes in a given project and location.Lists Runtimes in a given project and location.Gets an access token for the consumer service account that the customer attached to the runtime.refreshRuntimeTokenInternal(RuntimeName name, String vmId) Gets an access token for the consumer service account that the customer attached to the runtime.refreshRuntimeTokenInternal(String name, String vmId) Gets an access token for the consumer service account that the customer attached to the runtime.Gets an access token for the consumer service account that the customer attached to the runtime.Report and process a runtime event.Report and process a runtime event.Report and process a runtime event.Report and process a runtime event.Report and process a runtime event.resetRuntimeAsync(ResetRuntimeRequest request) Resets a Managed Notebook Runtime.resetRuntimeAsync(String name) Resets a Managed Notebook Runtime.Resets a Managed Notebook Runtime.Resets a Managed Notebook Runtime.final PolicysetIamPolicy(SetIamPolicyRequest request) Sets the access control policy on the specified resource.Sets the access control policy on the specified resource.voidshutdown()voidstartRuntimeAsync(StartRuntimeRequest request) Starts a Managed Notebook Runtime.startRuntimeAsync(String name) Starts a Managed Notebook Runtime.Starts a Managed Notebook Runtime.Starts a Managed Notebook Runtime.stopRuntimeAsync(StopRuntimeRequest request) Stops a Managed Notebook Runtime.stopRuntimeAsync(String name) Stops a Managed Notebook Runtime.Stops a Managed Notebook Runtime.Stops a Managed Notebook Runtime.switchRuntimeAsync(SwitchRuntimeRequest request) Switch a Managed Notebook Runtime.switchRuntimeAsync(String name) Switch a Managed Notebook Runtime.Switch a Managed Notebook Runtime.Switch a Managed Notebook Runtime.Returns permissions that a caller has on the specified resource.Returns permissions that a caller has on the specified resource.updateRuntimeAsync(Runtime runtime, com.google.protobuf.FieldMask updateMask) Update Notebook Runtime configuration.updateRuntimeAsync(UpdateRuntimeRequest request) Update Notebook Runtime configuration.Update Notebook Runtime configuration.Update Notebook Runtime configuration.upgradeRuntimeAsync(UpgradeRuntimeRequest request) Upgrades a Managed Notebook Runtime to the latest version.upgradeRuntimeAsync(String name) Upgrades a Managed Notebook Runtime to the latest version.Upgrades a Managed Notebook Runtime to the latest version.Upgrades a Managed Notebook Runtime to the latest version.
-
Constructor Details
-
ManagedNotebookServiceClient
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.- Throws:
IOException
-
ManagedNotebookServiceClient
-
-
Method Details
-
create
Constructs an instance of ManagedNotebookServiceClient with default settings.- Throws:
IOException
-
create
public static final ManagedNotebookServiceClient create(ManagedNotebookServiceSettings settings) throws IOException 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.- Throws:
IOException
-
create
Constructs an instance of ManagedNotebookServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ManagedNotebookServiceSettings). -
getSettings
-
getStub
-
getOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
listRuntimes
public final ManagedNotebookServiceClient.ListRuntimesPagedResponse listRuntimes(LocationName parent) Lists Runtimes in a given project and location.Sample code:
// 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()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (Runtime element : managedNotebookServiceClient.listRuntimes(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. Format: `parent=projects/{project_id}/locations/{location}`- Throws:
ApiException- if the remote call fails
-
listRuntimes
Lists Runtimes in a given project and location.Sample code:
// 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()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (Runtime element : managedNotebookServiceClient.listRuntimes(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. Format: `parent=projects/{project_id}/locations/{location}`- Throws:
ApiException- if the remote call fails
-
listRuntimes
public final ManagedNotebookServiceClient.ListRuntimesPagedResponse listRuntimes(ListRuntimesRequest request) Lists Runtimes in a given project and location.Sample code:
// 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()) { ListRuntimesRequest request = ListRuntimesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Runtime element : managedNotebookServiceClient.listRuntimes(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listRuntimesPagedCallable
public final UnaryCallable<ListRuntimesRequest,ManagedNotebookServiceClient.ListRuntimesPagedResponse> listRuntimesPagedCallable()Lists Runtimes in a given project and location.Sample code:
// 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()) { 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); } } -
listRuntimesCallable
Lists Runtimes in a given project and location.Sample code:
// 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()) { 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.getRuntimesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getRuntime
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.Sample code:
// 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); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
getRuntime
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.Sample code:
// 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()) { String name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString(); Runtime response = managedNotebookServiceClient.getRuntime(name); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
getRuntime
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.Sample code:
// 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()) { GetRuntimeRequest request = GetRuntimeRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .build(); Runtime response = managedNotebookServiceClient.getRuntime(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getRuntimeCallable
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.Sample code:
// 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()) { 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(); } -
createRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> createRuntimeAsync(RuntimeName parent, String runtimeId, Runtime runtime) Creates a new Runtime in a given project and location.Sample code:
// 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 parent = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]"); String runtimeId = "runtimeId121455379"; Runtime runtime = Runtime.newBuilder().build(); Runtime response = managedNotebookServiceClient.createRuntimeAsync(parent, runtimeId, runtime).get(); }- Parameters:
parent- Required. Format: `parent=projects/{project_id}/locations/{location}`runtimeId- Required. User-defined unique ID of this Runtime.runtime- Required. The Runtime to be created.- Throws:
ApiException- if the remote call fails
-
createRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> createRuntimeAsync(String parent, String runtimeId, Runtime runtime) Creates a new Runtime in a given project and location.Sample code:
// 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()) { 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:
parent- Required. Format: `parent=projects/{project_id}/locations/{location}`runtimeId- Required. User-defined unique ID of this Runtime.runtime- Required. The Runtime to be created.- Throws:
ApiException- if the remote call fails
-
createRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> createRuntimeAsync(CreateRuntimeRequest request) Creates a new Runtime in a given project and location.Sample code:
// 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()) { CreateRuntimeRequest request = CreateRuntimeRequest.newBuilder() .setParent(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setRuntimeId("runtimeId121455379") .setRuntime(Runtime.newBuilder().build()) .setRequestId("requestId693933066") .build(); Runtime response = managedNotebookServiceClient.createRuntimeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createRuntimeOperationCallable
public final OperationCallable<CreateRuntimeRequest,Runtime, createRuntimeOperationCallable()OperationMetadata> Creates a new Runtime in a given project and location.Sample code:
// 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()) { CreateRuntimeRequest request = CreateRuntimeRequest.newBuilder() .setParent(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setRuntimeId("runtimeId121455379") .setRuntime(Runtime.newBuilder().build()) .setRequestId("requestId693933066") .build(); OperationFuture<Runtime, OperationMetadata> future = managedNotebookServiceClient.createRuntimeOperationCallable().futureCall(request); // Do something. Runtime response = future.get(); } -
createRuntimeCallable
Creates a new Runtime in a given project and location.Sample code:
// 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()) { CreateRuntimeRequest request = CreateRuntimeRequest.newBuilder() .setParent(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setRuntimeId("runtimeId121455379") .setRuntime(Runtime.newBuilder().build()) .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = managedNotebookServiceClient.createRuntimeCallable().futureCall(request); // Do something. Operation response = future.get(); } -
updateRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> updateRuntimeAsync(Runtime runtime, com.google.protobuf.FieldMask updateMask) Update Notebook Runtime configuration.Sample code:
// 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()) { Runtime runtime = Runtime.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Runtime response = managedNotebookServiceClient.updateRuntimeAsync(runtime, updateMask).get(); }- Parameters:
runtime- Required. The Runtime to be updated.updateMask- Required. Specifies the path, relative to `Runtime`, of the field to update. For example, to change the software configuration kernels, the `update_mask` parameter would be specified as `software_config.kernels`, and the `PATCH` request body would specify the new value, as follows:{ "software_config":{ "kernels": [{ 'repository': 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': 'latest' }], } }
Currently, only the following fields can be updated: - `software_config.kernels` - `software_config.post_startup_script` - `software_config.custom_gpu_driver_path` - `software_config.idle_shutdown` - `software_config.idle_shutdown_timeout` - `software_config.disable_terminal`
- Throws:
ApiException- if the remote call fails
-
updateRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> updateRuntimeAsync(UpdateRuntimeRequest request) Update Notebook Runtime configuration.Sample code:
// 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()) { UpdateRuntimeRequest request = UpdateRuntimeRequest.newBuilder() .setRuntime(Runtime.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .setRequestId("requestId693933066") .build(); Runtime response = managedNotebookServiceClient.updateRuntimeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateRuntimeOperationCallable
public final OperationCallable<UpdateRuntimeRequest,Runtime, updateRuntimeOperationCallable()OperationMetadata> Update Notebook Runtime configuration.Sample code:
// 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()) { UpdateRuntimeRequest request = UpdateRuntimeRequest.newBuilder() .setRuntime(Runtime.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .setRequestId("requestId693933066") .build(); OperationFuture<Runtime, OperationMetadata> future = managedNotebookServiceClient.updateRuntimeOperationCallable().futureCall(request); // Do something. Runtime response = future.get(); } -
updateRuntimeCallable
Update Notebook Runtime configuration.Sample code:
// 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()) { UpdateRuntimeRequest request = UpdateRuntimeRequest.newBuilder() .setRuntime(Runtime.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = managedNotebookServiceClient.updateRuntimeCallable().futureCall(request); // Do something. Operation response = future.get(); } -
deleteRuntimeAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteRuntimeAsync(RuntimeName name) Deletes a single Runtime.Sample code:
// 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]"); managedNotebookServiceClient.deleteRuntimeAsync(name).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
deleteRuntimeAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteRuntimeAsync(String name) Deletes a single Runtime.Sample code:
// 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()) { String name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString(); managedNotebookServiceClient.deleteRuntimeAsync(name).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
deleteRuntimeAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteRuntimeAsync(DeleteRuntimeRequest request) Deletes a single Runtime.Sample code:
// 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()) { DeleteRuntimeRequest request = DeleteRuntimeRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setRequestId("requestId693933066") .build(); managedNotebookServiceClient.deleteRuntimeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteRuntimeOperationCallable
public final OperationCallable<DeleteRuntimeRequest,com.google.protobuf.Empty, deleteRuntimeOperationCallable()OperationMetadata> Deletes a single Runtime.Sample code:
// 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()) { DeleteRuntimeRequest request = DeleteRuntimeRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setRequestId("requestId693933066") .build(); OperationFuture<Empty, OperationMetadata> future = managedNotebookServiceClient.deleteRuntimeOperationCallable().futureCall(request); // Do something. future.get(); } -
deleteRuntimeCallable
Deletes a single Runtime.Sample code:
// 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()) { DeleteRuntimeRequest request = DeleteRuntimeRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = managedNotebookServiceClient.deleteRuntimeCallable().futureCall(request); // Do something. future.get(); } -
startRuntimeAsync
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-instanceSample code:
// 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()) { String name = "name3373707"; Runtime response = managedNotebookServiceClient.startRuntimeAsync(name).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
startRuntimeAsync
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-instanceSample code:
// 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()) { StartRuntimeRequest request = StartRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); Runtime response = managedNotebookServiceClient.startRuntimeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
startRuntimeOperationCallable
public final OperationCallable<StartRuntimeRequest,Runtime, startRuntimeOperationCallable()OperationMetadata> 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-instanceSample code:
// 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()) { StartRuntimeRequest request = StartRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); OperationFuture<Runtime, OperationMetadata> future = managedNotebookServiceClient.startRuntimeOperationCallable().futureCall(request); // Do something. Runtime response = future.get(); } -
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-instanceSample code:
// 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()) { StartRuntimeRequest request = StartRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = managedNotebookServiceClient.startRuntimeCallable().futureCall(request); // Do something. Operation response = future.get(); } -
stopRuntimeAsync
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-instanceSample code:
// 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()) { String name = "name3373707"; Runtime response = managedNotebookServiceClient.stopRuntimeAsync(name).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
stopRuntimeAsync
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-instanceSample code:
// 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()) { StopRuntimeRequest request = StopRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); Runtime response = managedNotebookServiceClient.stopRuntimeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
stopRuntimeOperationCallable
public final OperationCallable<StopRuntimeRequest,Runtime, stopRuntimeOperationCallable()OperationMetadata> 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-instanceSample code:
// 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()) { StopRuntimeRequest request = StopRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); OperationFuture<Runtime, OperationMetadata> future = managedNotebookServiceClient.stopRuntimeOperationCallable().futureCall(request); // Do something. Runtime response = future.get(); } -
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-instanceSample code:
// 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()) { StopRuntimeRequest request = StopRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = managedNotebookServiceClient.stopRuntimeCallable().futureCall(request); // Do something. Operation response = future.get(); } -
switchRuntimeAsync
Switch a Managed Notebook Runtime.Sample code:
// 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()) { String name = "name3373707"; Runtime response = managedNotebookServiceClient.switchRuntimeAsync(name).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
switchRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> switchRuntimeAsync(SwitchRuntimeRequest request) Switch a Managed Notebook Runtime.Sample code:
// 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()) { SwitchRuntimeRequest request = SwitchRuntimeRequest.newBuilder() .setName("name3373707") .setMachineType("machineType-218117087") .setAcceleratorConfig(RuntimeAcceleratorConfig.newBuilder().build()) .setRequestId("requestId693933066") .build(); Runtime response = managedNotebookServiceClient.switchRuntimeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
switchRuntimeOperationCallable
public final OperationCallable<SwitchRuntimeRequest,Runtime, switchRuntimeOperationCallable()OperationMetadata> Switch a Managed Notebook Runtime.Sample code:
// 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()) { SwitchRuntimeRequest request = SwitchRuntimeRequest.newBuilder() .setName("name3373707") .setMachineType("machineType-218117087") .setAcceleratorConfig(RuntimeAcceleratorConfig.newBuilder().build()) .setRequestId("requestId693933066") .build(); OperationFuture<Runtime, OperationMetadata> future = managedNotebookServiceClient.switchRuntimeOperationCallable().futureCall(request); // Do something. Runtime response = future.get(); } -
switchRuntimeCallable
Switch a Managed Notebook Runtime.Sample code:
// 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()) { SwitchRuntimeRequest request = SwitchRuntimeRequest.newBuilder() .setName("name3373707") .setMachineType("machineType-218117087") .setAcceleratorConfig(RuntimeAcceleratorConfig.newBuilder().build()) .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = managedNotebookServiceClient.switchRuntimeCallable().futureCall(request); // Do something. Operation response = future.get(); } -
resetRuntimeAsync
Resets a Managed Notebook Runtime.Sample code:
// 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()) { String name = "name3373707"; Runtime response = managedNotebookServiceClient.resetRuntimeAsync(name).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
resetRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> resetRuntimeAsync(ResetRuntimeRequest request) Resets a Managed Notebook Runtime.Sample code:
// 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()) { ResetRuntimeRequest request = ResetRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); Runtime response = managedNotebookServiceClient.resetRuntimeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
resetRuntimeOperationCallable
public final OperationCallable<ResetRuntimeRequest,Runtime, resetRuntimeOperationCallable()OperationMetadata> Resets a Managed Notebook Runtime.Sample code:
// 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()) { ResetRuntimeRequest request = ResetRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); OperationFuture<Runtime, OperationMetadata> future = managedNotebookServiceClient.resetRuntimeOperationCallable().futureCall(request); // Do something. Runtime response = future.get(); } -
resetRuntimeCallable
Resets a Managed Notebook Runtime.Sample code:
// 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()) { ResetRuntimeRequest request = ResetRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = managedNotebookServiceClient.resetRuntimeCallable().futureCall(request); // Do something. Operation response = future.get(); } -
upgradeRuntimeAsync
Upgrades a Managed Notebook Runtime to the latest version.Sample code:
// 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()) { String name = "name3373707"; Runtime response = managedNotebookServiceClient.upgradeRuntimeAsync(name).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
upgradeRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> upgradeRuntimeAsync(UpgradeRuntimeRequest request) Upgrades a Managed Notebook Runtime to the latest version.Sample code:
// 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()) { UpgradeRuntimeRequest request = UpgradeRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); Runtime response = managedNotebookServiceClient.upgradeRuntimeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
upgradeRuntimeOperationCallable
public final OperationCallable<UpgradeRuntimeRequest,Runtime, upgradeRuntimeOperationCallable()OperationMetadata> Upgrades a Managed Notebook Runtime to the latest version.Sample code:
// 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()) { UpgradeRuntimeRequest request = UpgradeRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); OperationFuture<Runtime, OperationMetadata> future = managedNotebookServiceClient.upgradeRuntimeOperationCallable().futureCall(request); // Do something. Runtime response = future.get(); } -
upgradeRuntimeCallable
Upgrades a Managed Notebook Runtime to the latest version.Sample code:
// 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()) { UpgradeRuntimeRequest request = UpgradeRuntimeRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = managedNotebookServiceClient.upgradeRuntimeCallable().futureCall(request); // Do something. Operation response = future.get(); } -
reportRuntimeEventAsync
Report and process a runtime event.Sample code:
// 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.reportRuntimeEventAsync(name).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
reportRuntimeEventAsync
Report and process a runtime event.Sample code:
// 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()) { String name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString(); Runtime response = managedNotebookServiceClient.reportRuntimeEventAsync(name).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`- Throws:
ApiException- if the remote call fails
-
reportRuntimeEventAsync
public final OperationFuture<Runtime,OperationMetadata> reportRuntimeEventAsync(ReportRuntimeEventRequest request) Report and process a runtime event.Sample code:
// 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()) { ReportRuntimeEventRequest request = ReportRuntimeEventRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setVmId("vmId3622450") .setEvent(Event.newBuilder().build()) .build(); Runtime response = managedNotebookServiceClient.reportRuntimeEventAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
reportRuntimeEventOperationCallable
public final OperationCallable<ReportRuntimeEventRequest,Runtime, reportRuntimeEventOperationCallable()OperationMetadata> Report and process a runtime event.Sample code:
// 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()) { ReportRuntimeEventRequest request = ReportRuntimeEventRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setVmId("vmId3622450") .setEvent(Event.newBuilder().build()) .build(); OperationFuture<Runtime, OperationMetadata> future = managedNotebookServiceClient.reportRuntimeEventOperationCallable().futureCall(request); // Do something. Runtime response = future.get(); } -
reportRuntimeEventCallable
Report and process a runtime event.Sample code:
// 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()) { 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(); } -
refreshRuntimeTokenInternal
public final RefreshRuntimeTokenInternalResponse refreshRuntimeTokenInternal(RuntimeName name, String vmId) Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.Sample code:
// 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]"); String vmId = "vmId3622450"; RefreshRuntimeTokenInternalResponse response = managedNotebookServiceClient.refreshRuntimeTokenInternal(name, vmId); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`vmId- Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity- Throws:
ApiException- if the remote call fails
-
refreshRuntimeTokenInternal
public final RefreshRuntimeTokenInternalResponse refreshRuntimeTokenInternal(String name, String vmId) Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.Sample code:
// 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()) { String name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString(); String vmId = "vmId3622450"; RefreshRuntimeTokenInternalResponse response = managedNotebookServiceClient.refreshRuntimeTokenInternal(name, vmId); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`vmId- Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity- Throws:
ApiException- if the remote call fails
-
refreshRuntimeTokenInternal
public final RefreshRuntimeTokenInternalResponse refreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest request) Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.Sample code:
// 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()) { RefreshRuntimeTokenInternalRequest request = RefreshRuntimeTokenInternalRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setVmId("vmId3622450") .build(); RefreshRuntimeTokenInternalResponse response = managedNotebookServiceClient.refreshRuntimeTokenInternal(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
refreshRuntimeTokenInternalCallable
public final UnaryCallable<RefreshRuntimeTokenInternalRequest,RefreshRuntimeTokenInternalResponse> refreshRuntimeTokenInternalCallable()Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.Sample code:
// 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()) { RefreshRuntimeTokenInternalRequest request = RefreshRuntimeTokenInternalRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setVmId("vmId3622450") .build(); ApiFuture<RefreshRuntimeTokenInternalResponse> future = managedNotebookServiceClient.refreshRuntimeTokenInternalCallable().futureCall(request); // Do something. RefreshRuntimeTokenInternalResponse response = future.get(); } -
diagnoseRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> diagnoseRuntimeAsync(RuntimeName name, DiagnosticConfig diagnosticConfig) Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.Sample code:
// 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]"); DiagnosticConfig diagnosticConfig = DiagnosticConfig.newBuilder().build(); Runtime response = managedNotebookServiceClient.diagnoseRuntimeAsync(name, diagnosticConfig).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`diagnosticConfig- Required. Defines flags that are used to run the diagnostic tool- Throws:
ApiException- if the remote call fails
-
diagnoseRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> diagnoseRuntimeAsync(String name, DiagnosticConfig diagnosticConfig) Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.Sample code:
// 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()) { String name = RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString(); DiagnosticConfig diagnosticConfig = DiagnosticConfig.newBuilder().build(); Runtime response = managedNotebookServiceClient.diagnoseRuntimeAsync(name, diagnosticConfig).get(); }- Parameters:
name- Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`diagnosticConfig- Required. Defines flags that are used to run the diagnostic tool- Throws:
ApiException- if the remote call fails
-
diagnoseRuntimeAsync
public final OperationFuture<Runtime,OperationMetadata> diagnoseRuntimeAsync(DiagnoseRuntimeRequest request) Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.Sample code:
// 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()) { DiagnoseRuntimeRequest request = DiagnoseRuntimeRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setDiagnosticConfig(DiagnosticConfig.newBuilder().build()) .build(); Runtime response = managedNotebookServiceClient.diagnoseRuntimeAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
diagnoseRuntimeOperationCallable
public final OperationCallable<DiagnoseRuntimeRequest,Runtime, diagnoseRuntimeOperationCallable()OperationMetadata> Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.Sample code:
// 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()) { DiagnoseRuntimeRequest request = DiagnoseRuntimeRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setDiagnosticConfig(DiagnosticConfig.newBuilder().build()) .build(); OperationFuture<Runtime, OperationMetadata> future = managedNotebookServiceClient.diagnoseRuntimeOperationCallable().futureCall(request); // Do something. Runtime response = future.get(); } -
diagnoseRuntimeCallable
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.Sample code:
// 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()) { DiagnoseRuntimeRequest request = DiagnoseRuntimeRequest.newBuilder() .setName(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setDiagnosticConfig(DiagnosticConfig.newBuilder().build()) .build(); ApiFuture<Operation> future = managedNotebookServiceClient.diagnoseRuntimeCallable().futureCall(request); // Do something. Operation response = future.get(); } -
listLocations
public final ManagedNotebookServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request) Lists information about the supported locations for this service.Sample code:
// 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()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Location element : managedNotebookServiceClient.listLocations(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listLocationsPagedCallable
public final UnaryCallable<ListLocationsRequest,ManagedNotebookServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()Lists information about the supported locations for this service.Sample code:
// 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()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Location> future = managedNotebookServiceClient.listLocationsPagedCallable().futureCall(request); // Do something. for (Location element : future.get().iterateAll()) { // doThingsWith(element); } } -
listLocationsCallable
Lists information about the supported locations for this service.Sample code:
// 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()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListLocationsResponse response = managedNotebookServiceClient.listLocationsCallable().call(request); for (Location element : response.getLocationsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getLocation
Gets information about a location.Sample code:
// 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()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); Location response = managedNotebookServiceClient.getLocation(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getLocationCallable
Gets information about a location.Sample code:
// 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()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); ApiFuture<Location> future = managedNotebookServiceClient.getLocationCallable().futureCall(request); // Do something. Location response = future.get(); } -
setIamPolicy
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
Sample code:
// 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()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Policy response = managedNotebookServiceClient.setIamPolicy(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
setIamPolicyCallable
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
Sample code:
// 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()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Policy> future = managedNotebookServiceClient.setIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); } -
getIamPolicy
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.Sample code:
// 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()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); Policy response = managedNotebookServiceClient.getIamPolicy(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getIamPolicyCallable
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.Sample code:
// 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()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); ApiFuture<Policy> future = managedNotebookServiceClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); } -
testIamPermissions
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// 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()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); TestIamPermissionsResponse response = managedNotebookServiceClient.testIamPermissions(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
testIamPermissionsCallable
public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// 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()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(RuntimeName.of("[PROJECT]", "[LOCATION]", "[RUNTIME]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); ApiFuture<TestIamPermissionsResponse> future = managedNotebookServiceClient.testIamPermissionsCallable().futureCall(request); // Do something. TestIamPermissionsResponse response = future.get(); } -
close
public final void close()- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-