Class NotebookServiceClient

java.lang.Object
com.google.cloud.notebooks.v1beta1.NotebookServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable

@BetaApi @Generated("by gapic-generator-java") public class NotebookServiceClient extends Object implements BackgroundResource
Service Description: API v1beta1 service for Cloud AI Platform 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
   GetInstanceRequest request = GetInstanceRequest.newBuilder().setName("name3373707").build();
   Instance response = notebookServiceClient.getInstance(request);
 }
 

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

Methods
Method Description Method Variants

ListInstances

Lists instances in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listInstances(ListInstancesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listInstancesPagedCallable()

  • listInstancesCallable()

GetInstance

Gets details of a single Instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getInstance(GetInstanceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getInstanceCallable()

CreateInstance

Creates a new Instance in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createInstanceAsync(CreateInstanceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createInstanceOperationCallable()

  • createInstanceCallable()

RegisterInstance

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • registerInstanceAsync(RegisterInstanceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • registerInstanceOperationCallable()

  • registerInstanceCallable()

SetInstanceAccelerator

Updates the guest accelerators of a single Instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setInstanceAcceleratorAsync(SetInstanceAcceleratorRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setInstanceAcceleratorOperationCallable()

  • setInstanceAcceleratorCallable()

SetInstanceMachineType

Updates the machine type of a single Instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setInstanceMachineTypeAsync(SetInstanceMachineTypeRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setInstanceMachineTypeOperationCallable()

  • setInstanceMachineTypeCallable()

SetInstanceLabels

Updates the labels of an Instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setInstanceLabelsAsync(SetInstanceLabelsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setInstanceLabelsOperationCallable()

  • setInstanceLabelsCallable()

DeleteInstance

Deletes a single Instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteInstanceAsync(DeleteInstanceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteInstanceOperationCallable()

  • deleteInstanceCallable()

StartInstance

Starts a notebook instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • startInstanceAsync(StartInstanceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • startInstanceOperationCallable()

  • startInstanceCallable()

StopInstance

Stops a notebook instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • stopInstanceAsync(StopInstanceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • stopInstanceOperationCallable()

  • stopInstanceCallable()

ResetInstance

Resets a notebook instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resetInstanceAsync(ResetInstanceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resetInstanceOperationCallable()

  • resetInstanceCallable()

ReportInstanceInfo

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • reportInstanceInfoAsync(ReportInstanceInfoRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • reportInstanceInfoOperationCallable()

  • reportInstanceInfoCallable()

IsInstanceUpgradeable

Check if a notebook instance is upgradable. Deprecated. Please consider using v1.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • isInstanceUpgradeable(IsInstanceUpgradeableRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • isInstanceUpgradeableCallable()

UpgradeInstance

Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • upgradeInstanceAsync(UpgradeInstanceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • upgradeInstanceOperationCallable()

  • upgradeInstanceCallable()

UpgradeInstanceInternal

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly. Deprecated. Please consider using v1.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • upgradeInstanceInternalAsync(UpgradeInstanceInternalRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • upgradeInstanceInternalOperationCallable()

  • upgradeInstanceInternalCallable()

ListEnvironments

Lists environments in a project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEnvironments(ListEnvironmentsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listEnvironmentsPagedCallable()

  • listEnvironmentsCallable()

GetEnvironment

Gets details of a single Environment.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEnvironment(GetEnvironmentRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEnvironmentCallable()

CreateEnvironment

Creates a new Environment.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEnvironmentAsync(CreateEnvironmentRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEnvironmentOperationCallable()

  • createEnvironmentCallable()

DeleteEnvironment

Deletes a single Environment.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEnvironmentAsync(DeleteEnvironmentRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteEnvironmentOperationCallable()

  • deleteEnvironmentCallable()

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 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);
 

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

  • Constructor Details

    • 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 Details

    • 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 OperationsClient getOperationsClient()
      Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
    • listInstances

      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("parent-995424086")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .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:
      ApiException - if the remote call fails
    • 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("parent-995424086")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         ApiFuture<Instance> future =
             notebookServiceClient.listInstancesPagedCallable().futureCall(request);
         // Do something.
         for (Instance element : future.get().iterateAll()) {
           // doThingsWith(element);
         }
       }
       
    • listInstancesCallable

      public final 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("parent-995424086")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .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(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("name3373707").build();
         Instance response = notebookServiceClient.getInstance(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • getInstanceCallable

      public final 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("name3373707").build();
         ApiFuture<Instance> future = notebookServiceClient.getInstanceCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • createInstanceAsync

      public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(CreateInstanceRequest request)
      Creates a new Instance 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()) {
         CreateInstanceRequest request =
             CreateInstanceRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setInstanceId("instanceId902024336")
                 .setInstance(Instance.newBuilder().build())
                 .build();
         Instance response = notebookServiceClient.createInstanceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • createInstanceOperationCallable

      public final OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationCallable()
      Creates a new Instance 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()) {
         CreateInstanceRequest request =
             CreateInstanceRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setInstanceId("instanceId902024336")
                 .setInstance(Instance.newBuilder().build())
                 .build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.createInstanceOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • createInstanceCallable

      public final UnaryCallable<CreateInstanceRequest,Operation> createInstanceCallable()
      Creates a new Instance 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()) {
         CreateInstanceRequest request =
             CreateInstanceRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setInstanceId("instanceId902024336")
                 .setInstance(Instance.newBuilder().build())
                 .build();
         ApiFuture<Operation> future =
             notebookServiceClient.createInstanceCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • registerInstanceAsync

      public final OperationFuture<Instance,OperationMetadata> registerInstanceAsync(RegisterInstanceRequest request)
      Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

      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()) {
         RegisterInstanceRequest request =
             RegisterInstanceRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setInstanceId("instanceId902024336")
                 .build();
         Instance response = notebookServiceClient.registerInstanceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • registerInstanceOperationCallable

      public final OperationCallable<RegisterInstanceRequest,Instance,OperationMetadata> registerInstanceOperationCallable()
      Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

      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()) {
         RegisterInstanceRequest request =
             RegisterInstanceRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setInstanceId("instanceId902024336")
                 .build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.registerInstanceOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • registerInstanceCallable

      public final UnaryCallable<RegisterInstanceRequest,Operation> registerInstanceCallable()
      Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

      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()) {
         RegisterInstanceRequest request =
             RegisterInstanceRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setInstanceId("instanceId902024336")
                 .build();
         ApiFuture<Operation> future =
             notebookServiceClient.registerInstanceCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • setInstanceAcceleratorAsync

      public final OperationFuture<Instance,OperationMetadata> setInstanceAcceleratorAsync(SetInstanceAcceleratorRequest request)
      Updates the guest accelerators 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()) {
         SetInstanceAcceleratorRequest request =
             SetInstanceAcceleratorRequest.newBuilder()
                 .setName("name3373707")
                 .setCoreCount(-1963855761)
                 .build();
         Instance response = notebookServiceClient.setInstanceAcceleratorAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • setInstanceAcceleratorOperationCallable

      public final OperationCallable<SetInstanceAcceleratorRequest,Instance,OperationMetadata> setInstanceAcceleratorOperationCallable()
      Updates the guest accelerators 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()) {
         SetInstanceAcceleratorRequest request =
             SetInstanceAcceleratorRequest.newBuilder()
                 .setName("name3373707")
                 .setCoreCount(-1963855761)
                 .build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.setInstanceAcceleratorOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • setInstanceAcceleratorCallable

      public final UnaryCallable<SetInstanceAcceleratorRequest,Operation> setInstanceAcceleratorCallable()
      Updates the guest accelerators 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()) {
         SetInstanceAcceleratorRequest request =
             SetInstanceAcceleratorRequest.newBuilder()
                 .setName("name3373707")
                 .setCoreCount(-1963855761)
                 .build();
         ApiFuture<Operation> future =
             notebookServiceClient.setInstanceAcceleratorCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • setInstanceMachineTypeAsync

      public final OperationFuture<Instance,OperationMetadata> setInstanceMachineTypeAsync(SetInstanceMachineTypeRequest request)
      Updates the machine type 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()) {
         SetInstanceMachineTypeRequest request =
             SetInstanceMachineTypeRequest.newBuilder()
                 .setName("name3373707")
                 .setMachineType("machineType-218117087")
                 .build();
         Instance response = notebookServiceClient.setInstanceMachineTypeAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • setInstanceMachineTypeOperationCallable

      public final OperationCallable<SetInstanceMachineTypeRequest,Instance,OperationMetadata> setInstanceMachineTypeOperationCallable()
      Updates the machine type 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()) {
         SetInstanceMachineTypeRequest request =
             SetInstanceMachineTypeRequest.newBuilder()
                 .setName("name3373707")
                 .setMachineType("machineType-218117087")
                 .build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.setInstanceMachineTypeOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • setInstanceMachineTypeCallable

      public final UnaryCallable<SetInstanceMachineTypeRequest,Operation> setInstanceMachineTypeCallable()
      Updates the machine type 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()) {
         SetInstanceMachineTypeRequest request =
             SetInstanceMachineTypeRequest.newBuilder()
                 .setName("name3373707")
                 .setMachineType("machineType-218117087")
                 .build();
         ApiFuture<Operation> future =
             notebookServiceClient.setInstanceMachineTypeCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • setInstanceLabelsAsync

      public final OperationFuture<Instance,OperationMetadata> setInstanceLabelsAsync(SetInstanceLabelsRequest request)
      Updates the labels of an 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()) {
         SetInstanceLabelsRequest request =
             SetInstanceLabelsRequest.newBuilder()
                 .setName("name3373707")
                 .putAllLabels(new HashMap<String, String>())
                 .build();
         Instance response = notebookServiceClient.setInstanceLabelsAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • setInstanceLabelsOperationCallable

      public final OperationCallable<SetInstanceLabelsRequest,Instance,OperationMetadata> setInstanceLabelsOperationCallable()
      Updates the labels of an 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()) {
         SetInstanceLabelsRequest request =
             SetInstanceLabelsRequest.newBuilder()
                 .setName("name3373707")
                 .putAllLabels(new HashMap<String, String>())
                 .build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.setInstanceLabelsOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • setInstanceLabelsCallable

      public final UnaryCallable<SetInstanceLabelsRequest,Operation> setInstanceLabelsCallable()
      Updates the labels of an 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()) {
         SetInstanceLabelsRequest request =
             SetInstanceLabelsRequest.newBuilder()
                 .setName("name3373707")
                 .putAllLabels(new HashMap<String, String>())
                 .build();
         ApiFuture<Operation> future =
             notebookServiceClient.setInstanceLabelsCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • deleteInstanceAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInstanceAsync(DeleteInstanceRequest request)
      Deletes 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()) {
         DeleteInstanceRequest request =
             DeleteInstanceRequest.newBuilder().setName("name3373707").build();
         notebookServiceClient.deleteInstanceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • deleteInstanceOperationCallable

      public final OperationCallable<DeleteInstanceRequest,com.google.protobuf.Empty,OperationMetadata> deleteInstanceOperationCallable()
      Deletes 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()) {
         DeleteInstanceRequest request =
             DeleteInstanceRequest.newBuilder().setName("name3373707").build();
         OperationFuture<Empty, OperationMetadata> future =
             notebookServiceClient.deleteInstanceOperationCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • deleteInstanceCallable

      public final UnaryCallable<DeleteInstanceRequest,Operation> deleteInstanceCallable()
      Deletes 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()) {
         DeleteInstanceRequest request =
             DeleteInstanceRequest.newBuilder().setName("name3373707").build();
         ApiFuture<Operation> future =
             notebookServiceClient.deleteInstanceCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • startInstanceAsync

      public final OperationFuture<Instance,OperationMetadata> startInstanceAsync(StartInstanceRequest request)
      Starts a notebook 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()) {
         StartInstanceRequest request =
             StartInstanceRequest.newBuilder().setName("name3373707").build();
         Instance response = notebookServiceClient.startInstanceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • startInstanceOperationCallable

      public final OperationCallable<StartInstanceRequest,Instance,OperationMetadata> startInstanceOperationCallable()
      Starts a notebook 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()) {
         StartInstanceRequest request =
             StartInstanceRequest.newBuilder().setName("name3373707").build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.startInstanceOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • startInstanceCallable

      public final UnaryCallable<StartInstanceRequest,Operation> startInstanceCallable()
      Starts a notebook 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()) {
         StartInstanceRequest request =
             StartInstanceRequest.newBuilder().setName("name3373707").build();
         ApiFuture<Operation> future =
             notebookServiceClient.startInstanceCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • stopInstanceAsync

      public final OperationFuture<Instance,OperationMetadata> stopInstanceAsync(StopInstanceRequest request)
      Stops a notebook 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()) {
         StopInstanceRequest request = StopInstanceRequest.newBuilder().setName("name3373707").build();
         Instance response = notebookServiceClient.stopInstanceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • stopInstanceOperationCallable

      public final OperationCallable<StopInstanceRequest,Instance,OperationMetadata> stopInstanceOperationCallable()
      Stops a notebook 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()) {
         StopInstanceRequest request = StopInstanceRequest.newBuilder().setName("name3373707").build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.stopInstanceOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • stopInstanceCallable

      public final UnaryCallable<StopInstanceRequest,Operation> stopInstanceCallable()
      Stops a notebook 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()) {
         StopInstanceRequest request = StopInstanceRequest.newBuilder().setName("name3373707").build();
         ApiFuture<Operation> future =
             notebookServiceClient.stopInstanceCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • resetInstanceAsync

      public final OperationFuture<Instance,OperationMetadata> resetInstanceAsync(ResetInstanceRequest request)
      Resets a notebook 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()) {
         ResetInstanceRequest request =
             ResetInstanceRequest.newBuilder().setName("name3373707").build();
         Instance response = notebookServiceClient.resetInstanceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • resetInstanceOperationCallable

      public final OperationCallable<ResetInstanceRequest,Instance,OperationMetadata> resetInstanceOperationCallable()
      Resets a notebook 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()) {
         ResetInstanceRequest request =
             ResetInstanceRequest.newBuilder().setName("name3373707").build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.resetInstanceOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • resetInstanceCallable

      public final UnaryCallable<ResetInstanceRequest,Operation> resetInstanceCallable()
      Resets a notebook 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()) {
         ResetInstanceRequest request =
             ResetInstanceRequest.newBuilder().setName("name3373707").build();
         ApiFuture<Operation> future =
             notebookServiceClient.resetInstanceCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • reportInstanceInfoAsync

      public final OperationFuture<Instance,OperationMetadata> reportInstanceInfoAsync(ReportInstanceInfoRequest request)
      Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

      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()) {
         ReportInstanceInfoRequest request =
             ReportInstanceInfoRequest.newBuilder()
                 .setName("name3373707")
                 .setVmId("vmId3622450")
                 .putAllMetadata(new HashMap<String, String>())
                 .build();
         Instance response = notebookServiceClient.reportInstanceInfoAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • reportInstanceInfoOperationCallable

      public final OperationCallable<ReportInstanceInfoRequest,Instance,OperationMetadata> reportInstanceInfoOperationCallable()
      Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

      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()) {
         ReportInstanceInfoRequest request =
             ReportInstanceInfoRequest.newBuilder()
                 .setName("name3373707")
                 .setVmId("vmId3622450")
                 .putAllMetadata(new HashMap<String, String>())
                 .build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.reportInstanceInfoOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • reportInstanceInfoCallable

      public final UnaryCallable<ReportInstanceInfoRequest,Operation> reportInstanceInfoCallable()
      Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

      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()) {
         ReportInstanceInfoRequest request =
             ReportInstanceInfoRequest.newBuilder()
                 .setName("name3373707")
                 .setVmId("vmId3622450")
                 .putAllMetadata(new HashMap<String, String>())
                 .build();
         ApiFuture<Operation> future =
             notebookServiceClient.reportInstanceInfoCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • isInstanceUpgradeable

      @Deprecated public final IsInstanceUpgradeableResponse isInstanceUpgradeable(IsInstanceUpgradeableRequest request)
      Deprecated.
      This method is deprecated and will be removed in the next major version update.
      Check if a notebook instance is upgradable. Deprecated. Please consider using v1.

      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()) {
         IsInstanceUpgradeableRequest request =
             IsInstanceUpgradeableRequest.newBuilder()
                 .setNotebookInstance("notebookInstance-544239728")
                 .build();
         IsInstanceUpgradeableResponse response = notebookServiceClient.isInstanceUpgradeable(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • isInstanceUpgradeableCallable

      Deprecated.
      This method is deprecated and will be removed in the next major version update.
      Check if a notebook instance is upgradable. Deprecated. Please consider using v1.

      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()) {
         IsInstanceUpgradeableRequest request =
             IsInstanceUpgradeableRequest.newBuilder()
                 .setNotebookInstance("notebookInstance-544239728")
                 .build();
         ApiFuture<IsInstanceUpgradeableResponse> future =
             notebookServiceClient.isInstanceUpgradeableCallable().futureCall(request);
         // Do something.
         IsInstanceUpgradeableResponse response = future.get();
       }
       
    • upgradeInstanceAsync

      @Deprecated public final OperationFuture<Instance,OperationMetadata> upgradeInstanceAsync(UpgradeInstanceRequest request)
      Deprecated.
      This method is deprecated and will be removed in the next major version update.
      Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.

      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()) {
         UpgradeInstanceRequest request =
             UpgradeInstanceRequest.newBuilder().setName("name3373707").build();
         Instance response = notebookServiceClient.upgradeInstanceAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • upgradeInstanceOperationCallable

      @Deprecated public final OperationCallable<UpgradeInstanceRequest,Instance,OperationMetadata> upgradeInstanceOperationCallable()
      Deprecated.
      This method is deprecated and will be removed in the next major version update.
      Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.

      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()) {
         UpgradeInstanceRequest request =
             UpgradeInstanceRequest.newBuilder().setName("name3373707").build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.upgradeInstanceOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • upgradeInstanceCallable

      @Deprecated public final UnaryCallable<UpgradeInstanceRequest,Operation> upgradeInstanceCallable()
      Deprecated.
      This method is deprecated and will be removed in the next major version update.
      Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.

      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()) {
         UpgradeInstanceRequest request =
             UpgradeInstanceRequest.newBuilder().setName("name3373707").build();
         ApiFuture<Operation> future =
             notebookServiceClient.upgradeInstanceCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • upgradeInstanceInternalAsync

      @Deprecated public final OperationFuture<Instance,OperationMetadata> upgradeInstanceInternalAsync(UpgradeInstanceInternalRequest request)
      Deprecated.
      This method is deprecated and will be removed in the next major version update.
      Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly. Deprecated. Please consider using v1.

      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()) {
         UpgradeInstanceInternalRequest request =
             UpgradeInstanceInternalRequest.newBuilder()
                 .setName("name3373707")
                 .setVmId("vmId3622450")
                 .build();
         Instance response = notebookServiceClient.upgradeInstanceInternalAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • upgradeInstanceInternalOperationCallable

      @Deprecated public final OperationCallable<UpgradeInstanceInternalRequest,Instance,OperationMetadata> upgradeInstanceInternalOperationCallable()
      Deprecated.
      This method is deprecated and will be removed in the next major version update.
      Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly. Deprecated. Please consider using v1.

      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()) {
         UpgradeInstanceInternalRequest request =
             UpgradeInstanceInternalRequest.newBuilder()
                 .setName("name3373707")
                 .setVmId("vmId3622450")
                 .build();
         OperationFuture<Instance, OperationMetadata> future =
             notebookServiceClient.upgradeInstanceInternalOperationCallable().futureCall(request);
         // Do something.
         Instance response = future.get();
       }
       
    • upgradeInstanceInternalCallable

      @Deprecated public final UnaryCallable<UpgradeInstanceInternalRequest,Operation> upgradeInstanceInternalCallable()
      Deprecated.
      This method is deprecated and will be removed in the next major version update.
      Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly. Deprecated. Please consider using v1.

      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()) {
         UpgradeInstanceInternalRequest request =
             UpgradeInstanceInternalRequest.newBuilder()
                 .setName("name3373707")
                 .setVmId("vmId3622450")
                 .build();
         ApiFuture<Operation> future =
             notebookServiceClient.upgradeInstanceInternalCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • listEnvironments

      Lists environments in a project.

      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()) {
         ListEnvironmentsRequest request =
             ListEnvironmentsRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         for (Environment element : notebookServiceClient.listEnvironments(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
    • listEnvironmentsPagedCallable

      Lists environments in a project.

      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()) {
         ListEnvironmentsRequest request =
             ListEnvironmentsRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         ApiFuture<Environment> future =
             notebookServiceClient.listEnvironmentsPagedCallable().futureCall(request);
         // Do something.
         for (Environment element : future.get().iterateAll()) {
           // doThingsWith(element);
         }
       }
       
    • listEnvironmentsCallable

      public final UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse> listEnvironmentsCallable()
      Lists environments in a project.

      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()) {
         ListEnvironmentsRequest request =
             ListEnvironmentsRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         while (true) {
           ListEnvironmentsResponse response =
               notebookServiceClient.listEnvironmentsCallable().call(request);
           for (Environment element : response.getEnvironmentsList()) {
             // doThingsWith(element);
           }
           String nextPageToken = response.getNextPageToken();
           if (!Strings.isNullOrEmpty(nextPageToken)) {
             request = request.toBuilder().setPageToken(nextPageToken).build();
           } else {
             break;
           }
         }
       }
       
    • getEnvironment

      public final Environment getEnvironment(GetEnvironmentRequest request)
      Gets details of a single Environment.

      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()) {
         GetEnvironmentRequest request =
             GetEnvironmentRequest.newBuilder().setName("name3373707").build();
         Environment response = notebookServiceClient.getEnvironment(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • getEnvironmentCallable

      public final UnaryCallable<GetEnvironmentRequest,Environment> getEnvironmentCallable()
      Gets details of a single Environment.

      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()) {
         GetEnvironmentRequest request =
             GetEnvironmentRequest.newBuilder().setName("name3373707").build();
         ApiFuture<Environment> future =
             notebookServiceClient.getEnvironmentCallable().futureCall(request);
         // Do something.
         Environment response = future.get();
       }
       
    • createEnvironmentAsync

      public final OperationFuture<Environment,OperationMetadata> createEnvironmentAsync(CreateEnvironmentRequest request)
      Creates a new Environment.

      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()) {
         CreateEnvironmentRequest request =
             CreateEnvironmentRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setEnvironmentId("environmentId-950205810")
                 .setEnvironment(Environment.newBuilder().build())
                 .build();
         Environment response = notebookServiceClient.createEnvironmentAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • createEnvironmentOperationCallable

      public final OperationCallable<CreateEnvironmentRequest,Environment,OperationMetadata> createEnvironmentOperationCallable()
      Creates a new Environment.

      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()) {
         CreateEnvironmentRequest request =
             CreateEnvironmentRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setEnvironmentId("environmentId-950205810")
                 .setEnvironment(Environment.newBuilder().build())
                 .build();
         OperationFuture<Environment, OperationMetadata> future =
             notebookServiceClient.createEnvironmentOperationCallable().futureCall(request);
         // Do something.
         Environment response = future.get();
       }
       
    • createEnvironmentCallable

      public final UnaryCallable<CreateEnvironmentRequest,Operation> createEnvironmentCallable()
      Creates a new Environment.

      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()) {
         CreateEnvironmentRequest request =
             CreateEnvironmentRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setEnvironmentId("environmentId-950205810")
                 .setEnvironment(Environment.newBuilder().build())
                 .build();
         ApiFuture<Operation> future =
             notebookServiceClient.createEnvironmentCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • deleteEnvironmentAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteEnvironmentAsync(DeleteEnvironmentRequest request)
      Deletes a single Environment.

      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()) {
         DeleteEnvironmentRequest request =
             DeleteEnvironmentRequest.newBuilder().setName("name3373707").build();
         notebookServiceClient.deleteEnvironmentAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • deleteEnvironmentOperationCallable

      public final OperationCallable<DeleteEnvironmentRequest,com.google.protobuf.Empty,OperationMetadata> deleteEnvironmentOperationCallable()
      Deletes a single Environment.

      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()) {
         DeleteEnvironmentRequest request =
             DeleteEnvironmentRequest.newBuilder().setName("name3373707").build();
         OperationFuture<Empty, OperationMetadata> future =
             notebookServiceClient.deleteEnvironmentOperationCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • deleteEnvironmentCallable

      public final UnaryCallable<DeleteEnvironmentRequest,Operation> deleteEnvironmentCallable()
      Deletes a single Environment.

      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()) {
         DeleteEnvironmentRequest request =
             DeleteEnvironmentRequest.newBuilder().setName("name3373707").build();
         ApiFuture<Operation> future =
             notebookServiceClient.deleteEnvironmentCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • listLocations

      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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         ListLocationsRequest request =
             ListLocationsRequest.newBuilder()
                 .setName("name3373707")
                 .setFilter("filter-1274492040")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         for (Location element : notebookServiceClient.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

      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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         ListLocationsRequest request =
             ListLocationsRequest.newBuilder()
                 .setName("name3373707")
                 .setFilter("filter-1274492040")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         ApiFuture<Location> future =
             notebookServiceClient.listLocationsPagedCallable().futureCall(request);
         // Do something.
         for (Location element : future.get().iterateAll()) {
           // doThingsWith(element);
         }
       }
       
    • listLocationsCallable

      public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         ListLocationsRequest request =
             ListLocationsRequest.newBuilder()
                 .setName("name3373707")
                 .setFilter("filter-1274492040")
                 .setPageSize(883849137)
                 .setPageToken("pageToken873572522")
                 .build();
         while (true) {
           ListLocationsResponse response =
               notebookServiceClient.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

      public final Location getLocation(GetLocationRequest request)
      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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
         Location response = notebookServiceClient.getLocation(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • getLocationCallable

      public final UnaryCallable<GetLocationRequest,Location> 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
         ApiFuture<Location> future = notebookServiceClient.getLocationCallable().futureCall(request);
         // Do something.
         Location response = future.get();
       }
       
    • setIamPolicy

      public final Policy setIamPolicy(SetIamPolicyRequest request)
      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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         SetIamPolicyRequest request =
             SetIamPolicyRequest.newBuilder()
                 .setResource("SetIamPolicyRequest1223629066".toString())
                 .setPolicy(Policy.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         Policy response = notebookServiceClient.setIamPolicy(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • setIamPolicyCallable

      public final UnaryCallable<SetIamPolicyRequest,Policy> 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         SetIamPolicyRequest request =
             SetIamPolicyRequest.newBuilder()
                 .setResource("SetIamPolicyRequest1223629066".toString())
                 .setPolicy(Policy.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         ApiFuture<Policy> future = notebookServiceClient.setIamPolicyCallable().futureCall(request);
         // Do something.
         Policy response = future.get();
       }
       
    • getIamPolicy

      public final Policy getIamPolicy(GetIamPolicyRequest request)
      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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         GetIamPolicyRequest request =
             GetIamPolicyRequest.newBuilder()
                 .setResource("GetIamPolicyRequest-1527610370".toString())
                 .setOptions(GetPolicyOptions.newBuilder().build())
                 .build();
         Policy response = notebookServiceClient.getIamPolicy(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails
    • getIamPolicyCallable

      public final UnaryCallable<GetIamPolicyRequest,Policy> 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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         GetIamPolicyRequest request =
             GetIamPolicyRequest.newBuilder()
                 .setResource("GetIamPolicyRequest-1527610370".toString())
                 .setOptions(GetPolicyOptions.newBuilder().build())
                 .build();
         ApiFuture<Policy> future = notebookServiceClient.getIamPolicyCallable().futureCall(request);
         // Do something.
         Policy response = future.get();
       }
       
    • testIamPermissions

      public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
      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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         TestIamPermissionsRequest request =
             TestIamPermissionsRequest.newBuilder()
                 .setResource("TestIamPermissionsRequest942398222".toString())
                 .addAllPermissions(new ArrayList<String>())
                 .build();
         TestIamPermissionsResponse response = notebookServiceClient.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 (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
         TestIamPermissionsRequest request =
             TestIamPermissionsRequest.newBuilder()
                 .setResource("TestIamPermissionsRequest942398222".toString())
                 .addAllPermissions(new ArrayList<String>())
                 .build();
         ApiFuture<TestIamPermissionsResponse> future =
             notebookServiceClient.testIamPermissionsCallable().futureCall(request);
         // Do something.
         TestIamPermissionsResponse response = future.get();
       }
       
    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable
    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource
    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource
    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource
    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource
    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException