@google-cloud/notebooks
Version:
Notebooks client for Node.js
826 lines • 148 kB
JavaScript
"use strict";
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **
Object.defineProperty(exports, "__esModule", { value: true });
exports.NotebookServiceClient = void 0;
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v1/notebook_service_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./notebook_service_client_config.json");
const version = require('../../../package.json').version;
/**
* API v1 service for Cloud AI Platform Notebooks.
* @class
* @memberof v1
*/
class NotebookServiceClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('notebooks');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
iamClient;
locationsClient;
pathTemplates;
operationsClient;
notebookServiceStub;
/**
* Construct an instance of NotebookServiceClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new NotebookServiceClient({fallback: true}, gax);
* ```
*/
constructor(opts, gaxInstance) {
// Ensure that options include all the required fields.
const staticMembers = this.constructor;
if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
throw new Error('Please set either universe_domain or universeDomain, but not both.');
}
const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
this._servicePath = 'notebooks.' + this._universeDomain;
const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
const port = opts?.port || staticMembers.port;
const clientConfig = opts?.clientConfig ?? {};
const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
// Request numeric enum values if REST transport is used.
opts.numericEnums = true;
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
if (servicePath !== this._servicePath && !('scopes' in opts)) {
opts['scopes'] = staticMembers.scopes;
}
// Load google-gax module synchronously if needed
if (!gaxInstance) {
gaxInstance = require('google-gax');
}
// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
// Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
// Save options to use in initialize() method.
this._opts = opts;
// Save the auth object to the client, for use by other methods.
this.auth = this._gaxGrpc.auth;
// Set useJWTAccessWithScope on the auth object.
this.auth.useJWTAccessWithScope = true;
// Set defaultServicePath on the auth object.
this.auth.defaultServicePath = this._servicePath;
// Set the default scopes in auth client if needed.
if (servicePath === this._servicePath) {
this.auth.defaultScopes = staticMembers.scopes;
}
this.iamClient = new this._gaxModule.IamClient(this._gaxGrpc, opts);
this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
// Determine the client header string.
const clientHeader = [
`gax/${this._gaxModule.version}`,
`gapic/${version}`,
];
if (typeof process === 'object' && 'versions' in process) {
clientHeader.push(`gl-node/${process.versions.node}`);
}
else {
clientHeader.push(`gl-web/${this._gaxModule.version}`);
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
}
else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
clientHeader.push(`${opts.libName}/${opts.libVersion}`);
}
// Load the applicable protos.
this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
// This API contains "path templates"; forward-slash-separated
// identifiers to uniquely identify resources within the API.
// Create useful helper objects for these.
this.pathTemplates = {
environmentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/environments/{environment}'),
executionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/location/{location}/executions/{execution}'),
instancePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}'),
runtimePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/runtimes/{runtime}'),
schedulePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/location/{location}/schedules/{schedule}'),
};
// Some of the methods on this service return "paged" results,
// (e.g. 50 results at a time, with tokens to get subsequent
// pages). Denote the keys used for pagination and results.
this.descriptors.page = {
listInstances: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'instances'),
listEnvironments: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'environments'),
listSchedules: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'schedules'),
listExecutions: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'executions')
};
const protoFilesRoot = this._gaxModule.protobufFromJSON(jsonProtos);
// This API contains "long-running operations", which return a
// an Operation object that allows for tracking of the operation,
// rather than holding a request open.
const lroOptions = {
auth: this.auth,
grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined
};
if (opts.fallback) {
lroOptions.protoJson = protoFilesRoot;
lroOptions.httpRules = [{ selector: 'google.cloud.location.Locations.GetLocation', get: '/v1/{name=projects/*/locations/*}', }, { selector: 'google.cloud.location.Locations.ListLocations', get: '/v1/{name=projects/*}/locations', }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', get: '/v1/{resource=projects/*/locations/*/instances/*}:getIamPolicy', additional_bindings: [{ get: '/v1/{resource=projects/*/locations/*/runtimes/*}:getIamPolicy', }],
}, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', post: '/v1/{resource=projects/*/locations/*/instances/*}:setIamPolicy', body: '*', additional_bindings: [{ post: '/v1/{resource=projects/*/locations/*/runtimes/*}:setIamPolicy', body: '*', }],
}, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', post: '/v1/{resource=projects/*/locations/*/instances/*}:testIamPermissions', body: '*', additional_bindings: [{ post: '/v1/{resource=projects/*/locations/*/runtimes/*}:testIamPermissions', body: '*', }],
}, { selector: 'google.longrunning.Operations.CancelOperation', post: '/v1/{name=projects/*/locations/*/operations/*}:cancel', body: '*', }, { selector: 'google.longrunning.Operations.DeleteOperation', delete: '/v1/{name=projects/*/locations/*/operations/*}', }, { selector: 'google.longrunning.Operations.GetOperation', get: '/v1/{name=projects/*/locations/*/operations/*}', }, { selector: 'google.longrunning.Operations.ListOperations', get: '/v1/{name=projects/*/locations/*}/operations', }];
}
this.operationsClient = this._gaxModule.lro(lroOptions).operationsClient(opts);
const createInstanceResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const createInstanceMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const registerInstanceResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const registerInstanceMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const setInstanceAcceleratorResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const setInstanceAcceleratorMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const setInstanceMachineTypeResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const setInstanceMachineTypeMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const updateInstanceConfigResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const updateInstanceConfigMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const updateShieldedInstanceConfigResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const updateShieldedInstanceConfigMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const setInstanceLabelsResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const setInstanceLabelsMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const deleteInstanceResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
const deleteInstanceMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const startInstanceResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const startInstanceMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const stopInstanceResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const stopInstanceMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const resetInstanceResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const resetInstanceMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const reportInstanceInfoResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const reportInstanceInfoMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const upgradeInstanceResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const upgradeInstanceMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const rollbackInstanceResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const rollbackInstanceMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const diagnoseInstanceResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const diagnoseInstanceMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const upgradeInstanceInternalResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Instance');
const upgradeInstanceInternalMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const createEnvironmentResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Environment');
const createEnvironmentMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const deleteEnvironmentResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
const deleteEnvironmentMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const deleteScheduleResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
const deleteScheduleMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const createScheduleResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Schedule');
const createScheduleMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const triggerScheduleResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Schedule');
const triggerScheduleMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const deleteExecutionResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
const deleteExecutionMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
const createExecutionResponse = protoFilesRoot.lookup('.google.cloud.notebooks.v1.Execution');
const createExecutionMetadata = protoFilesRoot.lookup('.google.cloud.notebooks.v1.OperationMetadata');
this.descriptors.longrunning = {
createInstance: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createInstanceResponse.decode.bind(createInstanceResponse), createInstanceMetadata.decode.bind(createInstanceMetadata)),
registerInstance: new this._gaxModule.LongrunningDescriptor(this.operationsClient, registerInstanceResponse.decode.bind(registerInstanceResponse), registerInstanceMetadata.decode.bind(registerInstanceMetadata)),
setInstanceAccelerator: new this._gaxModule.LongrunningDescriptor(this.operationsClient, setInstanceAcceleratorResponse.decode.bind(setInstanceAcceleratorResponse), setInstanceAcceleratorMetadata.decode.bind(setInstanceAcceleratorMetadata)),
setInstanceMachineType: new this._gaxModule.LongrunningDescriptor(this.operationsClient, setInstanceMachineTypeResponse.decode.bind(setInstanceMachineTypeResponse), setInstanceMachineTypeMetadata.decode.bind(setInstanceMachineTypeMetadata)),
updateInstanceConfig: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateInstanceConfigResponse.decode.bind(updateInstanceConfigResponse), updateInstanceConfigMetadata.decode.bind(updateInstanceConfigMetadata)),
updateShieldedInstanceConfig: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateShieldedInstanceConfigResponse.decode.bind(updateShieldedInstanceConfigResponse), updateShieldedInstanceConfigMetadata.decode.bind(updateShieldedInstanceConfigMetadata)),
setInstanceLabels: new this._gaxModule.LongrunningDescriptor(this.operationsClient, setInstanceLabelsResponse.decode.bind(setInstanceLabelsResponse), setInstanceLabelsMetadata.decode.bind(setInstanceLabelsMetadata)),
deleteInstance: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteInstanceResponse.decode.bind(deleteInstanceResponse), deleteInstanceMetadata.decode.bind(deleteInstanceMetadata)),
startInstance: new this._gaxModule.LongrunningDescriptor(this.operationsClient, startInstanceResponse.decode.bind(startInstanceResponse), startInstanceMetadata.decode.bind(startInstanceMetadata)),
stopInstance: new this._gaxModule.LongrunningDescriptor(this.operationsClient, stopInstanceResponse.decode.bind(stopInstanceResponse), stopInstanceMetadata.decode.bind(stopInstanceMetadata)),
resetInstance: new this._gaxModule.LongrunningDescriptor(this.operationsClient, resetInstanceResponse.decode.bind(resetInstanceResponse), resetInstanceMetadata.decode.bind(resetInstanceMetadata)),
reportInstanceInfo: new this._gaxModule.LongrunningDescriptor(this.operationsClient, reportInstanceInfoResponse.decode.bind(reportInstanceInfoResponse), reportInstanceInfoMetadata.decode.bind(reportInstanceInfoMetadata)),
upgradeInstance: new this._gaxModule.LongrunningDescriptor(this.operationsClient, upgradeInstanceResponse.decode.bind(upgradeInstanceResponse), upgradeInstanceMetadata.decode.bind(upgradeInstanceMetadata)),
rollbackInstance: new this._gaxModule.LongrunningDescriptor(this.operationsClient, rollbackInstanceResponse.decode.bind(rollbackInstanceResponse), rollbackInstanceMetadata.decode.bind(rollbackInstanceMetadata)),
diagnoseInstance: new this._gaxModule.LongrunningDescriptor(this.operationsClient, diagnoseInstanceResponse.decode.bind(diagnoseInstanceResponse), diagnoseInstanceMetadata.decode.bind(diagnoseInstanceMetadata)),
upgradeInstanceInternal: new this._gaxModule.LongrunningDescriptor(this.operationsClient, upgradeInstanceInternalResponse.decode.bind(upgradeInstanceInternalResponse), upgradeInstanceInternalMetadata.decode.bind(upgradeInstanceInternalMetadata)),
createEnvironment: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createEnvironmentResponse.decode.bind(createEnvironmentResponse), createEnvironmentMetadata.decode.bind(createEnvironmentMetadata)),
deleteEnvironment: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteEnvironmentResponse.decode.bind(deleteEnvironmentResponse), deleteEnvironmentMetadata.decode.bind(deleteEnvironmentMetadata)),
deleteSchedule: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteScheduleResponse.decode.bind(deleteScheduleResponse), deleteScheduleMetadata.decode.bind(deleteScheduleMetadata)),
createSchedule: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createScheduleResponse.decode.bind(createScheduleResponse), createScheduleMetadata.decode.bind(createScheduleMetadata)),
triggerSchedule: new this._gaxModule.LongrunningDescriptor(this.operationsClient, triggerScheduleResponse.decode.bind(triggerScheduleResponse), triggerScheduleMetadata.decode.bind(triggerScheduleMetadata)),
deleteExecution: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteExecutionResponse.decode.bind(deleteExecutionResponse), deleteExecutionMetadata.decode.bind(deleteExecutionMetadata)),
createExecution: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createExecutionResponse.decode.bind(createExecutionResponse), createExecutionMetadata.decode.bind(createExecutionMetadata))
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.cloud.notebooks.v1.NotebookService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
this.innerApiCalls = {};
// Add a warn function to the client constructor so it can be easily tested.
this.warn = this._gaxModule.warn;
}
/**
* 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.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize() {
// If the client stub promise is already initialized, return immediately.
if (this.notebookServiceStub) {
return this.notebookServiceStub;
}
// Put together the "service stub" for
// google.cloud.notebooks.v1.NotebookService.
this.notebookServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
this._protos.lookupService('google.cloud.notebooks.v1.NotebookService') :
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.cloud.notebooks.v1.NotebookService, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const notebookServiceStubMethods = ['listInstances', 'getInstance', 'createInstance', 'registerInstance', 'setInstanceAccelerator', 'setInstanceMachineType', 'updateInstanceConfig', 'updateShieldedInstanceConfig', 'setInstanceLabels', 'updateInstanceMetadataItems', 'deleteInstance', 'startInstance', 'stopInstance', 'resetInstance', 'reportInstanceInfo', 'isInstanceUpgradeable', 'getInstanceHealth', 'upgradeInstance', 'rollbackInstance', 'diagnoseInstance', 'upgradeInstanceInternal', 'listEnvironments', 'getEnvironment', 'createEnvironment', 'deleteEnvironment', 'listSchedules', 'getSchedule', 'deleteSchedule', 'createSchedule', 'triggerSchedule', 'listExecutions', 'getExecution', 'deleteExecution', 'createExecution'];
for (const methodName of notebookServiceStubMethods) {
const callPromise = this.notebookServiceStub.then(stub => (...args) => {
if (this._terminated) {
return Promise.reject('The client has already been closed.');
}
const func = stub[methodName];
return func.apply(stub, args);
}, (err) => () => {
throw err;
});
const descriptor = this.descriptors.page[methodName] ||
this.descriptors.longrunning[methodName] ||
undefined;
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
this.innerApiCalls[methodName] = apiCall;
}
return this.notebookServiceStub;
}
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'notebooks.googleapis.com';
}
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'notebooks.googleapis.com';
}
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint() {
return this._servicePath;
}
get universeDomain() {
return this._universeDomain;
}
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port() {
return 443;
}
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes() {
return [
'https://www.googleapis.com/auth/cloud-platform'
];
}
/**
* Return the project ID used by this class.
* @returns {Promise} A promise that resolves to string containing the project ID.
*/
getProjectId(callback) {
if (callback) {
this.auth.getProjectId(callback);
return;
}
return this.auth.getProjectId();
}
getInstance(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'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getInstance request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getInstance response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getInstance(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getInstance response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
updateInstanceMetadataItems(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'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('updateInstanceMetadataItems request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('updateInstanceMetadataItems response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.updateInstanceMetadataItems(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('updateInstanceMetadataItems response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
isInstanceUpgradeable(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'] = this._gaxModule.routingHeader.fromParams({
'notebook_instance': request.notebookInstance ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('isInstanceUpgradeable request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('isInstanceUpgradeable response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.isInstanceUpgradeable(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('isInstanceUpgradeable response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getInstanceHealth(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'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getInstanceHealth request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getInstanceHealth response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getInstanceHealth(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getInstanceHealth response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getEnvironment(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'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getEnvironment request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getEnvironment response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getEnvironment(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getEnvironment response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getSchedule(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'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getSchedule request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getSchedule response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getSchedule(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getSchedule response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getExecution(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'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getExecution request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getExecution response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getExecution(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getExecution response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
createInstance(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'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
this.initialize().catch(err => { throw err; });
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('createInstance response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('createInstance request %j', request);
return this.innerApiCalls.createInstance(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('createInstance response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `createInstance()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/notebook_service.create_instance.js</caption>
* region_tag:notebooks_v1_generated_NotebookService_CreateInstance_async
*/
async checkCreateInstanceProgress(name) {
this._log.info('createInstance long-running');
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
const [operation] = await this.operationsClient.getOperation(request);
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.createInstance, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
registerInstance(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'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
this.initialize().catch(err => { throw err; });
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('registerInstance response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('registerInstance request %j', request);
return this.innerApiCalls.registerInstance(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('registerInstance response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `registerInstance()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/notebook_service.register_instance.js</caption>
* region_tag:notebooks_v1_generated_NotebookService_RegisterInstance_async
*/
async checkRegisterInstanceProgress(name) {
this._log.info('registerInstance long-running');
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
const [operation] = await this.operationsClient.getOperation(request);
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.registerInstance, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
setInstanceAccelerator(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'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('setInstanceAccelerator response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('setInstanceAccelerator request %j', request);
return this.innerApiCalls.setInstanceAccelerator(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('setInstanceAccelerator response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `setInstanceAccelerator()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/notebook_service.set_instance_accelerator.js</caption>
* region_tag:notebooks_v1_generated_NotebookService_SetInstanceAccelerator_async
*/
async checkSetInstanceAcceleratorProgress(name) {
this._log.info('setInstanceAccelerator long-running');
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
const [operation] = await this.operationsClient.getOperation(request);
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.setInstanceAccelerator, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
setInstanceMachineType(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'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('setInstanceMachineType response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('setInstanceMachineType request %j', request);
return this.innerApiCalls.setInstanceMachineType(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('setInstanceMachineType response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `setInstanceMachineType()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/notebook_service.set_instance_machine_type.js</caption>
* region_tag:notebooks_v1_generated_NotebookService_SetInstanceMachineType_async
*/
async checkSetInstanceMachineTypeProgress(name) {
this._log.info('setInstanceMachineType long-running');
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
const [operation] = await this.operationsClient.getOperation(request);
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.setInstanceMachineType, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
updateInstanceConfig(request, option