Class NotebookServiceClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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().
| 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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteInstance |
Deletes a single Instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
StartInstance |
Starts a notebook instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
StopInstance |
Stops a notebook instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ResetInstance |
Resets a notebook instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListEnvironments |
Lists environments in a project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateEnvironment |
Creates a new Environment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteEnvironment |
Deletes a single Environment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy |
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
TestIamPermissions |
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of 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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedNotebookServiceClient(NotebookServiceSettings settings) Constructs an instance of NotebookServiceClient, using the given settings.protected -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final voidclose()static final NotebookServiceClientcreate()Constructs an instance of NotebookServiceClient with default settings.static final NotebookServiceClientcreate(NotebookServiceSettings settings) Constructs an instance of NotebookServiceClient, using the given settings.static final NotebookServiceClientcreate(NotebookServiceStub stub) Constructs an instance of NotebookServiceClient, using the given stub for making calls.Creates a new Environment.Creates a new Environment.Creates a new Environment.createInstanceAsync(CreateInstanceRequest request) Creates a new Instance in a given project and location.Creates a new Instance in a given project and location.Creates a new Instance in a given project and location.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Deletes a single Environment.Deletes a single Environment.final OperationCallable<DeleteEnvironmentRequest,com.google.protobuf.Empty, OperationMetadata> Deletes a single Environment.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInstanceAsync(DeleteInstanceRequest request) Deletes a single Instance.Deletes a single Instance.final OperationCallable<DeleteInstanceRequest,com.google.protobuf.Empty, OperationMetadata> Deletes a single Instance.final EnvironmentgetEnvironment(GetEnvironmentRequest request) Gets details of a single Environment.Gets details of a single Environment.final PolicygetIamPolicy(GetIamPolicyRequest request) Gets the access control policy for a resource.Gets the access control policy for a resource.final InstancegetInstance(GetInstanceRequest request) Gets details of a single Instance.Gets details of a single Instance.final LocationgetLocation(GetLocationRequest request) Gets information about a location.Gets information about a location.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final NotebookServiceSettingsgetStub()Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.booleanbooleanlistEnvironments(ListEnvironmentsRequest request) Lists environments in a project.Lists environments in a project.Lists environments in a project.listInstances(ListInstancesRequest request) Lists instances in a given project and location.Lists instances in a given project and location.Lists instances in a given project and location.listLocations(ListLocationsRequest request) Lists information about the supported locations for this service.Lists information about the supported locations for this service.Lists information about the supported locations for this service.Registers an existing legacy notebook instance to the Notebooks API server.Registers an existing legacy notebook instance to the Notebooks API server.Registers an existing legacy notebook instance to the Notebooks API server.Allows notebook instances to report their latest instance information to the Notebooks API server.Allows notebook instances to report their latest instance information to the Notebooks API server.Allows notebook instances to report their latest instance information to the Notebooks API server.resetInstanceAsync(ResetInstanceRequest request) Resets a notebook instance.Resets a notebook instance.Resets a notebook instance.final PolicysetIamPolicy(SetIamPolicyRequest request) Sets the access control policy on the specified resource.Sets the access control policy on the specified resource.Updates the guest accelerators of a single Instance.Updates the guest accelerators of a single Instance.Updates the guest accelerators of a single Instance.Updates the labels of an Instance.Updates the labels of an Instance.Updates the labels of an Instance.Updates the machine type of a single Instance.Updates the machine type of a single Instance.Updates the machine type of a single Instance.voidshutdown()voidstartInstanceAsync(StartInstanceRequest request) Starts a notebook instance.Starts a notebook instance.Starts a notebook instance.stopInstanceAsync(StopInstanceRequest request) Stops a notebook instance.Stops a notebook instance.Stops a notebook instance.Returns permissions that a caller has on the specified resource.Returns permissions that a caller has on the specified resource.Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.
-
Constructor Details
-
NotebookServiceClient
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
-
-
Method Details
-
create
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
Constructs an instance of NotebookServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(NotebookServiceSettings). -
getSettings
-
getStub
-
getOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
listInstances
public final NotebookServiceClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request) Lists instances in a given project and location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) { ListInstancesRequest request = ListInstancesRequest.newBuilder() .setParent("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
public final UnaryCallable<ListInstancesRequest,NotebookServiceClient.ListInstancesPagedResponse> listInstancesPagedCallable()Lists instances in a given project and location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) { ListInstancesRequest request = ListInstancesRequest.newBuilder() .setParent("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
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
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
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, createInstanceOperationCallable()OperationMetadata> 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
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, registerInstanceOperationCallable()OperationMetadata> 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
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, setInstanceAcceleratorOperationCallable()OperationMetadata> 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, setInstanceMachineTypeOperationCallable()OperationMetadata> 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, setInstanceLabelsOperationCallable()OperationMetadata> 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
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, deleteInstanceOperationCallable()OperationMetadata> 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
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, startInstanceOperationCallable()OperationMetadata> 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
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, stopInstanceOperationCallable()OperationMetadata> 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
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, resetInstanceOperationCallable()OperationMetadata> 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
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, reportInstanceInfoOperationCallable()OperationMetadata> 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
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 public final UnaryCallable<IsInstanceUpgradeableRequest,IsInstanceUpgradeableResponse> 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, upgradeInstanceOperationCallable()OperationMetadata> 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.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, upgradeInstanceInternalOperationCallable()OperationMetadata> 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
public final NotebookServiceClient.ListEnvironmentsPagedResponse listEnvironments(ListEnvironmentsRequest request) 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
public final UnaryCallable<ListEnvironmentsRequest,NotebookServiceClient.ListEnvironmentsPagedResponse> 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
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
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, createEnvironmentOperationCallable()OperationMetadata> 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
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, deleteEnvironmentOperationCallable()OperationMetadata> 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
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
public final NotebookServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request) Lists information about the supported locations for this service.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (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
public final UnaryCallable<ListLocationsRequest,NotebookServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()Lists information about the supported locations for this service.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (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
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
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
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
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
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
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
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
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:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-