@google-cloud/notebooks/build/src/v1/notebook_service_client.d.ts

Notebooks client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, IamClient, IamProtos, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  API v1 service for Cloud AI Platform Notebooks.
 * @class
 * @memberof v1
 */
export declare class NotebookServiceClient {
    private _terminated;
    private _opts;
    private _providedCustomServicePath;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    private _universeDomain;
    private _servicePath;
    private _log;
    auth: gax.GoogleAuth;
    descriptors: Descriptors;
    warn: (code: string, message: string, warnType?: string) => void;
    innerApiCalls: {
        [name: string]: Function;
    };
    iamClient: IamClient;
    locationsClient: LocationsClient;
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    operationsClient: gax.OperationsClient;
    notebookServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * 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?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
    /**
     * 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(): Promise<{
        [name: string]: Function;
    }>;
    /**
     * 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(): string;
    /**
     * 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(): string;
    /**
     * The DNS address for this API service.
     * @returns {string} The DNS address for this service.
     */
    get apiEndpoint(): string;
    get universeDomain(): string;
    /**
     * The port for this API service.
     * @returns {number} The default port for this service.
     */
    static get port(): number;
    /**
     * The scopes needed to make gRPC calls for every method defined
     * in this service.
     * @returns {string[]} List of default scopes.
     */
    static get scopes(): string[];
    getProjectId(): Promise<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    /**
     * Gets details of a single Instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_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 {@link protos.google.cloud.notebooks.v1.Instance|Instance}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/notebook_service.get_instance.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_GetInstance_async
     */
    getInstance(request?: protos.google.cloud.notebooks.v1.IGetInstanceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IInstance,
        protos.google.cloud.notebooks.v1.IGetInstanceRequest | undefined,
        {} | undefined
    ]>;
    getInstance(request: protos.google.cloud.notebooks.v1.IGetInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
    getInstance(request: protos.google.cloud.notebooks.v1.IGetInstanceRequest, callback: Callback<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Add/update metadata items for an instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_id}`
     * @param {number[]} request.items
     *   Metadata items to add/update for the instance.
     * @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 {@link protos.google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponse|UpdateInstanceMetadataItemsResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/notebook_service.update_instance_metadata_items.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_UpdateInstanceMetadataItems_async
     */
    updateInstanceMetadataItems(request?: protos.google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsResponse,
        protos.google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsRequest | undefined,
        {} | undefined
    ]>;
    updateInstanceMetadataItems(request: protos.google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsResponse, protos.google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsRequest | null | undefined, {} | null | undefined>): void;
    updateInstanceMetadataItems(request: protos.google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsRequest, callback: Callback<protos.google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsResponse, protos.google.cloud.notebooks.v1.IUpdateInstanceMetadataItemsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Check if a notebook instance is upgradable.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.notebookInstance
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_id}`
     * @param {google.cloud.notebooks.v1.UpgradeType} [request.type]
     *   Optional. The optional UpgradeType. Setting this field will search for additional
     *   compute images to upgrade this instance.
     * @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 {@link protos.google.cloud.notebooks.v1.IsInstanceUpgradeableResponse|IsInstanceUpgradeableResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/notebook_service.is_instance_upgradeable.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_IsInstanceUpgradeable_async
     */
    isInstanceUpgradeable(request?: protos.google.cloud.notebooks.v1.IIsInstanceUpgradeableRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IIsInstanceUpgradeableResponse,
        protos.google.cloud.notebooks.v1.IIsInstanceUpgradeableRequest | undefined,
        {} | undefined
    ]>;
    isInstanceUpgradeable(request: protos.google.cloud.notebooks.v1.IIsInstanceUpgradeableRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IIsInstanceUpgradeableResponse, protos.google.cloud.notebooks.v1.IIsInstanceUpgradeableRequest | null | undefined, {} | null | undefined>): void;
    isInstanceUpgradeable(request: protos.google.cloud.notebooks.v1.IIsInstanceUpgradeableRequest, callback: Callback<protos.google.cloud.notebooks.v1.IIsInstanceUpgradeableResponse, protos.google.cloud.notebooks.v1.IIsInstanceUpgradeableRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Check if a notebook instance is healthy.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_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 {@link protos.google.cloud.notebooks.v1.GetInstanceHealthResponse|GetInstanceHealthResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/notebook_service.get_instance_health.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_GetInstanceHealth_async
     */
    getInstanceHealth(request?: protos.google.cloud.notebooks.v1.IGetInstanceHealthRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IGetInstanceHealthResponse,
        protos.google.cloud.notebooks.v1.IGetInstanceHealthRequest | undefined,
        {} | undefined
    ]>;
    getInstanceHealth(request: protos.google.cloud.notebooks.v1.IGetInstanceHealthRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IGetInstanceHealthResponse, protos.google.cloud.notebooks.v1.IGetInstanceHealthRequest | null | undefined, {} | null | undefined>): void;
    getInstanceHealth(request: protos.google.cloud.notebooks.v1.IGetInstanceHealthRequest, callback: Callback<protos.google.cloud.notebooks.v1.IGetInstanceHealthResponse, protos.google.cloud.notebooks.v1.IGetInstanceHealthRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets details of a single Environment.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/environments/{environment_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 {@link protos.google.cloud.notebooks.v1.Environment|Environment}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/notebook_service.get_environment.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_GetEnvironment_async
     */
    getEnvironment(request?: protos.google.cloud.notebooks.v1.IGetEnvironmentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IEnvironment,
        protos.google.cloud.notebooks.v1.IGetEnvironmentRequest | undefined,
        {} | undefined
    ]>;
    getEnvironment(request: protos.google.cloud.notebooks.v1.IGetEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IEnvironment, protos.google.cloud.notebooks.v1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;
    getEnvironment(request: protos.google.cloud.notebooks.v1.IGetEnvironmentRequest, callback: Callback<protos.google.cloud.notebooks.v1.IEnvironment, protos.google.cloud.notebooks.v1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets details of schedule
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/schedules/{schedule_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 {@link protos.google.cloud.notebooks.v1.Schedule|Schedule}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/notebook_service.get_schedule.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_GetSchedule_async
     */
    getSchedule(request?: protos.google.cloud.notebooks.v1.IGetScheduleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.ISchedule,
        protos.google.cloud.notebooks.v1.IGetScheduleRequest | undefined,
        {} | undefined
    ]>;
    getSchedule(request: protos.google.cloud.notebooks.v1.IGetScheduleRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.ISchedule, protos.google.cloud.notebooks.v1.IGetScheduleRequest | null | undefined, {} | null | undefined>): void;
    getSchedule(request: protos.google.cloud.notebooks.v1.IGetScheduleRequest, callback: Callback<protos.google.cloud.notebooks.v1.ISchedule, protos.google.cloud.notebooks.v1.IGetScheduleRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets details of executions
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/executions/{execution_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 {@link protos.google.cloud.notebooks.v1.Execution|Execution}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/notebook_service.get_execution.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_GetExecution_async
     */
    getExecution(request?: protos.google.cloud.notebooks.v1.IGetExecutionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IExecution,
        protos.google.cloud.notebooks.v1.IGetExecutionRequest | undefined,
        {} | undefined
    ]>;
    getExecution(request: protos.google.cloud.notebooks.v1.IGetExecutionRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IExecution, protos.google.cloud.notebooks.v1.IGetExecutionRequest | null | undefined, {} | null | undefined>): void;
    getExecution(request: protos.google.cloud.notebooks.v1.IGetExecutionRequest, callback: Callback<protos.google.cloud.notebooks.v1.IExecution, protos.google.cloud.notebooks.v1.IGetExecutionRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates a new Instance 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.instanceId
     *   Required. User-defined unique ID of this instance.
     * @param {google.cloud.notebooks.v1.Instance} request.instance
     *   Required. The instance 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 {@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
     */
    createInstance(request?: protos.google.cloud.notebooks.v1.ICreateInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    createInstance(request: protos.google.cloud.notebooks.v1.ICreateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    createInstance(request: protos.google.cloud.notebooks.v1.ICreateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * 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
     */
    checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Instance, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Registers an existing legacy notebook instance to the Notebooks API server.
     * Legacy instances are instances created with the legacy Compute Engine
     * calls. They are not manageable by the Notebooks API out of the box. This
     * call makes these instances manageable by the Notebooks API.
     *
     * @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.instanceId
     *   Required. User defined unique ID of this instance. The `instance_id` must
     *   be 1 to 63 characters long and contain only lowercase letters,
     *   numeric characters, and dashes. The first character must be a lowercase
     *   letter and the last character cannot be a dash.
     * @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 {@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
     */
    registerInstance(request?: protos.google.cloud.notebooks.v1.IRegisterInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    registerInstance(request: protos.google.cloud.notebooks.v1.IRegisterInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    registerInstance(request: protos.google.cloud.notebooks.v1.IRegisterInstanceRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * 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
     */
    checkRegisterInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Instance, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Updates the guest accelerators of a single Instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_id}`
     * @param {google.cloud.notebooks.v1.Instance.AcceleratorType} request.type
     *   Required. Type of this accelerator.
     * @param {number} request.coreCount
     *   Required. Count of cores of this accelerator. Note that not all combinations
     *   of `type` and `core_count` are valid. Check [GPUs on
     *   Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to
     *   find a valid combination. TPUs are not supported.
     * @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 {@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
     */
    setInstanceAccelerator(request?: protos.google.cloud.notebooks.v1.ISetInstanceAcceleratorRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    setInstanceAccelerator(request: protos.google.cloud.notebooks.v1.ISetInstanceAcceleratorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    setInstanceAccelerator(request: protos.google.cloud.notebooks.v1.ISetInstanceAcceleratorRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * 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
     */
    checkSetInstanceAcceleratorProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Instance, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Updates the machine type of a single Instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_id}`
     * @param {string} request.machineType
     *   Required. The [Compute Engine machine
     *   type](https://cloud.google.com/compute/docs/machine-types).
     * @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 {@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
     */
    setInstanceMachineType(request?: protos.google.cloud.notebooks.v1.ISetInstanceMachineTypeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    setInstanceMachineType(request: protos.google.cloud.notebooks.v1.ISetInstanceMachineTypeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    setInstanceMachineType(request: protos.google.cloud.notebooks.v1.ISetInstanceMachineTypeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * 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
     */
    checkSetInstanceMachineTypeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Instance, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Update Notebook Instance configurations.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_id}`
     * @param {google.cloud.notebooks.v1.InstanceConfig} request.config
     *   The instance configurations to be updated.
     * @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 {@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.update_instance_config.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_UpdateInstanceConfig_async
     */
    updateInstanceConfig(request?: protos.google.cloud.notebooks.v1.IUpdateInstanceConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    updateInstanceConfig(request: protos.google.cloud.notebooks.v1.IUpdateInstanceConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    updateInstanceConfig(request: protos.google.cloud.notebooks.v1.IUpdateInstanceConfigRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `updateInstanceConfig()`.
     * @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.update_instance_config.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_UpdateInstanceConfig_async
     */
    checkUpdateInstanceConfigProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Instance, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Updates the Shielded instance configuration of a single Instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_id}`
     * @param {google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig} request.shieldedInstanceConfig
     *   ShieldedInstance configuration to be updated.
     * @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 {@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.update_shielded_instance_config.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_UpdateShieldedInstanceConfig_async
     */
    updateShieldedInstanceConfig(request?: protos.google.cloud.notebooks.v1.IUpdateShieldedInstanceConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    updateShieldedInstanceConfig(request: protos.google.cloud.notebooks.v1.IUpdateShieldedInstanceConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    updateShieldedInstanceConfig(request: protos.google.cloud.notebooks.v1.IUpdateShieldedInstanceConfigRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `updateShieldedInstanceConfig()`.
     * @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.update_shielded_instance_config.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_UpdateShieldedInstanceConfig_async
     */
    checkUpdateShieldedInstanceConfigProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Instance, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Replaces all the labels of an Instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_id}`
     * @param {number[]} request.labels
     *   Labels to apply to this instance.
     *   These can be later modified by the setLabels method
     * @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 {@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_labels.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_SetInstanceLabels_async
     */
    setInstanceLabels(request?: protos.google.cloud.notebooks.v1.ISetInstanceLabelsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    setInstanceLabels(request: protos.google.cloud.notebooks.v1.ISetInstanceLabelsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    setInstanceLabels(request: protos.google.cloud.notebooks.v1.ISetInstanceLabelsRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `setInstanceLabels()`.
     * @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_labels.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_SetInstanceLabels_async
     */
    checkSetInstanceLabelsProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Instance, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Deletes a single Instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_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 {@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.delete_instance.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_DeleteInstance_async
     */
    deleteInstance(request?: protos.google.cloud.notebooks.v1.IDeleteInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deleteInstance(request: protos.google.cloud.notebooks.v1.IDeleteInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deleteInstance(request: protos.google.cloud.notebooks.v1.IDeleteInstanceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `deleteInstance()`.
     * @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.delete_instance.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_DeleteInstance_async
     */
    checkDeleteInstanceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Starts a notebook instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_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 {@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.start_instance.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_StartInstance_async
     */
    startInstance(request?: protos.google.cloud.notebooks.v1.IStartInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    startInstance(request: protos.google.cloud.notebooks.v1.IStartInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    startInstance(request: protos.google.cloud.notebooks.v1.IStartInstanceRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `startInstance()`.
     * @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.start_instance.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_StartInstance_async
     */
    checkStartInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Instance, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Stops a notebook instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance_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 {@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.stop_instance.js</caption>
     * region_tag:notebooks_v1_generated_NotebookService_StopInstance_async
     */
    stopInstance(request?: protos.google.cloud.notebooks.v1.IStopInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    stopInstance(request: protos.google.cloud.notebooks.v1.IStopInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    stopInstance(request: protos.google.cloud.notebooks.v1.IStopInstanceRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IInstance, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `stopInstance()`.
     * @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.stop_instance.js</caption>
     * region_tag:notebooks_v1_g