API v1 service for Managed Notebooks. v1
Package
@google-cloud/notebooksConstructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of ManagedNotebookServiceClient.
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
managedNotebookServiceStub
managedNotebookServiceStub?: Promise<{
[name: string]: Function;
}>;
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
checkCreateRuntimeProgress(name)
checkCreateRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
Check the status of the long running operation returned by createRuntime()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `parent=projects/{project_id}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. User-defined unique ID of this Runtime.
*/
// const runtimeId = 'abc123'
/**
* Required. The Runtime to be created.
*/
// const runtime = {}
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callCreateRuntime() {
// Construct request
const request = {
parent,
runtimeId,
runtime,
};
// Run request
const [operation] = await notebooksClient.createRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateRuntime();
checkDeleteRuntimeProgress(name)
checkDeleteRuntimeProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.notebooks.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteRuntime()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.notebooks.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callDeleteRuntime() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await notebooksClient.deleteRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteRuntime();
checkReportRuntimeEventProgress(name)
checkReportRuntimeEventProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
Check the status of the long running operation returned by reportRuntimeEvent()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
/**
* Required. The VM hardware token for authenticating the VM.
* https://cloud.google.com/compute/docs/instances/verifying-instance-identity
*/
// const vmId = 'abc123'
/**
* Required. The Event to be reported.
*/
// const event = {}
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callReportRuntimeEvent() {
// Construct request
const request = {
name,
vmId,
event,
};
// Run request
const [operation] = await notebooksClient.reportRuntimeEvent(request);
const [response] = await operation.promise();
console.log(response);
}
callReportRuntimeEvent();
checkResetRuntimeProgress(name)
checkResetRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
Check the status of the long running operation returned by resetRuntime()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callResetRuntime() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await notebooksClient.resetRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callResetRuntime();
checkStartRuntimeProgress(name)
checkStartRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
Check the status of the long running operation returned by startRuntime()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callStartRuntime() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await notebooksClient.startRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callStartRuntime();
checkStopRuntimeProgress(name)
checkStopRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
Check the status of the long running operation returned by stopRuntime()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callStopRuntime() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await notebooksClient.stopRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callStopRuntime();
checkSwitchRuntimeProgress(name)
checkSwitchRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
Check the status of the long running operation returned by switchRuntime()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
/**
* machine type.
*/
// const machineType = 'abc123'
/**
* accelerator config.
*/
// const acceleratorConfig = {}
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callSwitchRuntime() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await notebooksClient.switchRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callSwitchRuntime();
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createRuntime(request, options)
createRuntime(request?: protos.google.cloud.notebooks.v1.ICreateRuntimeRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Creates a new Runtime in a given project and location.
Name | Description |
request |
protos.google.cloud.notebooks.v1.ICreateRuntimeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `parent=projects/{project_id}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. User-defined unique ID of this Runtime.
*/
// const runtimeId = 'abc123'
/**
* Required. The Runtime to be created.
*/
// const runtime = {}
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callCreateRuntime() {
// Construct request
const request = {
parent,
runtimeId,
runtime,
};
// Run request
const [operation] = await notebooksClient.createRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateRuntime();
createRuntime(request, options, callback)
createRuntime(request: protos.google.cloud.notebooks.v1.ICreateRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.ICreateRuntimeRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
createRuntime(request, callback)
createRuntime(request: protos.google.cloud.notebooks.v1.ICreateRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.ICreateRuntimeRequest
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteRuntime(request, options)
deleteRuntime(request?: protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Deletes a single Runtime.
Name | Description |
request |
protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callDeleteRuntime() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await notebooksClient.deleteRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteRuntime();
deleteRuntime(request, options, callback)
deleteRuntime(request: protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteRuntime(request, callback)
deleteRuntime(request: protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
environmentPath(project, environment)
environmentPath(project: string, environment: string): string;
Return a fully-qualified environment resource name string.
Name | Description |
project |
string
|
environment |
string
|
Type | Description |
string | {string} Resource name string. |
executionPath(project, location, execution)
executionPath(project: string, location: string, execution: string): string;
Return a fully-qualified execution resource name string.
Name | Description |
project |
string
|
location |
string
|
execution |
string
|
Type | Description |
string | {string} Resource name string. |
getProjectId()
getProjectId(): Promise<string>;
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Type | Description |
void |
getRuntime(request, options)
getRuntime(request?: protos.google.cloud.notebooks.v1.IGetRuntimeRequest, options?: CallOptions): Promise<[protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IGetRuntimeRequest | undefined, {} | undefined]>;
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.
Name | Description |
request |
protos.google.cloud.notebooks.v1.IGetRuntimeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IGetRuntimeRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Runtime]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callGetRuntime() {
// Construct request
const request = {
name,
};
// Run request
const response = await notebooksClient.getRuntime(request);
console.log(response);
}
callGetRuntime();
getRuntime(request, options, callback)
getRuntime(request: protos.google.cloud.notebooks.v1.IGetRuntimeRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IGetRuntimeRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IGetRuntimeRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IGetRuntimeRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getRuntime(request, callback)
getRuntime(request: protos.google.cloud.notebooks.v1.IGetRuntimeRequest, callback: Callback<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IGetRuntimeRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IGetRuntimeRequest
|
callback |
Callback<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IGetRuntimeRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Type | Description |
Promise<{ [name: string]: Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
instancePath(project, instance)
instancePath(project: string, instance: string): string;
Return a fully-qualified instance resource name string.
Name | Description |
project |
string
|
instance |
string
|
Type | Description |
string | {string} Resource name string. |
listRuntimes(request, options)
listRuntimes(request?: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options?: CallOptions): Promise<[protos.google.cloud.notebooks.v1.IRuntime[], protos.google.cloud.notebooks.v1.IListRuntimesRequest | null, protos.google.cloud.notebooks.v1.IListRuntimesResponse]>;
Lists Runtimes in a given project and location.
Name | Description |
request |
protos.google.cloud.notebooks.v1.IListRuntimesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.cloud.notebooks.v1.IRuntime[], protos.google.cloud.notebooks.v1.IListRuntimesRequest | null, protos.google.cloud.notebooks.v1.IListRuntimesResponse]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Runtime]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listRuntimes(request, options, callback)
listRuntimes(request: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.notebooks.v1.IListRuntimesRequest, protos.google.cloud.notebooks.v1.IListRuntimesResponse | null | undefined, protos.google.cloud.notebooks.v1.IRuntime>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IListRuntimesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.notebooks.v1.IListRuntimesRequest, protos.google.cloud.notebooks.v1.IListRuntimesResponse | null | undefined, protos.google.cloud.notebooks.v1.IRuntime>
|
Type | Description |
void |
listRuntimes(request, callback)
listRuntimes(request: protos.google.cloud.notebooks.v1.IListRuntimesRequest, callback: PaginationCallback<protos.google.cloud.notebooks.v1.IListRuntimesRequest, protos.google.cloud.notebooks.v1.IListRuntimesResponse | null | undefined, protos.google.cloud.notebooks.v1.IRuntime>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IListRuntimesRequest
|
callback |
PaginationCallback<protos.google.cloud.notebooks.v1.IListRuntimesRequest, protos.google.cloud.notebooks.v1.IListRuntimesResponse | null | undefined, protos.google.cloud.notebooks.v1.IRuntime>
|
Type | Description |
void |
listRuntimesAsync(request, options)
listRuntimesAsync(request?: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.notebooks.v1.IRuntime>;
Equivalent to listRuntimes
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.cloud.notebooks.v1.IListRuntimesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.notebooks.v1.IRuntime> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Runtime]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `parent=projects/{project_id}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Maximum return size of the list call.
*/
// const pageSize = 1234
/**
* A previous returned page token that can be used to continue listing
* from the last result.
*/
// const pageToken = 'abc123'
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callListRuntimes() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await notebooksClient.listRuntimesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListRuntimes();
listRuntimesStream(request, options)
listRuntimesStream(request?: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.notebooks.v1.IListRuntimesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Transform | {Stream} An object stream which emits an object representing [Runtime] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
locationPath(project, location)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Name | Description |
project |
string
|
location |
string
|
Type | Description |
string | {string} Resource name string. |
matchEnvironmentFromEnvironmentName(environmentName)
matchEnvironmentFromEnvironmentName(environmentName: string): string | number;
Parse the environment from Environment resource.
Name | Description |
environmentName |
string
A fully-qualified path representing Environment resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchExecutionFromExecutionName(executionName)
matchExecutionFromExecutionName(executionName: string): string | number;
Parse the execution from Execution resource.
Name | Description |
executionName |
string
A fully-qualified path representing Execution resource. |
Type | Description |
string | number | {string} A string representing the execution. |
matchInstanceFromInstanceName(instanceName)
matchInstanceFromInstanceName(instanceName: string): string | number;
Parse the instance from Instance resource.
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource. |
Type | Description |
string | number | {string} A string representing the instance. |
matchLocationFromExecutionName(executionName)
matchLocationFromExecutionName(executionName: string): string | number;
Parse the location from Execution resource.
Name | Description |
executionName |
string
A fully-qualified path representing Execution resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromRuntimeName(runtimeName)
matchLocationFromRuntimeName(runtimeName: string): string | number;
Parse the location from Runtime resource.
Name | Description |
runtimeName |
string
A fully-qualified path representing Runtime resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromScheduleName(scheduleName)
matchLocationFromScheduleName(scheduleName: string): string | number;
Parse the location from Schedule resource.
Name | Description |
scheduleName |
string
A fully-qualified path representing Schedule resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchProjectFromEnvironmentName(environmentName)
matchProjectFromEnvironmentName(environmentName: string): string | number;
Parse the project from Environment resource.
Name | Description |
environmentName |
string
A fully-qualified path representing Environment resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromExecutionName(executionName)
matchProjectFromExecutionName(executionName: string): string | number;
Parse the project from Execution resource.
Name | Description |
executionName |
string
A fully-qualified path representing Execution resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromInstanceName(instanceName)
matchProjectFromInstanceName(instanceName: string): string | number;
Parse the project from Instance resource.
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Name | Description |
projectName |
string
A fully-qualified path representing Project resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromRuntimeName(runtimeName)
matchProjectFromRuntimeName(runtimeName: string): string | number;
Parse the project from Runtime resource.
Name | Description |
runtimeName |
string
A fully-qualified path representing Runtime resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromScheduleName(scheduleName)
matchProjectFromScheduleName(scheduleName: string): string | number;
Parse the project from Schedule resource.
Name | Description |
scheduleName |
string
A fully-qualified path representing Schedule resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchRuntimeFromRuntimeName(runtimeName)
matchRuntimeFromRuntimeName(runtimeName: string): string | number;
Parse the runtime from Runtime resource.
Name | Description |
runtimeName |
string
A fully-qualified path representing Runtime resource. |
Type | Description |
string | number | {string} A string representing the runtime. |
matchScheduleFromScheduleName(scheduleName)
matchScheduleFromScheduleName(scheduleName: string): string | number;
Parse the schedule from Schedule resource.
Name | Description |
scheduleName |
string
A fully-qualified path representing Schedule resource. |
Type | Description |
string | number | {string} A string representing the schedule. |
projectPath(project)
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Name | Description |
project |
string
|
Type | Description |
string | {string} Resource name string. |
reportRuntimeEvent(request, options)
reportRuntimeEvent(request?: protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Report and process a runtime event.
Name | Description |
request |
protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
/**
* Required. The VM hardware token for authenticating the VM.
* https://cloud.google.com/compute/docs/instances/verifying-instance-identity
*/
// const vmId = 'abc123'
/**
* Required. The Event to be reported.
*/
// const event = {}
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callReportRuntimeEvent() {
// Construct request
const request = {
name,
vmId,
event,
};
// Run request
const [operation] = await notebooksClient.reportRuntimeEvent(request);
const [response] = await operation.promise();
console.log(response);
}
callReportRuntimeEvent();
reportRuntimeEvent(request, options, callback)
reportRuntimeEvent(request: protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
reportRuntimeEvent(request, callback)
reportRuntimeEvent(request: protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
resetRuntime(request, options)
resetRuntime(request?: protos.google.cloud.notebooks.v1.IResetRuntimeRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Resets a Managed Notebook Runtime.
Name | Description |
request |
protos.google.cloud.notebooks.v1.IResetRuntimeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callResetRuntime() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await notebooksClient.resetRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callResetRuntime();
resetRuntime(request, options, callback)
resetRuntime(request: protos.google.cloud.notebooks.v1.IResetRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IResetRuntimeRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
resetRuntime(request, callback)
resetRuntime(request: protos.google.cloud.notebooks.v1.IResetRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IResetRuntimeRequest
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
runtimePath(project, location, runtime)
runtimePath(project: string, location: string, runtime: string): string;
Return a fully-qualified runtime resource name string.
Name | Description |
project |
string
|
location |
string
|
runtime |
string
|
Type | Description |
string | {string} Resource name string. |
schedulePath(project, location, schedule)
schedulePath(project: string, location: string, schedule: string): string;
Return a fully-qualified schedule resource name string.
Name | Description |
project |
string
|
location |
string
|
schedule |
string
|
Type | Description |
string | {string} Resource name string. |
startRuntime(request, options)
startRuntime(request?: protos.google.cloud.notebooks.v1.IStartRuntimeRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance
Name | Description |
request |
protos.google.cloud.notebooks.v1.IStartRuntimeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callStartRuntime() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await notebooksClient.startRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callStartRuntime();
startRuntime(request, options, callback)
startRuntime(request: protos.google.cloud.notebooks.v1.IStartRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IStartRuntimeRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
startRuntime(request, callback)
startRuntime(request: protos.google.cloud.notebooks.v1.IStartRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IStartRuntimeRequest
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
stopRuntime(request, options)
stopRuntime(request?: protos.google.cloud.notebooks.v1.IStopRuntimeRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance
Name | Description |
request |
protos.google.cloud.notebooks.v1.IStopRuntimeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callStopRuntime() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await notebooksClient.stopRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callStopRuntime();
stopRuntime(request, options, callback)
stopRuntime(request: protos.google.cloud.notebooks.v1.IStopRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IStopRuntimeRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
stopRuntime(request, callback)
stopRuntime(request: protos.google.cloud.notebooks.v1.IStopRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.IStopRuntimeRequest
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
switchRuntime(request, options)
switchRuntime(request?: protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Switch a Managed Notebook Runtime.
Name | Description |
request |
protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format:
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
*/
// const name = 'abc123'
/**
* machine type.
*/
// const machineType = 'abc123'
/**
* accelerator config.
*/
// const acceleratorConfig = {}
// Imports the Notebooks library
const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;
// Instantiates a client
const notebooksClient = new ManagedNotebookServiceClient();
async function callSwitchRuntime() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await notebooksClient.switchRuntime(request);
const [response] = await operation.promise();
console.log(response);
}
callSwitchRuntime();
switchRuntime(request, options, callback)
switchRuntime(request: protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
switchRuntime(request, callback)
switchRuntime(request: protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest
|
callback |
Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |