ManagedNotebookServiceClient (Google AI Platform Notebooks 1.37.0 API)

java.lang.Object
- com.google.cloud.notebooks.v1.ManagedNotebookServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ManagedNotebookServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: API v1 service for Managed Notebooks.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


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

Methods
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. listRuntimes(ListRuntimesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRuntimes(LocationName parent) listRuntimes(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listRuntimesPagedCallable() listRuntimesCallable()
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. getRuntime(GetRuntimeRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRuntime(RuntimeName name) getRuntime(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRuntimeCallable()
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. createRuntimeAsync(CreateRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createRuntimeAsync(RuntimeName parent, String runtimeId, Runtime runtime) createRuntimeAsync(String parent, String runtimeId, Runtime runtime) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createRuntimeOperationCallable() createRuntimeCallable()
UpdateRuntime	Update Notebook Runtime configuration.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateRuntimeAsync(UpdateRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateRuntimeAsync(Runtime runtime, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateRuntimeOperationCallable() updateRuntimeCallable()
DeleteRuntime	Deletes a single Runtime.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteRuntimeAsync(DeleteRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteRuntimeAsync(RuntimeName name) deleteRuntimeAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteRuntimeOperationCallable() deleteRuntimeCallable()
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. startRuntimeAsync(StartRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. startRuntimeAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. startRuntimeOperationCallable() startRuntimeCallable()
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. stopRuntimeAsync(StopRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. stopRuntimeAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. stopRuntimeOperationCallable() stopRuntimeCallable()
SwitchRuntime	Switch a Managed Notebook Runtime.	Request object method variants only take one parameter, a request object, which must be constructed before the call. switchRuntimeAsync(SwitchRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. switchRuntimeAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. switchRuntimeOperationCallable() switchRuntimeCallable()
ResetRuntime	Resets a Managed Notebook Runtime.	Request object method variants only take one parameter, a request object, which must be constructed before the call. resetRuntimeAsync(ResetRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. resetRuntimeAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. resetRuntimeOperationCallable() resetRuntimeCallable()
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. upgradeRuntimeAsync(UpgradeRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. upgradeRuntimeAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. upgradeRuntimeOperationCallable() upgradeRuntimeCallable()
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. reportRuntimeEventAsync(ReportRuntimeEventRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. reportRuntimeEventAsync(RuntimeName name) reportRuntimeEventAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. reportRuntimeEventOperationCallable() reportRuntimeEventCallable()
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. refreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. refreshRuntimeTokenInternal(RuntimeName name, String vmId) refreshRuntimeTokenInternal(String name, String vmId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. refreshRuntimeTokenInternalCallable()
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. diagnoseRuntimeAsync(DiagnoseRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. diagnoseRuntimeAsync(RuntimeName name, DiagnosticConfig diagnosticConfig) diagnoseRuntimeAsync(String name, DiagnosticConfig diagnosticConfig) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. diagnoseRuntimeOperationCallable() diagnoseRuntimeCallable()
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. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()
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. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
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. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
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. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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 Classes
Modifier and Type	Class and Description
`static class`	`ManagedNotebookServiceClient.ListLocationsFixedSizeCollection`
`static class`	`ManagedNotebookServiceClient.ListLocationsPage`
`static class`	`ManagedNotebookServiceClient.ListLocationsPagedResponse`
`static class`	`ManagedNotebookServiceClient.ListRuntimesFixedSizeCollection`
`static class`	`ManagedNotebookServiceClient.ListRuntimesPage`
`static class`	`ManagedNotebookServiceClient.ListRuntimesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ManagedNotebookServiceClient(ManagedNotebookServiceSettings settings)` Constructs an instance of ManagedNotebookServiceClient, using the given settings.
`protected`	`ManagedNotebookServiceClient(ManagedNotebookServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ManagedNotebookServiceClient`	`create()` Constructs an instance of ManagedNotebookServiceClient with default settings.
`static ManagedNotebookServiceClient`	`create(ManagedNotebookServiceSettings settings)` Constructs an instance of ManagedNotebookServiceClient, using the given settings.
`static ManagedNotebookServiceClient`	`create(ManagedNotebookServiceStub stub)` Constructs an instance of ManagedNotebookServiceClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`createRuntimeAsync(CreateRuntimeRequest request)` Creates a new Runtime in a given project and location.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`createRuntimeAsync(RuntimeName parent, String runtimeId, Runtime runtime)` Creates a new Runtime in a given project and location.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`createRuntimeAsync(String parent, String runtimeId, Runtime runtime)` Creates a new Runtime in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<CreateRuntimeRequest,com.google.longrunning.Operation>`	`createRuntimeCallable()` Creates a new Runtime in a given project and location.
`com.google.api.gax.rpc.OperationCallable<CreateRuntimeRequest,Runtime,OperationMetadata>`	`createRuntimeOperationCallable()` Creates a new Runtime in a given project and location.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteRuntimeAsync(DeleteRuntimeRequest request)` Deletes a single Runtime.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteRuntimeAsync(RuntimeName name)` Deletes a single Runtime.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteRuntimeAsync(String name)` Deletes a single Runtime.
`com.google.api.gax.rpc.UnaryCallable<DeleteRuntimeRequest,com.google.longrunning.Operation>`	`deleteRuntimeCallable()` Deletes a single Runtime.
`com.google.api.gax.rpc.OperationCallable<DeleteRuntimeRequest,com.google.protobuf.Empty,OperationMetadata>`	`deleteRuntimeOperationCallable()` Deletes a single Runtime.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`diagnoseRuntimeAsync(DiagnoseRuntimeRequest request)` Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`diagnoseRuntimeAsync(RuntimeName name, DiagnosticConfig diagnosticConfig)` Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`diagnoseRuntimeAsync(String name, DiagnosticConfig diagnosticConfig)` Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
`com.google.api.gax.rpc.UnaryCallable<DiagnoseRuntimeRequest,com.google.longrunning.Operation>`	`diagnoseRuntimeCallable()` Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
`com.google.api.gax.rpc.OperationCallable<DiagnoseRuntimeRequest,Runtime,OperationMetadata>`	`diagnoseRuntimeOperationCallable()` Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`Runtime`	`getRuntime(GetRuntimeRequest request)` Gets details of a single Runtime.
`Runtime`	`getRuntime(RuntimeName name)` Gets details of a single Runtime.
`Runtime`	`getRuntime(String name)` Gets details of a single Runtime.
`com.google.api.gax.rpc.UnaryCallable<GetRuntimeRequest,Runtime>`	`getRuntimeCallable()` Gets details of a single Runtime.
`ManagedNotebookServiceSettings`	`getSettings()`
`ManagedNotebookServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ManagedNotebookServiceClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,ManagedNotebookServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`ManagedNotebookServiceClient.ListRuntimesPagedResponse`	`listRuntimes(ListRuntimesRequest request)` Lists Runtimes in a given project and location.
`ManagedNotebookServiceClient.ListRuntimesPagedResponse`	`listRuntimes(LocationName parent)` Lists Runtimes in a given project and location.
`ManagedNotebookServiceClient.ListRuntimesPagedResponse`	`listRuntimes(String parent)` Lists Runtimes in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListRuntimesRequest,ListRuntimesResponse>`	`listRuntimesCallable()` Lists Runtimes in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListRuntimesRequest,ManagedNotebookServiceClient.ListRuntimesPagedResponse>`	`listRuntimesPagedCallable()` Lists Runtimes in a given project and location.
`RefreshRuntimeTokenInternalResponse`	`refreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest request)` Gets an access token for the consumer service account that the customer attached to the runtime.
`RefreshRuntimeTokenInternalResponse`	`refreshRuntimeTokenInternal(RuntimeName name, String vmId)` Gets an access token for the consumer service account that the customer attached to the runtime.
`RefreshRuntimeTokenInternalResponse`	`refreshRuntimeTokenInternal(String name, String vmId)` Gets an access token for the consumer service account that the customer attached to the runtime.
`com.google.api.gax.rpc.UnaryCallable<RefreshRuntimeTokenInternalRequest,RefreshRuntimeTokenInternalResponse>`	`refreshRuntimeTokenInternalCallable()` Gets an access token for the consumer service account that the customer attached to the runtime.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`reportRuntimeEventAsync(ReportRuntimeEventRequest request)` Report and process a runtime event.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`reportRuntimeEventAsync(RuntimeName name)` Report and process a runtime event.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`reportRuntimeEventAsync(String name)` Report and process a runtime event.
`com.google.api.gax.rpc.UnaryCallable<ReportRuntimeEventRequest,com.google.longrunning.Operation>`	`reportRuntimeEventCallable()` Report and process a runtime event.
`com.google.api.gax.rpc.OperationCallable<ReportRuntimeEventRequest,Runtime,OperationMetadata>`	`reportRuntimeEventOperationCallable()` Report and process a runtime event.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`resetRuntimeAsync(ResetRuntimeRequest request)` Resets a Managed Notebook Runtime.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`resetRuntimeAsync(String name)` Resets a Managed Notebook Runtime.
`com.google.api.gax.rpc.UnaryCallable<ResetRuntimeRequest,com.google.longrunning.Operation>`	`resetRuntimeCallable()` Resets a Managed Notebook Runtime.
`com.google.api.gax.rpc.OperationCallable<ResetRuntimeRequest,Runtime,OperationMetadata>`	`resetRuntimeOperationCallable()` Resets a Managed Notebook Runtime.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`startRuntimeAsync(StartRuntimeRequest request)` Starts a Managed Notebook Runtime.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`startRuntimeAsync(String name)` Starts a Managed Notebook Runtime.
`com.google.api.gax.rpc.UnaryCallable<StartRuntimeRequest,com.google.longrunning.Operation>`	`startRuntimeCallable()` Starts a Managed Notebook Runtime.
`com.google.api.gax.rpc.OperationCallable<StartRuntimeRequest,Runtime,OperationMetadata>`	`startRuntimeOperationCallable()` Starts a Managed Notebook Runtime.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`stopRuntimeAsync(StopRuntimeRequest request)` Stops a Managed Notebook Runtime.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`stopRuntimeAsync(String name)` Stops a Managed Notebook Runtime.
`com.google.api.gax.rpc.UnaryCallable<StopRuntimeRequest,com.google.longrunning.Operation>`	`stopRuntimeCallable()` Stops a Managed Notebook Runtime.
`com.google.api.gax.rpc.OperationCallable<StopRuntimeRequest,Runtime,OperationMetadata>`	`stopRuntimeOperationCallable()` Stops a Managed Notebook Runtime.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`switchRuntimeAsync(String name)` Switch a Managed Notebook Runtime.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`switchRuntimeAsync(SwitchRuntimeRequest request)` Switch a Managed Notebook Runtime.
`com.google.api.gax.rpc.UnaryCallable<SwitchRuntimeRequest,com.google.longrunning.Operation>`	`switchRuntimeCallable()` Switch a Managed Notebook Runtime.
`com.google.api.gax.rpc.OperationCallable<SwitchRuntimeRequest,Runtime,OperationMetadata>`	`switchRuntimeOperationCallable()` Switch a Managed Notebook Runtime.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`updateRuntimeAsync(Runtime runtime, com.google.protobuf.FieldMask updateMask)` Update Notebook Runtime configuration.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`updateRuntimeAsync(UpdateRuntimeRequest request)` Update Notebook Runtime configuration.
`com.google.api.gax.rpc.UnaryCallable<UpdateRuntimeRequest,com.google.longrunning.Operation>`	`updateRuntimeCallable()` Update Notebook Runtime configuration.
`com.google.api.gax.rpc.OperationCallable<UpdateRuntimeRequest,Runtime,OperationMetadata>`	`updateRuntimeOperationCallable()` Update Notebook Runtime configuration.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`upgradeRuntimeAsync(String name)` Upgrades a Managed Notebook Runtime to the latest version.
`com.google.api.gax.longrunning.OperationFuture<Runtime,OperationMetadata>`	`upgradeRuntimeAsync(UpgradeRuntimeRequest request)` Upgrades a Managed Notebook Runtime to the latest version.
`com.google.api.gax.rpc.UnaryCallable<UpgradeRuntimeRequest,com.google.longrunning.Operation>`	`upgradeRuntimeCallable()` Upgrades a Managed Notebook Runtime to the latest version.
`com.google.api.gax.rpc.OperationCallable<UpgradeRuntimeRequest,Runtime,OperationMetadata>`	`upgradeRuntimeOperationCallable()` Upgrades a Managed Notebook Runtime to the latest version.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ManagedNotebookServiceClient
```
protected ManagedNotebookServiceClient(ManagedNotebookServiceSettings settings)
                                throws IOException
```
  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
```
protected ManagedNotebookServiceClient(ManagedNotebookServiceStub stub)
```

Method Detail

create

public static final ManagedNotebookServiceClient create()
                                                 throws IOException

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
```
public static final ManagedNotebookServiceClient create(ManagedNotebookServiceStub stub)
```
Constructs an instance of ManagedNotebookServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ManagedNotebookServiceSettings).

getSettings

public final ManagedNotebookServiceSettings getSettings()

getStub

public ManagedNotebookServiceStub getStub()

getOperationsClient
```
public final com.google.longrunning.OperationsClient 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:: com.google.api.gax.rpc.ApiException - if the remote call fails

listRuntimes

public final ManagedNotebookServiceClient.ListRuntimesPagedResponse listRuntimes(String 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()) {
   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:: com.google.api.gax.rpc.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:: com.google.api.gax.rpc.ApiException - if the remote call fails

listRuntimesPagedCallable

public final com.google.api.gax.rpc.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

public final com.google.api.gax.rpc.UnaryCallable<ListRuntimesRequest,ListRuntimesResponse> 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

public final Runtime getRuntime(RuntimeName name)

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:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRuntime

public final Runtime getRuntime(String name)

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:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRuntime

public final Runtime getRuntime(GetRuntimeRequest request)

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:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRuntimeCallable

public final com.google.api.gax.rpc.UnaryCallable<GetRuntimeRequest,Runtime> 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();
 }