@google-cloud/notebooks
Advanced tools
Comparing version 1.3.1 to 2.0.0
import * as v1 from './v1'; | ||
import * as v1beta1 from './v1beta1'; | ||
declare const NotebookServiceClient: typeof v1beta1.NotebookServiceClient; | ||
declare type NotebookServiceClient = v1beta1.NotebookServiceClient; | ||
export { v1, v1beta1, NotebookServiceClient }; | ||
declare const ManagedNotebookServiceClient: typeof v1.ManagedNotebookServiceClient; | ||
declare type ManagedNotebookServiceClient = v1.ManagedNotebookServiceClient; | ||
declare const NotebookServiceClient: typeof v1.NotebookServiceClient; | ||
declare type NotebookServiceClient = v1.NotebookServiceClient; | ||
export { v1, v1beta1, ManagedNotebookServiceClient, NotebookServiceClient }; | ||
declare const _default: { | ||
v1: typeof v1; | ||
v1beta1: typeof v1beta1; | ||
NotebookServiceClient: typeof v1beta1.NotebookServiceClient; | ||
ManagedNotebookServiceClient: typeof v1.ManagedNotebookServiceClient; | ||
NotebookServiceClient: typeof v1.NotebookServiceClient; | ||
}; | ||
@@ -11,0 +14,0 @@ export default _default; |
@@ -20,3 +20,3 @@ "use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.protos = exports.NotebookServiceClient = exports.v1beta1 = exports.v1 = void 0; | ||
exports.protos = exports.NotebookServiceClient = exports.ManagedNotebookServiceClient = exports.v1beta1 = exports.v1 = void 0; | ||
const v1 = require("./v1"); | ||
@@ -26,7 +26,14 @@ exports.v1 = v1; | ||
exports.v1beta1 = v1beta1; | ||
const NotebookServiceClient = v1beta1.NotebookServiceClient; | ||
const ManagedNotebookServiceClient = v1.ManagedNotebookServiceClient; | ||
exports.ManagedNotebookServiceClient = ManagedNotebookServiceClient; | ||
const NotebookServiceClient = v1.NotebookServiceClient; | ||
exports.NotebookServiceClient = NotebookServiceClient; | ||
exports.default = { v1, v1beta1, NotebookServiceClient }; | ||
exports.default = { | ||
v1, | ||
v1beta1, | ||
ManagedNotebookServiceClient, | ||
NotebookServiceClient, | ||
}; | ||
const protos = require("../protos/protos"); | ||
exports.protos = protos; | ||
//# sourceMappingURL=index.js.map |
"use strict"; | ||
// Copyright 2021 Google LLC | ||
// Copyright 2022 Google LLC | ||
// | ||
@@ -20,2 +20,3 @@ // Licensed under the Apache License, Version 2.0 (the "License"); | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.NotebookServiceClient = exports.ManagedNotebookServiceClient = void 0; | ||
var managed_notebook_service_client_1 = require("./managed_notebook_service_client"); | ||
@@ -22,0 +23,0 @@ Object.defineProperty(exports, "ManagedNotebookServiceClient", { enumerable: true, get: function () { return managed_notebook_service_client_1.ManagedNotebookServiceClient; } }); |
@@ -70,2 +70,7 @@ { | ||
"retry_params_name": "default" | ||
}, | ||
"RefreshRuntimeTokenInternal": { | ||
"timeout_millis": 60000, | ||
"retry_codes_name": "unavailable", | ||
"retry_params_name": "default" | ||
} | ||
@@ -72,0 +77,0 @@ } |
@@ -105,6 +105,88 @@ /// <reference types="node" /> | ||
getProjectId(callback: Callback<string, undefined, undefined>): void; | ||
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. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [Runtime]{@link google.cloud.notebooks.v1.Runtime}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.get_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_GetRuntime_async | ||
*/ | ||
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 | ||
]>; | ||
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; | ||
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; | ||
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]>; | ||
/** | ||
* Gets an access token for the consumer service account that the customer | ||
* attached to the runtime. Only accessible from the tenant instance. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {string} request.vmId | ||
* Required. The VM hardware token for authenticating the VM. | ||
* https://cloud.google.com/compute/docs/instances/verifying-instance-identity | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [RefreshRuntimeTokenInternalResponse]{@link google.cloud.notebooks.v1.RefreshRuntimeTokenInternalResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.refresh_runtime_token_internal.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_RefreshRuntimeTokenInternal_async | ||
*/ | ||
refreshRuntimeTokenInternal(request?: protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest, options?: CallOptions): Promise<[ | ||
protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalResponse, | ||
(protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest | undefined), | ||
{} | undefined | ||
]>; | ||
refreshRuntimeTokenInternal(request: protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalResponse, protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest | null | undefined, {} | null | undefined>): void; | ||
refreshRuntimeTokenInternal(request: protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest, callback: Callback<protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalResponse, protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest | null | undefined, {} | null | undefined>): void; | ||
/** | ||
* Creates a new Runtime in a given project and location. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.parent | ||
* Required. Format: | ||
* `parent=projects/{project_id}/locations/{location}` | ||
* @param {string} request.runtimeId | ||
* Required. User-defined unique ID of this Runtime. | ||
* @param {google.cloud.notebooks.v1.Runtime} request.runtime | ||
* Required. The Runtime to be created. | ||
* @param {string} request.requestId | ||
* Idempotent request UUID. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.create_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_CreateRuntime_async | ||
*/ | ||
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 | ||
]>; | ||
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; | ||
@@ -121,10 +203,33 @@ 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; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkCreateRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.create_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_CreateRuntime_async | ||
*/ | ||
checkCreateRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>; | ||
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. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {string} request.requestId | ||
* Idempotent request UUID. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.delete_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_DeleteRuntime_async | ||
*/ | ||
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 | ||
]>; | ||
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; | ||
@@ -141,10 +246,37 @@ 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; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkDeleteRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.delete_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_DeleteRuntime_async | ||
*/ | ||
checkDeleteRuntimeProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.notebooks.v1.OperationMetadata>>; | ||
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 | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {string} request.requestId | ||
* Idempotent request UUID. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.start_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_StartRuntime_async | ||
*/ | ||
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 | ||
]>; | ||
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; | ||
@@ -161,10 +293,37 @@ 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; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkStartRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.start_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_StartRuntime_async | ||
*/ | ||
checkStartRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>; | ||
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 | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {string} request.requestId | ||
* Idempotent request UUID. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.stop_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_StopRuntime_async | ||
*/ | ||
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 | ||
]>; | ||
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; | ||
@@ -181,10 +340,37 @@ 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; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkStopRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.stop_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_StopRuntime_async | ||
*/ | ||
checkStopRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>; | ||
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. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {string} request.machineType | ||
* machine type. | ||
* @param {google.cloud.notebooks.v1.RuntimeAcceleratorConfig} request.acceleratorConfig | ||
* accelerator config. | ||
* @param {string} request.requestId | ||
* Idempotent request UUID. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.switch_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_SwitchRuntime_async | ||
*/ | ||
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 | ||
]>; | ||
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; | ||
@@ -201,10 +387,33 @@ 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; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkSwitchRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.switch_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_SwitchRuntime_async | ||
*/ | ||
checkSwitchRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>; | ||
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. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {string} request.requestId | ||
* Idempotent request UUID. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.reset_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_ResetRuntime_async | ||
*/ | ||
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 | ||
]>; | ||
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; | ||
@@ -221,10 +430,36 @@ 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; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkResetRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.reset_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_ResetRuntime_async | ||
*/ | ||
checkResetRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>; | ||
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. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {string} request.vmId | ||
* Required. The VM hardware token for authenticating the VM. | ||
* https://cloud.google.com/compute/docs/instances/verifying-instance-identity | ||
* @param {google.cloud.notebooks.v1.Event} request.event | ||
* Required. The Event to be reported. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.report_runtime_event.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_ReportRuntimeEvent_async | ||
*/ | ||
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 | ||
]>; | ||
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; | ||
@@ -241,10 +476,37 @@ 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; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkReportRuntimeEventProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.report_runtime_event.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_ReportRuntimeEvent_async | ||
*/ | ||
checkReportRuntimeEventProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>; | ||
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. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.parent | ||
* Required. Format: | ||
* `parent=projects/{project_id}/locations/{location}` | ||
* @param {number} request.pageSize | ||
* Maximum return size of the list call. | ||
* @param {string} request.pageToken | ||
* A previous returned page token that can be used to continue listing | ||
* from the last result. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is Array of [Runtime]{@link google.cloud.notebooks.v1.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 `listRuntimesAsync()` | ||
* method described below for async iteration which you can stop as needed. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
* for more details and examples. | ||
*/ | ||
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 | ||
]>; | ||
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; | ||
@@ -301,7 +563,4 @@ 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; | ||
* for more details and examples. | ||
* @example | ||
* const iterable = client.listRuntimesAsync(request); | ||
* for await (const response of iterable) { | ||
* // process response | ||
* } | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.list_runtimes.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_ListRuntimes_async | ||
*/ | ||
@@ -308,0 +567,0 @@ listRuntimesAsync(request?: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.notebooks.v1.IRuntime>; |
"use strict"; | ||
// Copyright 2021 Google LLC | ||
// Copyright 2022 Google LLC | ||
// | ||
@@ -224,2 +224,3 @@ // Licensed under the Apache License, Version 2.0 (the "License"); | ||
'reportRuntimeEvent', | ||
'refreshRuntimeTokenInternal', | ||
]; | ||
@@ -285,21 +286,2 @@ for (const methodName of managedNotebookServiceStubMethods) { | ||
} | ||
/** | ||
* Gets details of a single Runtime. The location must be a regional endpoint | ||
* rather than zonal. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [Runtime]{@link google.cloud.notebooks.v1.Runtime}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example | ||
* const [response] = await client.getRuntime(request); | ||
*/ | ||
getRuntime(request, optionsOrCallback, callback) { | ||
@@ -325,27 +307,22 @@ request = request || {}; | ||
} | ||
/** | ||
* Creates a new Runtime in a given project and location. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.parent | ||
* Required. Format: | ||
* `parent=projects/{project_id}/locations/{location}` | ||
* @param {string} request.runtimeId | ||
* Required. User-defined unique ID of this Runtime. | ||
* @param {google.cloud.notebooks.v1.Runtime} request.runtime | ||
* Required. The Runtime to be created. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example | ||
* const [operation] = await client.createRuntime(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
refreshRuntimeTokenInternal(request, optionsOrCallback, callback) { | ||
request = request || {}; | ||
let options; | ||
if (typeof optionsOrCallback === 'function' && callback === undefined) { | ||
callback = optionsOrCallback; | ||
options = {}; | ||
} | ||
else { | ||
options = optionsOrCallback; | ||
} | ||
options = options || {}; | ||
options.otherArgs = options.otherArgs || {}; | ||
options.otherArgs.headers = options.otherArgs.headers || {}; | ||
options.otherArgs.headers['x-goog-request-params'] = | ||
gax.routingHeader.fromParams({ | ||
name: request.name || '', | ||
}); | ||
this.initialize(); | ||
return this.innerApiCalls.refreshRuntimeTokenInternal(request, options, callback); | ||
} | ||
createRuntime(request, optionsOrCallback, callback) { | ||
@@ -380,7 +357,4 @@ request = request || {}; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkCreateRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.create_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_CreateRuntime_async | ||
*/ | ||
@@ -393,23 +367,2 @@ async checkCreateRuntimeProgress(name) { | ||
} | ||
/** | ||
* Deletes a single Runtime. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example | ||
* const [operation] = await client.deleteRuntime(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
deleteRuntime(request, optionsOrCallback, callback) { | ||
@@ -444,7 +397,4 @@ request = request || {}; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkDeleteRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.delete_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_DeleteRuntime_async | ||
*/ | ||
@@ -457,27 +407,2 @@ async checkDeleteRuntimeProgress(name) { | ||
} | ||
/** | ||
* 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 | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example | ||
* const [operation] = await client.startRuntime(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
startRuntime(request, optionsOrCallback, callback) { | ||
@@ -512,7 +437,4 @@ request = request || {}; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkStartRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.start_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_StartRuntime_async | ||
*/ | ||
@@ -525,27 +447,2 @@ async checkStartRuntimeProgress(name) { | ||
} | ||
/** | ||
* 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 | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example | ||
* const [operation] = await client.stopRuntime(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
stopRuntime(request, optionsOrCallback, callback) { | ||
@@ -580,7 +477,4 @@ request = request || {}; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkStopRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.stop_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_StopRuntime_async | ||
*/ | ||
@@ -593,27 +487,2 @@ async checkStopRuntimeProgress(name) { | ||
} | ||
/** | ||
* Switch a Managed Notebook Runtime. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {string} request.machineType | ||
* machine type. | ||
* @param {google.cloud.notebooks.v1.RuntimeAcceleratorConfig} request.acceleratorConfig | ||
* accelerator config. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example | ||
* const [operation] = await client.switchRuntime(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
switchRuntime(request, optionsOrCallback, callback) { | ||
@@ -648,7 +517,4 @@ request = request || {}; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkSwitchRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.switch_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_SwitchRuntime_async | ||
*/ | ||
@@ -661,23 +527,2 @@ async checkSwitchRuntimeProgress(name) { | ||
} | ||
/** | ||
* Resets a Managed Notebook Runtime. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example | ||
* const [operation] = await client.resetRuntime(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
resetRuntime(request, optionsOrCallback, callback) { | ||
@@ -712,7 +557,4 @@ request = request || {}; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkResetRuntimeProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.reset_runtime.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_ResetRuntime_async | ||
*/ | ||
@@ -725,28 +567,2 @@ async checkResetRuntimeProgress(name) { | ||
} | ||
/** | ||
* Report and process a runtime event. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.name | ||
* Required. Format: | ||
* `projects/{project_id}/locations/{location}/runtimes/{runtime_id}` | ||
* @param {string} request.vmId | ||
* Required. The VM hardware token for authenticating the VM. | ||
* https://cloud.google.com/compute/docs/instances/verifying-instance-identity | ||
* @param {google.cloud.notebooks.v1.Event} request.event | ||
* Required. The Event to be reported. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing | ||
* a long running operation. Its `promise()` method returns a promise | ||
* you can `await` for. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
* for more details and examples. | ||
* @example | ||
* const [operation] = await client.reportRuntimeEvent(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
reportRuntimeEvent(request, optionsOrCallback, callback) { | ||
@@ -781,7 +597,4 @@ request = request || {}; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkReportRuntimeEventProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.report_runtime_event.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_ReportRuntimeEvent_async | ||
*/ | ||
@@ -794,28 +607,2 @@ async checkReportRuntimeEventProgress(name) { | ||
} | ||
/** | ||
* Lists Runtimes in a given project and location. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {string} request.parent | ||
* Required. Format: | ||
* `parent=projects/{project_id}/locations/{location}` | ||
* @param {number} request.pageSize | ||
* Maximum return size of the list call. | ||
* @param {string} request.pageToken | ||
* A previous returned page token that can be used to continue listing | ||
* from the last result. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is Array of [Runtime]{@link google.cloud.notebooks.v1.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 `listRuntimesAsync()` | ||
* method described below for async iteration which you can stop as needed. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
* for more details and examples. | ||
*/ | ||
listRuntimes(request, optionsOrCallback, callback) { | ||
@@ -874,3 +661,4 @@ request = request || {}; | ||
}); | ||
const callSettings = new gax.CallSettings(options); | ||
const defaultCallSettings = this._defaults['listRuntimes']; | ||
const callSettings = defaultCallSettings.merge(options); | ||
this.initialize(); | ||
@@ -903,7 +691,4 @@ return this.descriptors.page.listRuntimes.createStream(this.innerApiCalls.listRuntimes, request, callSettings); | ||
* for more details and examples. | ||
* @example | ||
* const iterable = client.listRuntimesAsync(request); | ||
* for await (const response of iterable) { | ||
* // process response | ||
* } | ||
* @example <caption>include:samples/generated/v1/managed_notebook_service.list_runtimes.js</caption> | ||
* region_tag:notebooks_v1_generated_ManagedNotebookService_ListRuntimes_async | ||
*/ | ||
@@ -919,4 +704,4 @@ listRuntimesAsync(request, options) { | ||
}); | ||
options = options || {}; | ||
const callSettings = new gax.CallSettings(options); | ||
const defaultCallSettings = this._defaults['listRuntimes']; | ||
const callSettings = defaultCallSettings.merge(options); | ||
this.initialize(); | ||
@@ -1195,4 +980,3 @@ return this.descriptors.page.listRuntimes.asyncIterate(this.innerApiCalls['listRuntimes'], request, callSettings); | ||
close() { | ||
this.initialize(); | ||
if (!this._terminated) { | ||
if (this.managedNotebookServiceStub && !this._terminated) { | ||
return this.managedNotebookServiceStub.then(stub => { | ||
@@ -1199,0 +983,0 @@ this._terminated = true; |
@@ -71,2 +71,7 @@ { | ||
}, | ||
"UpdateInstanceMetadataItems": { | ||
"timeout_millis": 60000, | ||
"retry_codes_name": "unavailable", | ||
"retry_params_name": "default" | ||
}, | ||
"DeleteInstance": { | ||
@@ -73,0 +78,0 @@ "timeout_millis": 60000, |
"use strict"; | ||
// Copyright 2021 Google LLC | ||
// Copyright 2022 Google LLC | ||
// | ||
@@ -20,4 +20,5 @@ // Licensed under the Apache License, Version 2.0 (the "License"); | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.NotebookServiceClient = void 0; | ||
var notebook_service_client_1 = require("./notebook_service_client"); | ||
Object.defineProperty(exports, "NotebookServiceClient", { enumerable: true, get: function () { return notebook_service_client_1.NotebookServiceClient; } }); | ||
//# sourceMappingURL=index.js.map |
# Changelog | ||
## [2.0.0](https://github.com/googleapis/nodejs-notebooks/compare/v1.3.1...v2.0.0) (2022-06-09) | ||
### ⚠ BREAKING CHANGES | ||
* update library to use Node 12 (#140) | ||
* make v1 default service (#126) | ||
### Features | ||
* make v1 default service ([#126](https://github.com/googleapis/nodejs-notebooks/issues/126)) ([57b21a7](https://github.com/googleapis/nodejs-notebooks/commit/57b21a7926f2170afdb8536fb4ad14311ef70e90)) | ||
### Build System | ||
* update library to use Node 12 ([#140](https://github.com/googleapis/nodejs-notebooks/issues/140)) ([9a2359e](https://github.com/googleapis/nodejs-notebooks/commit/9a2359e000b052950ddab5cead1db77868499e65)) | ||
### [1.3.1](https://www.github.com/googleapis/nodejs-notebooks/compare/v1.3.0...v1.3.1) (2021-09-09) | ||
@@ -4,0 +21,0 @@ |
{ | ||
"name": "@google-cloud/notebooks", | ||
"version": "1.3.1", | ||
"version": "2.0.0", | ||
"description": "Notebooks client for Node.js", | ||
@@ -42,20 +42,20 @@ "repository": "googleapis/nodejs-notebooks", | ||
"dependencies": { | ||
"google-gax": "^2.24.1" | ||
"google-gax": "^3.0.1" | ||
}, | ||
"devDependencies": { | ||
"@types/mocha": "^8.0.3", | ||
"@types/node": "^14.6.1", | ||
"@types/mocha": "^9.0.0", | ||
"@types/node": "^16.0.0", | ||
"@types/sinon": "^10.0.0", | ||
"c8": "^7.3.0", | ||
"gts": "^2.0.2", | ||
"gts": "^3.1.0", | ||
"jsdoc": "^3.6.5", | ||
"jsdoc-fresh": "^1.0.2", | ||
"jsdoc-region-tag": "^1.0.4", | ||
"jsdoc-fresh": "^2.0.0", | ||
"jsdoc-region-tag": "^2.0.0", | ||
"linkinator": "^2.1.2", | ||
"mocha": "^8.1.2", | ||
"mocha": "^9.2.2", | ||
"null-loader": "^4.0.0", | ||
"pack-n-play": "^1.0.0-2", | ||
"sinon": "^11.0.0", | ||
"sinon": "^14.0.0", | ||
"ts-loader": "^9.0.0", | ||
"typescript": "^3.9.7", | ||
"typescript": "^4.6.4", | ||
"webpack": "^5.0.0", | ||
@@ -65,4 +65,4 @@ "webpack-cli": "^4.0.0" | ||
"engines": { | ||
"node": ">=10.0.0" | ||
"node": ">=12.0.0" | ||
} | ||
} |
@@ -7,5 +7,4 @@ [//]: # "This README.md file is auto-generated, all changes to this file will be lost." | ||
[![release level](https://img.shields.io/badge/release%20level-beta-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages) | ||
[![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages) | ||
[![npm version](https://img.shields.io/npm/v/@google-cloud/notebooks.svg)](https://www.npmjs.org/package/@google-cloud/notebooks) | ||
[![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-notebooks/main.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-notebooks) | ||
@@ -103,32 +102,34 @@ | ||
Node.js. | ||
If you are using an end-of-life version of Node.js, we recommend that you update | ||
as soon as possible to an actively supported LTS version. | ||
Google's client libraries support legacy versions of Node.js runtimes on a | ||
best-efforts basis with the following warnings: | ||
* Legacy versions are not tested in continuous integration. | ||
* Some security patches and features cannot be backported. | ||
* Dependencies cannot be kept up-to-date. | ||
Client libraries targeting some end-of-life versions of Node.js are available, and | ||
can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag). | ||
can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag). | ||
The dist-tags follow the naming convention `legacy-(version)`. | ||
For example, `npm install @google-cloud/notebooks@legacy-8` installs client libraries | ||
for versions compatible with Node.js 8. | ||
_Legacy Node.js versions are supported as a best effort:_ | ||
## Versioning | ||
* Legacy versions will not be tested in continuous integration. | ||
* Some security patches may not be able to be backported. | ||
* Dependencies will not be kept up-to-date, and features will not be backported. | ||
This library follows [Semantic Versioning](http://semver.org/). | ||
#### Legacy tags available | ||
* `legacy-8`: install client libraries from this dist-tag for versions | ||
compatible with Node.js 8. | ||
## Versioning | ||
This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways | ||
unless absolutely necessary (e.g. because of critical security issues) or with | ||
an extensive deprecation period. Issues and requests against **stable** libraries | ||
are addressed with the highest priority. | ||
This library follows [Semantic Versioning](http://semver.org/). | ||
This library is considered to be in **beta**. This means it is expected to be | ||
mostly stable while we work toward a general availability release; however, | ||
complete stability is not guaranteed. We will address issues and requests | ||
against beta libraries with a high priority. | ||
More Information: [Google Cloud Platform Launch Stages][launch_stages] | ||
@@ -135,0 +136,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
4796944
73528
160
+ Added@babel/helper-string-parser@7.25.9(transitive)
+ Added@babel/helper-validator-identifier@7.25.9(transitive)
+ Added@babel/parser@7.26.2(transitive)
+ Added@babel/types@7.26.0(transitive)
+ Added@grpc/grpc-js@1.8.22(transitive)
+ Added@jsdoc/salty@0.2.8(transitive)
+ Added@types/glob@8.1.0(transitive)
+ Added@types/linkify-it@5.0.0(transitive)
+ Added@types/markdown-it@14.1.2(transitive)
+ Added@types/mdurl@2.0.0(transitive)
+ Added@types/minimatch@5.1.2(transitive)
+ Added@types/rimraf@3.0.2(transitive)
+ Addedacorn@8.14.0(transitive)
+ Addedacorn-jsx@5.3.2(transitive)
+ Addedargparse@2.0.1(transitive)
+ Addedbalanced-match@1.0.2(transitive)
+ Addedbluebird@3.7.2(transitive)
+ Addedbrace-expansion@2.0.1(transitive)
+ Addedcatharsis@0.9.0(transitive)
+ Addedchalk@4.1.2(transitive)
+ Addeddeep-is@0.1.4(transitive)
+ Addedentities@4.5.0(transitive)
+ Addedescape-string-regexp@2.0.0(transitive)
+ Addedescodegen@1.14.3(transitive)
+ Addedeslint-visitor-keys@3.4.3(transitive)
+ Addedespree@9.6.1(transitive)
+ Addedesprima@4.0.1(transitive)
+ Addedestraverse@4.3.05.3.0(transitive)
+ Addedesutils@2.0.3(transitive)
+ Addedfast-levenshtein@2.0.6(transitive)
+ Addedfs.realpath@1.0.0(transitive)
+ Addedgaxios@5.1.3(transitive)
+ Addedgcp-metadata@5.3.0(transitive)
+ Addedglob@8.1.0(transitive)
+ Addedgoogle-auth-library@8.9.0(transitive)
+ Addedgoogle-gax@3.6.1(transitive)
+ Addedgoogle-p12-pem@4.0.1(transitive)
+ Addedgraceful-fs@4.2.11(transitive)
+ Addedgtoken@6.1.2(transitive)
+ Addedhas-flag@4.0.0(transitive)
+ Addedinflight@1.0.6(transitive)
+ Addedjs2xmlparser@4.0.2(transitive)
+ Addedjsdoc@4.0.4(transitive)
+ Addedklaw@3.0.0(transitive)
+ Addedlevn@0.3.0(transitive)
+ Addedlinkify-it@5.0.0(transitive)
+ Addedlodash@4.17.21(transitive)
+ Addedmarkdown-it@14.1.0(transitive)
+ Addedmarkdown-it-anchor@8.6.7(transitive)
+ Addedmarked@4.3.0(transitive)
+ Addedmdurl@2.0.0(transitive)
+ Addedminimatch@5.1.6(transitive)
+ Addedminimist@1.2.8(transitive)
+ Addedmkdirp@1.0.4(transitive)
+ Addedoptionator@0.8.3(transitive)
+ Addedprelude-ls@1.1.2(transitive)
+ Addedproto3-json-serializer@1.1.1(transitive)
+ Addedprotobufjs@7.2.4(transitive)
+ Addedprotobufjs-cli@1.1.1(transitive)
+ Addedpunycode.js@2.3.1(transitive)
+ Addedrequizzle@0.2.4(transitive)
+ Addedretry-request@5.0.2(transitive)
+ Addedsemver@7.6.3(transitive)
+ Addedsource-map@0.6.1(transitive)
+ Addedstrip-json-comments@3.1.1(transitive)
+ Addedsupports-color@7.2.0(transitive)
+ Addedtmp@0.2.3(transitive)
+ Addedtype-check@0.3.2(transitive)
+ Addeduc.micro@2.1.0(transitive)
+ Addeduglify-js@3.19.3(transitive)
+ Addedunderscore@1.13.7(transitive)
+ Addedword-wrap@1.2.5(transitive)
+ Addedxmlcreate@2.0.4(transitive)
- Removed@grpc/grpc-js@1.6.12(transitive)
- Removed@grpc/proto-loader@0.6.13(transitive)
- Removedcliui@7.0.4(transitive)
- Removedgaxios@4.3.3(transitive)
- Removedgcp-metadata@4.3.1(transitive)
- Removedgoogle-auth-library@7.14.1(transitive)
- Removedgoogle-gax@2.30.5(transitive)
- Removedgoogle-p12-pem@3.1.4(transitive)
- Removedgtoken@5.3.2(transitive)
- Removedlong@4.0.0(transitive)
- Removedproto3-json-serializer@0.1.9(transitive)
- Removedprotobufjs@6.11.3(transitive)
- Removedretry-request@4.2.2(transitive)
- Removedyargs@16.2.0(transitive)
- Removedyargs-parser@20.2.9(transitive)
Updatedgoogle-gax@^3.0.1