NotebookServiceClient (Google AI Platform Notebooks 1.30.0 API)

java.lang.Object
- com.google.cloud.notebooks.v2.NotebookServiceClient

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

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

Service Description: API v2 service for Workbench Notebooks Instances.

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = notebookServiceClient.getInstance(name);
 }

Note: close() needs to be called on the NotebookServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of NotebookServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 NotebookServiceSettings notebookServiceSettings =
     NotebookServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NotebookServiceClient notebookServiceClient =
     NotebookServiceClient.create(notebookServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 NotebookServiceSettings notebookServiceSettings =
     NotebookServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 NotebookServiceClient notebookServiceClient =
     NotebookServiceClient.create(notebookServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 NotebookServiceSettings notebookServiceSettings =
     NotebookServiceSettings.newHttpJsonBuilder().build();
 NotebookServiceClient notebookServiceClient =
     NotebookServiceClient.create(notebookServiceSettings);

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`	`NotebookServiceClient.ListInstancesFixedSizeCollection`
`static class`	`NotebookServiceClient.ListInstancesPage`
`static class`	`NotebookServiceClient.ListInstancesPagedResponse`
`static class`	`NotebookServiceClient.ListLocationsFixedSizeCollection`
`static class`	`NotebookServiceClient.ListLocationsPage`
`static class`	`NotebookServiceClient.ListLocationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`NotebookServiceClient(NotebookServiceSettings settings)` Constructs an instance of NotebookServiceClient, using the given settings.
`protected`	`NotebookServiceClient(NotebookServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`CheckInstanceUpgradabilityResponse`	`checkInstanceUpgradability(CheckInstanceUpgradabilityRequest request)` Checks whether a notebook instance is upgradable.
`com.google.api.gax.rpc.UnaryCallable<CheckInstanceUpgradabilityRequest,CheckInstanceUpgradabilityResponse>`	`checkInstanceUpgradabilityCallable()` Checks whether a notebook instance is upgradable.
`void`	`close()`
`static NotebookServiceClient`	`create()` Constructs an instance of NotebookServiceClient with default settings.
`static NotebookServiceClient`	`create(NotebookServiceSettings settings)` Constructs an instance of NotebookServiceClient, using the given settings.
`static NotebookServiceClient`	`create(NotebookServiceStub stub)` Constructs an instance of NotebookServiceClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`createInstanceAsync(CreateInstanceRequest request)` Creates a new Instance in a given project and location.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`createInstanceAsync(LocationName parent, Instance instance, String instanceId)` Creates a new Instance in a given project and location.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`createInstanceAsync(String parent, Instance instance, String instanceId)` Creates a new Instance in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<CreateInstanceRequest,com.google.longrunning.Operation>`	`createInstanceCallable()` Creates a new Instance in a given project and location.
`com.google.api.gax.rpc.OperationCallable<CreateInstanceRequest,Instance,OperationMetadata>`	`createInstanceOperationCallable()` Creates a new Instance in a given project and location.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteInstanceAsync(DeleteInstanceRequest request)` Deletes a single Instance.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteInstanceAsync(InstanceName name)` Deletes a single Instance.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteInstanceAsync(String name)` Deletes a single Instance.
`com.google.api.gax.rpc.UnaryCallable<DeleteInstanceRequest,com.google.longrunning.Operation>`	`deleteInstanceCallable()` Deletes a single Instance.
`com.google.api.gax.rpc.OperationCallable<DeleteInstanceRequest,com.google.protobuf.Empty,OperationMetadata>`	`deleteInstanceOperationCallable()` Deletes a single Instance.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`diagnoseInstanceAsync(DiagnoseInstanceRequest request)` Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`diagnoseInstanceAsync(InstanceName name, DiagnosticConfig diagnosticConfig)` Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`diagnoseInstanceAsync(String name, DiagnosticConfig diagnosticConfig)` Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
`com.google.api.gax.rpc.UnaryCallable<DiagnoseInstanceRequest,com.google.longrunning.Operation>`	`diagnoseInstanceCallable()` Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
`com.google.api.gax.rpc.OperationCallable<DiagnoseInstanceRequest,Instance,OperationMetadata>`	`diagnoseInstanceOperationCallable()` Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`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.
`Instance`	`getInstance(GetInstanceRequest request)` Gets details of a single Instance.
`Instance`	`getInstance(InstanceName name)` Gets details of a single Instance.
`Instance`	`getInstance(String name)` Gets details of a single Instance.
`com.google.api.gax.rpc.UnaryCallable<GetInstanceRequest,Instance>`	`getInstanceCallable()` Gets details of a single Instance.
`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.
`NotebookServiceSettings`	`getSettings()`
`NotebookServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`NotebookServiceClient.ListInstancesPagedResponse`	`listInstances(ListInstancesRequest request)` Lists instances in a given project and location.
`NotebookServiceClient.ListInstancesPagedResponse`	`listInstances(LocationName parent)` Lists instances in a given project and location.
`NotebookServiceClient.ListInstancesPagedResponse`	`listInstances(String parent)` Lists instances in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListInstancesRequest,ListInstancesResponse>`	`listInstancesCallable()` Lists instances in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListInstancesRequest,NotebookServiceClient.ListInstancesPagedResponse>`	`listInstancesPagedCallable()` Lists instances in a given project and location.
`NotebookServiceClient.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,NotebookServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`resetInstanceAsync(ResetInstanceRequest request)` Resets a notebook instance.
`com.google.api.gax.rpc.UnaryCallable<ResetInstanceRequest,com.google.longrunning.Operation>`	`resetInstanceCallable()` Resets a notebook instance.
`com.google.api.gax.rpc.OperationCallable<ResetInstanceRequest,Instance,OperationMetadata>`	`resetInstanceOperationCallable()` Resets a notebook instance.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`rollbackInstanceAsync(RollbackInstanceRequest request)` Rollbacks a notebook instance to the previous version.
`com.google.api.gax.rpc.UnaryCallable<RollbackInstanceRequest,com.google.longrunning.Operation>`	`rollbackInstanceCallable()` Rollbacks a notebook instance to the previous version.
`com.google.api.gax.rpc.OperationCallable<RollbackInstanceRequest,Instance,OperationMetadata>`	`rollbackInstanceOperationCallable()` Rollbacks a notebook instance to the previous version.
`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<Instance,OperationMetadata>`	`startInstanceAsync(StartInstanceRequest request)` Starts a notebook instance.
`com.google.api.gax.rpc.UnaryCallable<StartInstanceRequest,com.google.longrunning.Operation>`	`startInstanceCallable()` Starts a notebook instance.
`com.google.api.gax.rpc.OperationCallable<StartInstanceRequest,Instance,OperationMetadata>`	`startInstanceOperationCallable()` Starts a notebook instance.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`stopInstanceAsync(StopInstanceRequest request)` Stops a notebook instance.
`com.google.api.gax.rpc.UnaryCallable<StopInstanceRequest,com.google.longrunning.Operation>`	`stopInstanceCallable()` Stops a notebook instance.
`com.google.api.gax.rpc.OperationCallable<StopInstanceRequest,Instance,OperationMetadata>`	`stopInstanceOperationCallable()` Stops a notebook instance.
`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<Instance,OperationMetadata>`	`updateInstanceAsync(Instance instance, com.google.protobuf.FieldMask updateMask)` UpdateInstance updates an Instance.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`updateInstanceAsync(UpdateInstanceRequest request)` UpdateInstance updates an Instance.
`com.google.api.gax.rpc.UnaryCallable<UpdateInstanceRequest,com.google.longrunning.Operation>`	`updateInstanceCallable()` UpdateInstance updates an Instance.
`com.google.api.gax.rpc.OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata>`	`updateInstanceOperationCallable()` UpdateInstance updates an Instance.
`com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>`	`upgradeInstanceAsync(UpgradeInstanceRequest request)` Upgrades a notebook instance to the latest version.
`com.google.api.gax.rpc.UnaryCallable<UpgradeInstanceRequest,com.google.longrunning.Operation>`	`upgradeInstanceCallable()` Upgrades a notebook instance to the latest version.
`com.google.api.gax.rpc.OperationCallable<UpgradeInstanceRequest,Instance,OperationMetadata>`	`upgradeInstanceOperationCallable()` Upgrades a notebook instance to the latest version.

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

Constructor Detail
- NotebookServiceClient
```
protected NotebookServiceClient(NotebookServiceSettings settings)
                         throws IOException
```
  Constructs an instance of NotebookServiceClient, 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
- NotebookServiceClient
```
protected NotebookServiceClient(NotebookServiceStub stub)
```

Method Detail

create

public static final NotebookServiceClient create()
                                          throws IOException

Constructs an instance of NotebookServiceClient with default settings.

Throws:: IOException

create
```
public static final NotebookServiceClient create(NotebookServiceSettings settings)
                                          throws IOException
```
Constructs an instance of NotebookServiceClient, 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 NotebookServiceClient create(NotebookServiceStub stub)
```
Constructs an instance of NotebookServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(NotebookServiceSettings).

getSettings

public final NotebookServiceSettings getSettings()

getStub
```
public NotebookServiceStub 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.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

listInstances

public final NotebookServiceClient.ListInstancesPagedResponse listInstances(LocationName parent)

Lists instances 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Instance element : notebookServiceClient.listInstances(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

listInstances

public final NotebookServiceClient.ListInstancesPagedResponse listInstances(String parent)

Lists instances 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Instance element : notebookServiceClient.listInstances(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

listInstances

public final NotebookServiceClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request)

Lists instances 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (Instance element : notebookServiceClient.listInstances(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

listInstancesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListInstancesRequest,NotebookServiceClient.ListInstancesPagedResponse> listInstancesPagedCallable()

Lists instances 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Instance> future =
       notebookServiceClient.listInstancesPagedCallable().futureCall(request);
   // Do something.
   for (Instance element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listInstancesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()

Lists instances 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListInstancesResponse response =
         notebookServiceClient.listInstancesCallable().call(request);
     for (Instance element : response.getInstancesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getInstance

public final Instance getInstance(InstanceName name)

Gets details of a single 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = notebookServiceClient.getInstance(name);
 }

Parameters:: name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getInstance

public final Instance getInstance(String name)

Gets details of a single 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Instance response = notebookServiceClient.getInstance(name);
 }

Parameters:: name - Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getInstance

public final Instance getInstance(GetInstanceRequest request)

Gets details of a single 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = notebookServiceClient.getInstance(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

getInstanceCallable

public final com.google.api.gax.rpc.UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()

Gets details of a single 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Instance> future = notebookServiceClient.getInstanceCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }