NotebookServiceClient (Google Cloud Vertex AI 3.46.0 API)

java.lang.Object
- com.google.cloud.aiplatform.v1beta1.NotebookServiceClient

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

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

Service Description: The interface for Vertex Notebook service (a.k.a. Colab on Workbench).

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()) {
   NotebookRuntimeTemplateName name =
       NotebookRuntimeTemplateName.of("[PROJECT]", "[LOCATION]", "[NOTEBOOK_RUNTIME_TEMPLATE]");
   NotebookRuntimeTemplate response = notebookServiceClient.getNotebookRuntimeTemplate(name);
 }

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

Methods
Method	Description	Method Variants
CreateNotebookRuntimeTemplate	Creates a NotebookRuntimeTemplate.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createNotebookRuntimeTemplateAsync(LocationName parent, NotebookRuntimeTemplate notebookRuntimeTemplate, String notebookRuntimeTemplateId) createNotebookRuntimeTemplateAsync(String parent, NotebookRuntimeTemplate notebookRuntimeTemplate, String notebookRuntimeTemplateId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createNotebookRuntimeTemplateOperationCallable() createNotebookRuntimeTemplateCallable()
GetNotebookRuntimeTemplate	Gets a NotebookRuntimeTemplate.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getNotebookRuntimeTemplate(NotebookRuntimeTemplateName name) getNotebookRuntimeTemplate(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getNotebookRuntimeTemplateCallable()
ListNotebookRuntimeTemplates	Lists NotebookRuntimeTemplates in a Location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listNotebookRuntimeTemplates(LocationName parent) listNotebookRuntimeTemplates(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listNotebookRuntimeTemplatesPagedCallable() listNotebookRuntimeTemplatesCallable()
DeleteNotebookRuntimeTemplate	Deletes a NotebookRuntimeTemplate.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteNotebookRuntimeTemplateAsync(NotebookRuntimeTemplateName name) deleteNotebookRuntimeTemplateAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteNotebookRuntimeTemplateOperationCallable() deleteNotebookRuntimeTemplateCallable()
UpdateNotebookRuntimeTemplate	Updates a NotebookRuntimeTemplate.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateNotebookRuntimeTemplate(NotebookRuntimeTemplate notebookRuntimeTemplate, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateNotebookRuntimeTemplateCallable()
AssignNotebookRuntime	Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.	Request object method variants only take one parameter, a request object, which must be constructed before the call. assignNotebookRuntimeAsync(AssignNotebookRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. assignNotebookRuntimeAsync(LocationName parent, NotebookRuntimeTemplateName notebookRuntimeTemplate, NotebookRuntime notebookRuntime, String notebookRuntimeId) assignNotebookRuntimeAsync(LocationName parent, String notebookRuntimeTemplate, NotebookRuntime notebookRuntime, String notebookRuntimeId) assignNotebookRuntimeAsync(String parent, NotebookRuntimeTemplateName notebookRuntimeTemplate, NotebookRuntime notebookRuntime, String notebookRuntimeId) assignNotebookRuntimeAsync(String parent, String notebookRuntimeTemplate, NotebookRuntime notebookRuntime, String notebookRuntimeId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. assignNotebookRuntimeOperationCallable() assignNotebookRuntimeCallable()
GetNotebookRuntime	Gets a NotebookRuntime.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getNotebookRuntime(GetNotebookRuntimeRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getNotebookRuntime(NotebookRuntimeName name) getNotebookRuntime(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getNotebookRuntimeCallable()
ListNotebookRuntimes	Lists NotebookRuntimes in a Location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listNotebookRuntimes(ListNotebookRuntimesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listNotebookRuntimes(LocationName parent) listNotebookRuntimes(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listNotebookRuntimesPagedCallable() listNotebookRuntimesCallable()
DeleteNotebookRuntime	Deletes a NotebookRuntime.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteNotebookRuntimeAsync(NotebookRuntimeName name) deleteNotebookRuntimeAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteNotebookRuntimeOperationCallable() deleteNotebookRuntimeCallable()
UpgradeNotebookRuntime	Upgrades a NotebookRuntime.	Request object method variants only take one parameter, a request object, which must be constructed before the call. upgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. upgradeNotebookRuntimeAsync(NotebookRuntimeName name) upgradeNotebookRuntimeAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. upgradeNotebookRuntimeOperationCallable() upgradeNotebookRuntimeCallable()
StartNotebookRuntime	Starts a NotebookRuntime.	Request object method variants only take one parameter, a request object, which must be constructed before the call. startNotebookRuntimeAsync(StartNotebookRuntimeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. startNotebookRuntimeAsync(NotebookRuntimeName name) startNotebookRuntimeAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. startNotebookRuntimeOperationCallable() startNotebookRuntimeCallable()
CreateNotebookExecutionJob	Creates a NotebookExecutionJob.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createNotebookExecutionJobAsync(CreateNotebookExecutionJobRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createNotebookExecutionJobAsync(LocationName parent, NotebookExecutionJob notebookExecutionJob, String notebookExecutionJobId) createNotebookExecutionJobAsync(String parent, NotebookExecutionJob notebookExecutionJob, String notebookExecutionJobId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createNotebookExecutionJobOperationCallable() createNotebookExecutionJobCallable()
GetNotebookExecutionJob	Gets a NotebookExecutionJob.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getNotebookExecutionJob(GetNotebookExecutionJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getNotebookExecutionJob(NotebookExecutionJobName name) getNotebookExecutionJob(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getNotebookExecutionJobCallable()
ListNotebookExecutionJobs	Lists NotebookExecutionJobs in a Location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listNotebookExecutionJobs(ListNotebookExecutionJobsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listNotebookExecutionJobs(LocationName parent) listNotebookExecutionJobs(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listNotebookExecutionJobsPagedCallable() listNotebookExecutionJobsCallable()
DeleteNotebookExecutionJob	Deletes a NotebookExecutionJob.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteNotebookExecutionJobAsync(DeleteNotebookExecutionJobRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteNotebookExecutionJobAsync(NotebookExecutionJobName name) deleteNotebookExecutionJobAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteNotebookExecutionJobOperationCallable() deleteNotebookExecutionJobCallable()
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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NotebookServiceClient.ListLocationsFixedSizeCollection`
`static class`	`NotebookServiceClient.ListLocationsPage`
`static class`	`NotebookServiceClient.ListLocationsPagedResponse`
`static class`	`NotebookServiceClient.ListNotebookExecutionJobsFixedSizeCollection`
`static class`	`NotebookServiceClient.ListNotebookExecutionJobsPage`
`static class`	`NotebookServiceClient.ListNotebookExecutionJobsPagedResponse`
`static class`	`NotebookServiceClient.ListNotebookRuntimesFixedSizeCollection`
`static class`	`NotebookServiceClient.ListNotebookRuntimesPage`
`static class`	`NotebookServiceClient.ListNotebookRuntimesPagedResponse`
`static class`	`NotebookServiceClient.ListNotebookRuntimeTemplatesFixedSizeCollection`
`static class`	`NotebookServiceClient.ListNotebookRuntimeTemplatesPage`
`static class`	`NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse`

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.gax.longrunning.OperationFuture<NotebookRuntime,AssignNotebookRuntimeOperationMetadata>`	`assignNotebookRuntimeAsync(AssignNotebookRuntimeRequest request)` Assigns a NotebookRuntime to a user for a particular Notebook file.
`com.google.api.gax.longrunning.OperationFuture<NotebookRuntime,AssignNotebookRuntimeOperationMetadata>`	`assignNotebookRuntimeAsync(LocationName parent, NotebookRuntimeTemplateName notebookRuntimeTemplate, NotebookRuntime notebookRuntime, String notebookRuntimeId)` Assigns a NotebookRuntime to a user for a particular Notebook file.
`com.google.api.gax.longrunning.OperationFuture<NotebookRuntime,AssignNotebookRuntimeOperationMetadata>`	`assignNotebookRuntimeAsync(LocationName parent, String notebookRuntimeTemplate, NotebookRuntime notebookRuntime, String notebookRuntimeId)` Assigns a NotebookRuntime to a user for a particular Notebook file.
`com.google.api.gax.longrunning.OperationFuture<NotebookRuntime,AssignNotebookRuntimeOperationMetadata>`	`assignNotebookRuntimeAsync(String parent, NotebookRuntimeTemplateName notebookRuntimeTemplate, NotebookRuntime notebookRuntime, String notebookRuntimeId)` Assigns a NotebookRuntime to a user for a particular Notebook file.
`com.google.api.gax.longrunning.OperationFuture<NotebookRuntime,AssignNotebookRuntimeOperationMetadata>`	`assignNotebookRuntimeAsync(String parent, String notebookRuntimeTemplate, NotebookRuntime notebookRuntime, String notebookRuntimeId)` Assigns a NotebookRuntime to a user for a particular Notebook file.
`com.google.api.gax.rpc.UnaryCallable<AssignNotebookRuntimeRequest,com.google.longrunning.Operation>`	`assignNotebookRuntimeCallable()` Assigns a NotebookRuntime to a user for a particular Notebook file.
`com.google.api.gax.rpc.OperationCallable<AssignNotebookRuntimeRequest,NotebookRuntime,AssignNotebookRuntimeOperationMetadata>`	`assignNotebookRuntimeOperationCallable()` Assigns a NotebookRuntime to a user for a particular Notebook file.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static NotebookServiceClient`	`create()` Constructs an instance of NotebookServiceClient with default settings.
`static NotebookServiceClient`	`create(NotebookServiceSettings settings)` Constructs an instance of NotebookServiceClient, using the given settings.
`static NotebookServiceClient`	`create(NotebookServiceStub stub)` Constructs an instance of NotebookServiceClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<NotebookExecutionJob,CreateNotebookExecutionJobOperationMetadata>`	`createNotebookExecutionJobAsync(CreateNotebookExecutionJobRequest request)` Creates a NotebookExecutionJob.
`com.google.api.gax.longrunning.OperationFuture<NotebookExecutionJob,CreateNotebookExecutionJobOperationMetadata>`	`createNotebookExecutionJobAsync(LocationName parent, NotebookExecutionJob notebookExecutionJob, String notebookExecutionJobId)` Creates a NotebookExecutionJob.
`com.google.api.gax.longrunning.OperationFuture<NotebookExecutionJob,CreateNotebookExecutionJobOperationMetadata>`	`createNotebookExecutionJobAsync(String parent, NotebookExecutionJob notebookExecutionJob, String notebookExecutionJobId)` Creates a NotebookExecutionJob.
`com.google.api.gax.rpc.UnaryCallable<CreateNotebookExecutionJobRequest,com.google.longrunning.Operation>`	`createNotebookExecutionJobCallable()` Creates a NotebookExecutionJob.
`com.google.api.gax.rpc.OperationCallable<CreateNotebookExecutionJobRequest,NotebookExecutionJob,CreateNotebookExecutionJobOperationMetadata>`	`createNotebookExecutionJobOperationCallable()` Creates a NotebookExecutionJob.
`com.google.api.gax.longrunning.OperationFuture<NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata>`	`createNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest request)` Creates a NotebookRuntimeTemplate.
`com.google.api.gax.longrunning.OperationFuture<NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata>`	`createNotebookRuntimeTemplateAsync(LocationName parent, NotebookRuntimeTemplate notebookRuntimeTemplate, String notebookRuntimeTemplateId)` Creates a NotebookRuntimeTemplate.
`com.google.api.gax.longrunning.OperationFuture<NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata>`	`createNotebookRuntimeTemplateAsync(String parent, NotebookRuntimeTemplate notebookRuntimeTemplate, String notebookRuntimeTemplateId)` Creates a NotebookRuntimeTemplate.
`com.google.api.gax.rpc.UnaryCallable<CreateNotebookRuntimeTemplateRequest,com.google.longrunning.Operation>`	`createNotebookRuntimeTemplateCallable()` Creates a NotebookRuntimeTemplate.
`com.google.api.gax.rpc.OperationCallable<CreateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata>`	`createNotebookRuntimeTemplateOperationCallable()` Creates a NotebookRuntimeTemplate.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookExecutionJobAsync(DeleteNotebookExecutionJobRequest request)` Deletes a NotebookExecutionJob.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookExecutionJobAsync(NotebookExecutionJobName name)` Deletes a NotebookExecutionJob.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookExecutionJobAsync(String name)` Deletes a NotebookExecutionJob.
`com.google.api.gax.rpc.UnaryCallable<DeleteNotebookExecutionJobRequest,com.google.longrunning.Operation>`	`deleteNotebookExecutionJobCallable()` Deletes a NotebookExecutionJob.
`com.google.api.gax.rpc.OperationCallable<DeleteNotebookExecutionJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookExecutionJobOperationCallable()` Deletes a NotebookExecutionJob.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest request)` Deletes a NotebookRuntime.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookRuntimeAsync(NotebookRuntimeName name)` Deletes a NotebookRuntime.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookRuntimeAsync(String name)` Deletes a NotebookRuntime.
`com.google.api.gax.rpc.UnaryCallable<DeleteNotebookRuntimeRequest,com.google.longrunning.Operation>`	`deleteNotebookRuntimeCallable()` Deletes a NotebookRuntime.
`com.google.api.gax.rpc.OperationCallable<DeleteNotebookRuntimeRequest,com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookRuntimeOperationCallable()` Deletes a NotebookRuntime.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest request)` Deletes a NotebookRuntimeTemplate.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookRuntimeTemplateAsync(NotebookRuntimeTemplateName name)` Deletes a NotebookRuntimeTemplate.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookRuntimeTemplateAsync(String name)` Deletes a NotebookRuntimeTemplate.
`com.google.api.gax.rpc.UnaryCallable<DeleteNotebookRuntimeTemplateRequest,com.google.longrunning.Operation>`	`deleteNotebookRuntimeTemplateCallable()` Deletes a NotebookRuntimeTemplate.
`com.google.api.gax.rpc.OperationCallable<DeleteNotebookRuntimeTemplateRequest,com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteNotebookRuntimeTemplateOperationCallable()` Deletes a NotebookRuntimeTemplate.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`NotebookExecutionJob`	`getNotebookExecutionJob(GetNotebookExecutionJobRequest request)` Gets a NotebookExecutionJob.
`NotebookExecutionJob`	`getNotebookExecutionJob(NotebookExecutionJobName name)` Gets a NotebookExecutionJob.
`NotebookExecutionJob`	`getNotebookExecutionJob(String name)` Gets a NotebookExecutionJob.
`com.google.api.gax.rpc.UnaryCallable<GetNotebookExecutionJobRequest,NotebookExecutionJob>`	`getNotebookExecutionJobCallable()` Gets a NotebookExecutionJob.
`NotebookRuntime`	`getNotebookRuntime(GetNotebookRuntimeRequest request)` Gets a NotebookRuntime.
`NotebookRuntime`	`getNotebookRuntime(NotebookRuntimeName name)` Gets a NotebookRuntime.
`NotebookRuntime`	`getNotebookRuntime(String name)` Gets a NotebookRuntime.
`com.google.api.gax.rpc.UnaryCallable<GetNotebookRuntimeRequest,NotebookRuntime>`	`getNotebookRuntimeCallable()` Gets a NotebookRuntime.
`NotebookRuntimeTemplate`	`getNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest request)` Gets a NotebookRuntimeTemplate.
`NotebookRuntimeTemplate`	`getNotebookRuntimeTemplate(NotebookRuntimeTemplateName name)` Gets a NotebookRuntimeTemplate.
`NotebookRuntimeTemplate`	`getNotebookRuntimeTemplate(String name)` Gets a NotebookRuntimeTemplate.
`com.google.api.gax.rpc.UnaryCallable<GetNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate>`	`getNotebookRuntimeTemplateCallable()` Gets a NotebookRuntimeTemplate.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`NotebookServiceSettings`	`getSettings()`
`NotebookServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`NotebookServiceClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,NotebookServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`NotebookServiceClient.ListNotebookExecutionJobsPagedResponse`	`listNotebookExecutionJobs(ListNotebookExecutionJobsRequest request)` Lists NotebookExecutionJobs in a Location.
`NotebookServiceClient.ListNotebookExecutionJobsPagedResponse`	`listNotebookExecutionJobs(LocationName parent)` Lists NotebookExecutionJobs in a Location.
`NotebookServiceClient.ListNotebookExecutionJobsPagedResponse`	`listNotebookExecutionJobs(String parent)` Lists NotebookExecutionJobs in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListNotebookExecutionJobsRequest,ListNotebookExecutionJobsResponse>`	`listNotebookExecutionJobsCallable()` Lists NotebookExecutionJobs in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListNotebookExecutionJobsRequest,NotebookServiceClient.ListNotebookExecutionJobsPagedResponse>`	`listNotebookExecutionJobsPagedCallable()` Lists NotebookExecutionJobs in a Location.
`NotebookServiceClient.ListNotebookRuntimesPagedResponse`	`listNotebookRuntimes(ListNotebookRuntimesRequest request)` Lists NotebookRuntimes in a Location.
`NotebookServiceClient.ListNotebookRuntimesPagedResponse`	`listNotebookRuntimes(LocationName parent)` Lists NotebookRuntimes in a Location.
`NotebookServiceClient.ListNotebookRuntimesPagedResponse`	`listNotebookRuntimes(String parent)` Lists NotebookRuntimes in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListNotebookRuntimesRequest,ListNotebookRuntimesResponse>`	`listNotebookRuntimesCallable()` Lists NotebookRuntimes in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListNotebookRuntimesRequest,NotebookServiceClient.ListNotebookRuntimesPagedResponse>`	`listNotebookRuntimesPagedCallable()` Lists NotebookRuntimes in a Location.
`NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse`	`listNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest request)` Lists NotebookRuntimeTemplates in a Location.
`NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse`	`listNotebookRuntimeTemplates(LocationName parent)` Lists NotebookRuntimeTemplates in a Location.
`NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse`	`listNotebookRuntimeTemplates(String parent)` Lists NotebookRuntimeTemplates in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListNotebookRuntimeTemplatesRequest,ListNotebookRuntimeTemplatesResponse>`	`listNotebookRuntimeTemplatesCallable()` Lists NotebookRuntimeTemplates in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListNotebookRuntimeTemplatesRequest,NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse>`	`listNotebookRuntimeTemplatesPagedCallable()` Lists NotebookRuntimeTemplates in a Location.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<StartNotebookRuntimeResponse,StartNotebookRuntimeOperationMetadata>`	`startNotebookRuntimeAsync(NotebookRuntimeName name)` Starts a NotebookRuntime.
`com.google.api.gax.longrunning.OperationFuture<StartNotebookRuntimeResponse,StartNotebookRuntimeOperationMetadata>`	`startNotebookRuntimeAsync(StartNotebookRuntimeRequest request)` Starts a NotebookRuntime.
`com.google.api.gax.longrunning.OperationFuture<StartNotebookRuntimeResponse,StartNotebookRuntimeOperationMetadata>`	`startNotebookRuntimeAsync(String name)` Starts a NotebookRuntime.
`com.google.api.gax.rpc.UnaryCallable<StartNotebookRuntimeRequest,com.google.longrunning.Operation>`	`startNotebookRuntimeCallable()` Starts a NotebookRuntime.
`com.google.api.gax.rpc.OperationCallable<StartNotebookRuntimeRequest,StartNotebookRuntimeResponse,StartNotebookRuntimeOperationMetadata>`	`startNotebookRuntimeOperationCallable()` Starts a NotebookRuntime.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`NotebookRuntimeTemplate`	`updateNotebookRuntimeTemplate(NotebookRuntimeTemplate notebookRuntimeTemplate, com.google.protobuf.FieldMask updateMask)` Updates a NotebookRuntimeTemplate.
`NotebookRuntimeTemplate`	`updateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest request)` Updates a NotebookRuntimeTemplate.
`com.google.api.gax.rpc.UnaryCallable<UpdateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate>`	`updateNotebookRuntimeTemplateCallable()` Updates a NotebookRuntimeTemplate.
`com.google.api.gax.longrunning.OperationFuture<UpgradeNotebookRuntimeResponse,UpgradeNotebookRuntimeOperationMetadata>`	`upgradeNotebookRuntimeAsync(NotebookRuntimeName name)` Upgrades a NotebookRuntime.
`com.google.api.gax.longrunning.OperationFuture<UpgradeNotebookRuntimeResponse,UpgradeNotebookRuntimeOperationMetadata>`	`upgradeNotebookRuntimeAsync(String name)` Upgrades a NotebookRuntime.
`com.google.api.gax.longrunning.OperationFuture<UpgradeNotebookRuntimeResponse,UpgradeNotebookRuntimeOperationMetadata>`	`upgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest request)` Upgrades a NotebookRuntime.
`com.google.api.gax.rpc.UnaryCallable<UpgradeNotebookRuntimeRequest,com.google.longrunning.Operation>`	`upgradeNotebookRuntimeCallable()` Upgrades a NotebookRuntime.
`com.google.api.gax.rpc.OperationCallable<UpgradeNotebookRuntimeRequest,UpgradeNotebookRuntimeResponse,UpgradeNotebookRuntimeOperationMetadata>`	`upgradeNotebookRuntimeOperationCallable()` Upgrades a NotebookRuntime.

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

Constructor Detail
- NotebookServiceClient
```
protected NotebookServiceClient(NotebookServiceSettings settings)
                         throws IOException
```
  Constructs an instance of NotebookServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- NotebookServiceClient
```
protected NotebookServiceClient(NotebookServiceStub stub)
```

Method Detail

create

public static final NotebookServiceClient create()
                                          throws IOException

Constructs an instance of NotebookServiceClient with default settings.

Throws:: IOException

create
```
public static final NotebookServiceClient create(NotebookServiceSettings settings)
                                          throws IOException
```
Constructs an instance of NotebookServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final NotebookServiceClient create(NotebookServiceStub stub)
```
Constructs an instance of NotebookServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(NotebookServiceSettings).

getSettings

public final NotebookServiceSettings getSettings()

getStub
```
public NotebookServiceStub getStub()
```

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

createNotebookRuntimeTemplateAsync

public final com.google.api.gax.longrunning.OperationFuture<NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata> createNotebookRuntimeTemplateAsync(LocationName parent,
                                                                                                                                                                       NotebookRuntimeTemplate notebookRuntimeTemplate,
                                                                                                                                                                       String notebookRuntimeTemplateId)

Creates a NotebookRuntimeTemplate.

Sample code:


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

Parameters:: parent - Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`; notebookRuntimeTemplate - Required. The NotebookRuntimeTemplate to create.; notebookRuntimeTemplateId - Optional. User specified ID for the notebook runtime template.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createNotebookRuntimeTemplateAsync

public final com.google.api.gax.longrunning.OperationFuture<NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata> createNotebookRuntimeTemplateAsync(String parent,
                                                                                                                                                                       NotebookRuntimeTemplate notebookRuntimeTemplate,
                                                                                                                                                                       String notebookRuntimeTemplateId)

Creates a NotebookRuntimeTemplate.

Sample code:


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

Parameters:: parent - Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`; notebookRuntimeTemplate - Required. The NotebookRuntimeTemplate to create.; notebookRuntimeTemplateId - Optional. User specified ID for the notebook runtime template.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createNotebookRuntimeTemplateAsync

public final com.google.api.gax.longrunning.OperationFuture<NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata> createNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest request)

Creates a NotebookRuntimeTemplate.

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()) {
   CreateNotebookRuntimeTemplateRequest request =
       CreateNotebookRuntimeTemplateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNotebookRuntimeTemplate(NotebookRuntimeTemplate.newBuilder().build())
           .setNotebookRuntimeTemplateId("notebookRuntimeTemplateId-633369454")
           .build();
   NotebookRuntimeTemplate response =
       notebookServiceClient.createNotebookRuntimeTemplateAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createNotebookRuntimeTemplateOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata> createNotebookRuntimeTemplateOperationCallable()

Creates a NotebookRuntimeTemplate.

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()) {
   CreateNotebookRuntimeTemplateRequest request =
       CreateNotebookRuntimeTemplateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNotebookRuntimeTemplate(NotebookRuntimeTemplate.newBuilder().build())
           .setNotebookRuntimeTemplateId("notebookRuntimeTemplateId-633369454")
           .build();
   OperationFuture<NotebookRuntimeTemplate, CreateNotebookRuntimeTemplateOperationMetadata>
       future =
           notebookServiceClient
               .createNotebookRuntimeTemplateOperationCallable()
               .futureCall(request);
   // Do something.
   NotebookRuntimeTemplate response = future.get();
 }

createNotebookRuntimeTemplateCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateNotebookRuntimeTemplateRequest,com.google.longrunning.Operation> createNotebookRuntimeTemplateCallable()

Creates a NotebookRuntimeTemplate.

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()) {
   CreateNotebookRuntimeTemplateRequest request =
       CreateNotebookRuntimeTemplateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNotebookRuntimeTemplate(NotebookRuntimeTemplate.newBuilder().build())
           .setNotebookRuntimeTemplateId("notebookRuntimeTemplateId-633369454")
           .build();
   ApiFuture<Operation> future =
       notebookServiceClient.createNotebookRuntimeTemplateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

getNotebookRuntimeTemplate

public final NotebookRuntimeTemplate getNotebookRuntimeTemplate(NotebookRuntimeTemplateName name)

Gets a NotebookRuntimeTemplate.

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()) {
   NotebookRuntimeTemplateName name =
       NotebookRuntimeTemplateName.of("[PROJECT]", "[LOCATION]", "[NOTEBOOK_RUNTIME_TEMPLATE]");
   NotebookRuntimeTemplate response = notebookServiceClient.getNotebookRuntimeTemplate(name);
 }

Parameters:: name - Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getNotebookRuntimeTemplate

public final NotebookRuntimeTemplate getNotebookRuntimeTemplate(String name)

Gets a NotebookRuntimeTemplate.

Sample code:


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

Parameters:: name - Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getNotebookRuntimeTemplate

public final NotebookRuntimeTemplate getNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest request)

Gets a NotebookRuntimeTemplate.

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()) {
   GetNotebookRuntimeTemplateRequest request =
       GetNotebookRuntimeTemplateRequest.newBuilder()
           .setName(
               NotebookRuntimeTemplateName.of(
                       "[PROJECT]", "[LOCATION]", "[NOTEBOOK_RUNTIME_TEMPLATE]")
                   .toString())
           .build();
   NotebookRuntimeTemplate response = notebookServiceClient.getNotebookRuntimeTemplate(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getNotebookRuntimeTemplateCallable

public final com.google.api.gax.rpc.UnaryCallable<GetNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> getNotebookRuntimeTemplateCallable()

Gets a NotebookRuntimeTemplate.

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()) {
   GetNotebookRuntimeTemplateRequest request =
       GetNotebookRuntimeTemplateRequest.newBuilder()
           .setName(
               NotebookRuntimeTemplateName.of(
                       "[PROJECT]", "[LOCATION]", "[NOTEBOOK_RUNTIME_TEMPLATE]")
                   .toString())
           .build();
   ApiFuture<NotebookRuntimeTemplate> future =
       notebookServiceClient.getNotebookRuntimeTemplateCallable().futureCall(request);
   // Do something.
   NotebookRuntimeTemplate response = future.get();
 }

listNotebookRuntimeTemplates

public final NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse listNotebookRuntimeTemplates(LocationName parent)

Lists NotebookRuntimeTemplates in 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (NotebookRuntimeTemplate element :
       notebookServiceClient.listNotebookRuntimeTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listNotebookRuntimeTemplates

public final NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse listNotebookRuntimeTemplates(String parent)

Lists NotebookRuntimeTemplates in 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (NotebookRuntimeTemplate element :
       notebookServiceClient.listNotebookRuntimeTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listNotebookRuntimeTemplates

public final NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse listNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest request)

Lists NotebookRuntimeTemplates in 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()) {
   ListNotebookRuntimeTemplatesRequest request =
       ListNotebookRuntimeTemplatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   for (NotebookRuntimeTemplate element :
       notebookServiceClient.listNotebookRuntimeTemplates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listNotebookRuntimeTemplatesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListNotebookRuntimeTemplatesRequest,NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse> listNotebookRuntimeTemplatesPagedCallable()

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

listNotebookRuntimeTemplatesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListNotebookRuntimeTemplatesRequest,ListNotebookRuntimeTemplatesResponse> listNotebookRuntimeTemplatesCallable()

Lists NotebookRuntimeTemplates in 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()) {
   ListNotebookRuntimeTemplatesRequest request =
       ListNotebookRuntimeTemplatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListNotebookRuntimeTemplatesResponse response =
         notebookServiceClient.listNotebookRuntimeTemplatesCallable().call(request);
     for (NotebookRuntimeTemplate element : response.getNotebookRuntimeTemplatesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteNotebookRuntimeTemplateAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteNotebookRuntimeTemplateAsync(NotebookRuntimeTemplateName name)

Deletes a NotebookRuntimeTemplate.

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()) {
   NotebookRuntimeTemplateName name =
       NotebookRuntimeTemplateName.of("[PROJECT]", "[LOCATION]", "[NOTEBOOK_RUNTIME_TEMPLATE]");
   notebookServiceClient.deleteNotebookRuntimeTemplateAsync(name).get();
 }

Parameters:: name - Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteNotebookRuntimeTemplateAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteNotebookRuntimeTemplateAsync(String name)

Deletes a NotebookRuntimeTemplate.

Sample code:


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

Parameters:: name - Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteNotebookRuntimeTemplateAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest request)

Deletes a NotebookRuntimeTemplate.

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()) {
   DeleteNotebookRuntimeTemplateRequest request =
       DeleteNotebookRuntimeTemplateRequest.newBuilder()
           .setName(
               NotebookRuntimeTemplateName.of(
                       "[PROJECT]", "[LOCATION]", "[NOTEBOOK_RUNTIME_TEMPLATE]")
                   .toString())
           .build();
   notebookServiceClient.deleteNotebookRuntimeTemplateAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteNotebookRuntimeTemplateOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteNotebookRuntimeTemplateRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteNotebookRuntimeTemplateOperationCallable()

Deletes a NotebookRuntimeTemplate.

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()) {
   DeleteNotebookRuntimeTemplateRequest request =
       DeleteNotebookRuntimeTemplateRequest.newBuilder()
           .setName(
               NotebookRuntimeTemplateName.of(
                       "[PROJECT]", "[LOCATION]", "[NOTEBOOK_RUNTIME_TEMPLATE]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       notebookServiceClient
           .deleteNotebookRuntimeTemplateOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }

deleteNotebookRuntimeTemplateCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteNotebookRuntimeTemplateRequest,com.google.longrunning.Operation> deleteNotebookRuntimeTemplateCallable()

Deletes a NotebookRuntimeTemplate.

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()) {
   DeleteNotebookRuntimeTemplateRequest request =
       DeleteNotebookRuntimeTemplateRequest.newBuilder()
           .setName(
               NotebookRuntimeTemplateName.of(
                       "[PROJECT]", "[LOCATION]", "[NOTEBOOK_RUNTIME_TEMPLATE]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       notebookServiceClient.deleteNotebookRuntimeTemplateCallable().futureCall(request);
   // Do something.
   future.get();
 }

updateNotebookRuntimeTemplate

public final NotebookRuntimeTemplate updateNotebookRuntimeTemplate(NotebookRuntimeTemplate notebookRuntimeTemplate,
                                                                   com.google.protobuf.FieldMask updateMask)

Updates a NotebookRuntimeTemplate.

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()) {
   NotebookRuntimeTemplate notebookRuntimeTemplate =
       NotebookRuntimeTemplate.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   NotebookRuntimeTemplate response =
       notebookServiceClient.updateNotebookRuntimeTemplate(notebookRuntimeTemplate, updateMask);
 }

Parameters:: notebookRuntimeTemplate - Required. The NotebookRuntimeTemplate to update.; updateMask - Required. The update mask applies to the resource. For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. Input format: `{paths: "${updated_filed}"}` Updatable fields:
* `encryption_spec.kms_key_name`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateNotebookRuntimeTemplate

public final NotebookRuntimeTemplate updateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest request)

Updates a NotebookRuntimeTemplate.

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()) {
   UpdateNotebookRuntimeTemplateRequest request =
       UpdateNotebookRuntimeTemplateRequest.newBuilder()
           .setNotebookRuntimeTemplate(NotebookRuntimeTemplate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   NotebookRuntimeTemplate response =
       notebookServiceClient.updateNotebookRuntimeTemplate(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateNotebookRuntimeTemplateCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> updateNotebookRuntimeTemplateCallable()

Updates a NotebookRuntimeTemplate.

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()) {
   UpdateNotebookRuntimeTemplateRequest request =
       UpdateNotebookRuntimeTemplateRequest.newBuilder()
           .setNotebookRuntimeTemplate(NotebookRuntimeTemplate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<NotebookRuntimeTemplate> future =
       notebookServiceClient.updateNotebookRuntimeTemplateCallable().futureCall(request);
   // Do something.
   NotebookRuntimeTemplate response = future.get();
 }