- 1.50.0 (latest)
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.3
- 1.0.6
- 0.6.2
GitHub Repository | Product Reference |
Service Description: API v1beta1 service for Cloud AI Platform Notebooks.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
GetInstanceRequest request = GetInstanceRequest.newBuilder().setName("name3373707").build();
Instance response = notebookServiceClient.getInstance(request);
}
Note: close() needs to be called on the NotebookServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
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 |
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 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.
Static Methods
create()
public static final NotebookServiceClient create()
Constructs an instance of NotebookServiceClient with default settings.
Returns | |
---|---|
Type | Description |
NotebookServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(NotebookServiceSettings settings)
public static final NotebookServiceClient create(NotebookServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
NotebookServiceSettings |
Returns | |
---|---|
Type | Description |
NotebookServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(NotebookServiceStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub |
NotebookServiceStub |
Returns | |
---|---|
Type | Description |
NotebookServiceClient |
Constructors
NotebookServiceClient(NotebookServiceSettings settings)
protected NotebookServiceClient(NotebookServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
NotebookServiceSettings |
NotebookServiceClient(NotebookServiceStub stub)
protected NotebookServiceClient(NotebookServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
NotebookServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createEnvironmentAsync(CreateEnvironmentRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
CreateEnvironmentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Environment,OperationMetadata> |
createEnvironmentCallable()
public final UnaryCallable<CreateEnvironmentRequest,Operation> createEnvironmentCallable()
Creates a new Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
CreateEnvironmentRequest request =
CreateEnvironmentRequest.newBuilder()
.setParent("parent-995424086")
.setEnvironmentId("environmentId-950205810")
.setEnvironment(Environment.newBuilder().build())
.build();
ApiFuture<Operation> future =
notebookServiceClient.createEnvironmentCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateEnvironmentRequest,Operation> |
createEnvironmentOperationCallable()
public final OperationCallable<CreateEnvironmentRequest,Environment,OperationMetadata> createEnvironmentOperationCallable()
Creates a new Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
CreateEnvironmentRequest request =
CreateEnvironmentRequest.newBuilder()
.setParent("parent-995424086")
.setEnvironmentId("environmentId-950205810")
.setEnvironment(Environment.newBuilder().build())
.build();
OperationFuture<Environment, OperationMetadata> future =
notebookServiceClient.createEnvironmentOperationCallable().futureCall(request);
// Do something.
Environment response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateEnvironmentRequest,Environment,OperationMetadata> |
createInstanceAsync(CreateInstanceRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
CreateInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createInstanceCallable()
public final UnaryCallable<CreateInstanceRequest,Operation> createInstanceCallable()
Creates a new Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent("parent-995424086")
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.build();
ApiFuture<Operation> future =
notebookServiceClient.createInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateInstanceRequest,Operation> |
createInstanceOperationCallable()
public final OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationCallable()
Creates a new Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent("parent-995424086")
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.createInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> |
deleteEnvironmentAsync(DeleteEnvironmentRequest request)
public final OperationFuture<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();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteEnvironmentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteEnvironmentCallable()
public final UnaryCallable<DeleteEnvironmentRequest,Operation> deleteEnvironmentCallable()
Deletes a single Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
DeleteEnvironmentRequest request =
DeleteEnvironmentRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation> future =
notebookServiceClient.deleteEnvironmentCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteEnvironmentRequest,Operation> |
deleteEnvironmentOperationCallable()
public final OperationCallable<DeleteEnvironmentRequest,Empty,OperationMetadata> deleteEnvironmentOperationCallable()
Deletes a single Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
DeleteEnvironmentRequest request =
DeleteEnvironmentRequest.newBuilder().setName("name3373707").build();
OperationFuture<Empty, OperationMetadata> future =
notebookServiceClient.deleteEnvironmentOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteEnvironmentRequest,Empty,OperationMetadata> |
deleteInstanceAsync(DeleteInstanceRequest request)
public final OperationFuture<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();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteInstanceCallable()
public final UnaryCallable<DeleteInstanceRequest,Operation> deleteInstanceCallable()
Deletes a single Instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation> future =
notebookServiceClient.deleteInstanceCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteInstanceRequest,Operation> |
deleteInstanceOperationCallable()
public final OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationCallable()
Deletes a single Instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder().setName("name3373707").build();
OperationFuture<Empty, OperationMetadata> future =
notebookServiceClient.deleteInstanceOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata> |
getEnvironment(GetEnvironmentRequest request)
public final Environment getEnvironment(GetEnvironmentRequest request)
Gets details of a single Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
GetEnvironmentRequest request =
GetEnvironmentRequest.newBuilder().setName("name3373707").build();
Environment response = notebookServiceClient.getEnvironment(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetEnvironmentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Environment |
getEnvironmentCallable()
public final UnaryCallable<GetEnvironmentRequest,Environment> getEnvironmentCallable()
Gets details of a single Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
GetEnvironmentRequest request =
GetEnvironmentRequest.newBuilder().setName("name3373707").build();
ApiFuture<Environment> future =
notebookServiceClient.getEnvironmentCallable().futureCall(request);
// Do something.
Environment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetEnvironmentRequest,Environment> |
getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(GetIamPolicyRequest request)
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource("GetIamPolicyRequest-1527610370".toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = notebookServiceClient.getIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource("GetIamPolicyRequest-1527610370".toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future = notebookServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getInstance(GetInstanceRequest request)
public final Instance getInstance(GetInstanceRequest request)
Gets details of a single Instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
GetInstanceRequest request = GetInstanceRequest.newBuilder().setName("name3373707").build();
Instance response = notebookServiceClient.getInstance(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Instance |
getInstanceCallable()
public final UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()
Gets details of a single Instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
GetInstanceRequest request = GetInstanceRequest.newBuilder().setName("name3373707").build();
ApiFuture<Instance> future = notebookServiceClient.getInstanceCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetInstanceRequest,Instance> |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = notebookServiceClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = notebookServiceClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getSettings()
public final NotebookServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
NotebookServiceSettings |
getStub()
public NotebookServiceStub getStub()
Returns | |
---|---|
Type | Description |
NotebookServiceStub |
isInstanceUpgradeable(IsInstanceUpgradeableRequest request) (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);
}
Parameter | |
---|---|
Name | Description |
request |
IsInstanceUpgradeableRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
IsInstanceUpgradeableResponse |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<IsInstanceUpgradeableRequest,IsInstanceUpgradeableResponse> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listEnvironments(ListEnvironmentsRequest request)
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);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListEnvironmentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
NotebookServiceClient.ListEnvironmentsPagedResponse |
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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse> |
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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsPagedResponse> |
listInstances(ListInstancesRequest request)
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);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListInstancesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
NotebookServiceClient.ListInstancesPagedResponse |
listInstancesCallable()
public final UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()
Lists instances in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
ListInstancesRequest request =
ListInstancesRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListInstancesResponse response =
notebookServiceClient.listInstancesCallable().call(request);
for (Instance element : response.getInstancesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListInstancesRequest,ListInstancesResponse> |
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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListInstancesRequest,ListInstancesPagedResponse> |
listLocations(ListLocationsRequest request)
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);
}
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
NotebookServiceClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
notebookServiceClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
registerInstanceAsync(RegisterInstanceRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
RegisterInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
registerInstanceCallable()
public final UnaryCallable<RegisterInstanceRequest,Operation> registerInstanceCallable()
Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
RegisterInstanceRequest request =
RegisterInstanceRequest.newBuilder()
.setParent("parent-995424086")
.setInstanceId("instanceId902024336")
.build();
ApiFuture<Operation> future =
notebookServiceClient.registerInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<RegisterInstanceRequest,Operation> |
registerInstanceOperationCallable()
public final OperationCallable<RegisterInstanceRequest,Instance,OperationMetadata> registerInstanceOperationCallable()
Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
RegisterInstanceRequest request =
RegisterInstanceRequest.newBuilder()
.setParent("parent-995424086")
.setInstanceId("instanceId902024336")
.build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.registerInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<RegisterInstanceRequest,Instance,OperationMetadata> |
reportInstanceInfoAsync(ReportInstanceInfoRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
ReportInstanceInfoRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
reportInstanceInfoCallable()
public final UnaryCallable<ReportInstanceInfoRequest,Operation> reportInstanceInfoCallable()
Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
ReportInstanceInfoRequest request =
ReportInstanceInfoRequest.newBuilder()
.setName("name3373707")
.setVmId("vmId3622450")
.putAllMetadata(new HashMap<String, String>())
.build();
ApiFuture<Operation> future =
notebookServiceClient.reportInstanceInfoCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ReportInstanceInfoRequest,Operation> |
reportInstanceInfoOperationCallable()
public final OperationCallable<ReportInstanceInfoRequest,Instance,OperationMetadata> reportInstanceInfoOperationCallable()
Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
ReportInstanceInfoRequest request =
ReportInstanceInfoRequest.newBuilder()
.setName("name3373707")
.setVmId("vmId3622450")
.putAllMetadata(new HashMap<String, String>())
.build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.reportInstanceInfoOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ReportInstanceInfoRequest,Instance,OperationMetadata> |
resetInstanceAsync(ResetInstanceRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
ResetInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
resetInstanceCallable()
public final UnaryCallable<ResetInstanceRequest,Operation> resetInstanceCallable()
Resets a notebook instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
ResetInstanceRequest request =
ResetInstanceRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation> future =
notebookServiceClient.resetInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ResetInstanceRequest,Operation> |
resetInstanceOperationCallable()
public final OperationCallable<ResetInstanceRequest,Instance,OperationMetadata> resetInstanceOperationCallable()
Resets a notebook instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
ResetInstanceRequest request =
ResetInstanceRequest.newBuilder().setName("name3373707").build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.resetInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ResetInstanceRequest,Instance,OperationMetadata> |
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource("SetIamPolicyRequest1223629066".toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = notebookServiceClient.setIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource("SetIamPolicyRequest1223629066".toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future = notebookServiceClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
setInstanceAcceleratorAsync(SetInstanceAcceleratorRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
SetInstanceAcceleratorRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SetInstanceAcceleratorRequest,Operation> |
setInstanceAcceleratorOperationCallable()
public final OperationCallable<SetInstanceAcceleratorRequest,Instance,OperationMetadata> setInstanceAcceleratorOperationCallable()
Updates the guest accelerators of a single Instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
SetInstanceAcceleratorRequest request =
SetInstanceAcceleratorRequest.newBuilder()
.setName("name3373707")
.setCoreCount(-1963855761)
.build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.setInstanceAcceleratorOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<SetInstanceAcceleratorRequest,Instance,OperationMetadata> |
setInstanceLabelsAsync(SetInstanceLabelsRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
SetInstanceLabelsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
setInstanceLabelsCallable()
public final UnaryCallable<SetInstanceLabelsRequest,Operation> setInstanceLabelsCallable()
Updates the labels of an Instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
SetInstanceLabelsRequest request =
SetInstanceLabelsRequest.newBuilder()
.setName("name3373707")
.putAllLabels(new HashMap<String, String>())
.build();
ApiFuture<Operation> future =
notebookServiceClient.setInstanceLabelsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SetInstanceLabelsRequest,Operation> |
setInstanceLabelsOperationCallable()
public final OperationCallable<SetInstanceLabelsRequest,Instance,OperationMetadata> setInstanceLabelsOperationCallable()
Updates the labels of an Instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
SetInstanceLabelsRequest request =
SetInstanceLabelsRequest.newBuilder()
.setName("name3373707")
.putAllLabels(new HashMap<String, String>())
.build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.setInstanceLabelsOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<SetInstanceLabelsRequest,Instance,OperationMetadata> |
setInstanceMachineTypeAsync(SetInstanceMachineTypeRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
SetInstanceMachineTypeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SetInstanceMachineTypeRequest,Operation> |
setInstanceMachineTypeOperationCallable()
public final OperationCallable<SetInstanceMachineTypeRequest,Instance,OperationMetadata> setInstanceMachineTypeOperationCallable()
Updates the machine type of a single Instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
SetInstanceMachineTypeRequest request =
SetInstanceMachineTypeRequest.newBuilder()
.setName("name3373707")
.setMachineType("machineType-218117087")
.build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.setInstanceMachineTypeOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<SetInstanceMachineTypeRequest,Instance,OperationMetadata> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
startInstanceAsync(StartInstanceRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
StartInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
startInstanceCallable()
public final UnaryCallable<StartInstanceRequest,Operation> startInstanceCallable()
Starts a notebook instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
StartInstanceRequest request =
StartInstanceRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation> future =
notebookServiceClient.startInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<StartInstanceRequest,Operation> |
startInstanceOperationCallable()
public final OperationCallable<StartInstanceRequest,Instance,OperationMetadata> startInstanceOperationCallable()
Starts a notebook instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
StartInstanceRequest request =
StartInstanceRequest.newBuilder().setName("name3373707").build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.startInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<StartInstanceRequest,Instance,OperationMetadata> |
stopInstanceAsync(StopInstanceRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
StopInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
stopInstanceCallable()
public final UnaryCallable<StopInstanceRequest,Operation> stopInstanceCallable()
Stops a notebook instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
StopInstanceRequest request = StopInstanceRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation> future =
notebookServiceClient.stopInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<StopInstanceRequest,Operation> |
stopInstanceOperationCallable()
public final OperationCallable<StopInstanceRequest,Instance,OperationMetadata> stopInstanceOperationCallable()
Stops a notebook instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
StopInstanceRequest request = StopInstanceRequest.newBuilder().setName("name3373707").build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.stopInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<StopInstanceRequest,Instance,OperationMetadata> |
testIamPermissions(TestIamPermissionsRequest request)
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource("TestIamPermissionsRequest942398222".toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response = notebookServiceClient.testIamPermissions(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
upgradeInstanceAsync(UpgradeInstanceRequest request) (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();
}
Parameter | |
---|---|
Name | Description |
request |
UpgradeInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
upgradeInstanceCallable() (deprecated)
public final UnaryCallable<UpgradeInstanceRequest,Operation> upgradeInstanceCallable()
Deprecated. This method is deprecated and will be removed in the next major version update.
Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
UpgradeInstanceRequest request =
UpgradeInstanceRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation> future =
notebookServiceClient.upgradeInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpgradeInstanceRequest,Operation> |
upgradeInstanceInternalAsync(UpgradeInstanceInternalRequest request) (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();
}
Parameter | |
---|---|
Name | Description |
request |
UpgradeInstanceInternalRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpgradeInstanceInternalRequest,Operation> |
upgradeInstanceInternalOperationCallable() (deprecated)
public final OperationCallable<UpgradeInstanceInternalRequest,Instance,OperationMetadata> upgradeInstanceInternalOperationCallable()
Deprecated. This method is deprecated and will be removed in the next major version update.
Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly. Deprecated. Please consider using v1.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
UpgradeInstanceInternalRequest request =
UpgradeInstanceInternalRequest.newBuilder()
.setName("name3373707")
.setVmId("vmId3622450")
.build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.upgradeInstanceInternalOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<UpgradeInstanceInternalRequest,Instance,OperationMetadata> |
upgradeInstanceOperationCallable() (deprecated)
public final OperationCallable<UpgradeInstanceRequest,Instance,OperationMetadata> upgradeInstanceOperationCallable()
Deprecated. This method is deprecated and will be removed in the next major version update.
Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (NotebookServiceClient notebookServiceClient = NotebookServiceClient.create()) {
UpgradeInstanceRequest request =
UpgradeInstanceRequest.newBuilder().setName("name3373707").build();
OperationFuture<Instance, OperationMetadata> future =
notebookServiceClient.upgradeInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<UpgradeInstanceRequest,Instance,OperationMetadata> |