@google-cloud/notebooks/build/src/v1/managed_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 Managed Notebooks.
 * @class
 * @memberof v1
 */
export declare class ManagedNotebookServiceClient {
    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;
    managedNotebookServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of ManagedNotebookServiceClient.
     *
     * @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 ManagedNotebookServiceClient({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 Runtime. The location must be a regional endpoint
     * rather than zonal.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.notebooks.v1.Runtime|Runtime}.
     *   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/managed_notebook_service.get_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_GetRuntime_async
     */
    getRuntime(request?: protos.google.cloud.notebooks.v1.IGetRuntimeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IRuntime,
        protos.google.cloud.notebooks.v1.IGetRuntimeRequest | undefined,
        {} | undefined
    ]>;
    getRuntime(request: protos.google.cloud.notebooks.v1.IGetRuntimeRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IGetRuntimeRequest | null | undefined, {} | null | undefined>): void;
    getRuntime(request: protos.google.cloud.notebooks.v1.IGetRuntimeRequest, callback: Callback<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IGetRuntimeRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets an access token for the consumer service account that the customer
     * attached to the runtime. Only accessible from the tenant instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
     * @param {string} request.vmId
     *   Required. The VM hardware token for authenticating the VM.
     *   https://cloud.google.com/compute/docs/instances/verifying-instance-identity
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.notebooks.v1.RefreshRuntimeTokenInternalResponse|RefreshRuntimeTokenInternalResponse}.
     *   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/managed_notebook_service.refresh_runtime_token_internal.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_RefreshRuntimeTokenInternal_async
     */
    refreshRuntimeTokenInternal(request?: protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalResponse,
        protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest | undefined,
        {} | undefined
    ]>;
    refreshRuntimeTokenInternal(request: protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalResponse, protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest | null | undefined, {} | null | undefined>): void;
    refreshRuntimeTokenInternal(request: protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest, callback: Callback<protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalResponse, protos.google.cloud.notebooks.v1.IRefreshRuntimeTokenInternalRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates a new Runtime in a given project and location.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. Format:
     *   `parent=projects/{project_id}/locations/{location}`
     * @param {string} request.runtimeId
     *   Required. User-defined unique ID of this Runtime.
     * @param {google.cloud.notebooks.v1.Runtime} request.runtime
     *   Required. The Runtime to be created.
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@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/managed_notebook_service.create_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_CreateRuntime_async
     */
    createRuntime(request?: protos.google.cloud.notebooks.v1.ICreateRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    createRuntime(request: protos.google.cloud.notebooks.v1.ICreateRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    createRuntime(request: protos.google.cloud.notebooks.v1.ICreateRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `createRuntime()`.
     * @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/managed_notebook_service.create_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_CreateRuntime_async
     */
    checkCreateRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Update Notebook Runtime configuration.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.notebooks.v1.Runtime} request.runtime
     *   Required. The Runtime to be updated.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   Required. Specifies the path, relative to `Runtime`, of
     *   the field to update. For example, to change the software configuration
     *   kernels, the `update_mask` parameter would be
     *   specified as `software_config.kernels`,
     *   and the `PATCH` request body would specify the new value, as follows:
     *
     *       {
     *         "software_config":{
     *           "kernels": [{
     *              'repository':
     *              'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag':
     *              'latest' }],
     *           }
     *       }
     *
     *
     *   Currently, only the following fields can be updated:
     *   - `software_config.kernels`
     *   - `software_config.post_startup_script`
     *   - `software_config.custom_gpu_driver_path`
     *   - `software_config.idle_shutdown`
     *   - `software_config.idle_shutdown_timeout`
     *   - `software_config.disable_terminal`
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@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/managed_notebook_service.update_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_UpdateRuntime_async
     */
    updateRuntime(request?: protos.google.cloud.notebooks.v1.IUpdateRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    updateRuntime(request: protos.google.cloud.notebooks.v1.IUpdateRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    updateRuntime(request: protos.google.cloud.notebooks.v1.IUpdateRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, 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 `updateRuntime()`.
     * @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/managed_notebook_service.update_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_UpdateRuntime_async
     */
    checkUpdateRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Deletes a single Runtime.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@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/managed_notebook_service.delete_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_DeleteRuntime_async
     */
    deleteRuntime(request?: protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deleteRuntime(request: protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deleteRuntime(request: protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `deleteRuntime()`.
     * @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/managed_notebook_service.delete_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_DeleteRuntime_async
     */
    checkDeleteRuntimeProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Starts a Managed Notebook Runtime.
     * Perform "Start" on GPU instances; "Resume" on CPU instances
     * See:
     * https://cloud.google.com/compute/docs/instances/stop-start-instance
     * https://cloud.google.com/compute/docs/instances/suspend-resume-instance
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@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/managed_notebook_service.start_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_StartRuntime_async
     */
    startRuntime(request?: protos.google.cloud.notebooks.v1.IStartRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    startRuntime(request: protos.google.cloud.notebooks.v1.IStartRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    startRuntime(request: protos.google.cloud.notebooks.v1.IStartRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `startRuntime()`.
     * @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/managed_notebook_service.start_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_StartRuntime_async
     */
    checkStartRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Stops a Managed Notebook Runtime.
     * Perform "Stop" on GPU instances; "Suspend" on CPU instances
     * See:
     * https://cloud.google.com/compute/docs/instances/stop-start-instance
     * https://cloud.google.com/compute/docs/instances/suspend-resume-instance
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@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/managed_notebook_service.stop_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_StopRuntime_async
     */
    stopRuntime(request?: protos.google.cloud.notebooks.v1.IStopRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    stopRuntime(request: protos.google.cloud.notebooks.v1.IStopRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    stopRuntime(request: protos.google.cloud.notebooks.v1.IStopRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `stopRuntime()`.
     * @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/managed_notebook_service.stop_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_StopRuntime_async
     */
    checkStopRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Switch a Managed Notebook Runtime.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
     * @param {string} request.machineType
     *   machine type.
     * @param {google.cloud.notebooks.v1.RuntimeAcceleratorConfig} request.acceleratorConfig
     *   accelerator config.
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@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/managed_notebook_service.switch_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_SwitchRuntime_async
     */
    switchRuntime(request?: protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    switchRuntime(request: protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    switchRuntime(request: protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `switchRuntime()`.
     * @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/managed_notebook_service.switch_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_SwitchRuntime_async
     */
    checkSwitchRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Resets a Managed Notebook Runtime.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@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/managed_notebook_service.reset_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_ResetRuntime_async
     */
    resetRuntime(request?: protos.google.cloud.notebooks.v1.IResetRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    resetRuntime(request: protos.google.cloud.notebooks.v1.IResetRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    resetRuntime(request: protos.google.cloud.notebooks.v1.IResetRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `resetRuntime()`.
     * @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/managed_notebook_service.reset_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_ResetRuntime_async
     */
    checkResetRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Upgrades a Managed Notebook Runtime to the latest version.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@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/managed_notebook_service.upgrade_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_UpgradeRuntime_async
     */
    upgradeRuntime(request?: protos.google.cloud.notebooks.v1.IUpgradeRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    upgradeRuntime(request: protos.google.cloud.notebooks.v1.IUpgradeRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    upgradeRuntime(request: protos.google.cloud.notebooks.v1.IUpgradeRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, 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 `upgradeRuntime()`.
     * @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/managed_notebook_service.upgrade_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_UpgradeRuntime_async
     */
    checkUpgradeRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Report and process a runtime event.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
     * @param {string} request.vmId
     *   Required. The VM hardware token for authenticating the VM.
     *   https://cloud.google.com/compute/docs/instances/verifying-instance-identity
     * @param {google.cloud.notebooks.v1.Event} request.event
     *   Required. The Event to be reported.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@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/managed_notebook_service.report_runtime_event.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_ReportRuntimeEvent_async
     */
    reportRuntimeEvent(request?: protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    reportRuntimeEvent(request: protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    reportRuntimeEvent(request: protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `reportRuntimeEvent()`.
     * @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/managed_notebook_service.report_runtime_event.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_ReportRuntimeEvent_async
     */
    checkReportRuntimeEventProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
     * Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Format:
     *   `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`
     * @param {google.cloud.notebooks.v1.DiagnosticConfig} request.diagnosticConfig
     *   Required. Defines flags that are used to run the diagnostic tool
     * @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/managed_notebook_service.diagnose_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_DiagnoseRuntime_async
     */
    diagnoseRuntime(request?: protos.google.cloud.notebooks.v1.IDiagnoseRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    diagnoseRuntime(request: protos.google.cloud.notebooks.v1.IDiagnoseRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    diagnoseRuntime(request: protos.google.cloud.notebooks.v1.IDiagnoseRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, 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 `diagnoseRuntime()`.
     * @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/managed_notebook_service.diagnose_runtime.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_DiagnoseRuntime_async
     */
    checkDiagnoseRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;
    /**
    * Lists Runtimes in a given project and location.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. Format:
    *   `parent=projects/{project_id}/locations/{location}`
    * @param {number} request.pageSize
    *   Maximum return size of the list call.
    * @param {string} request.pageToken
    *   A previous returned page token that can be used to continue listing
    *   from the last result.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
    *   The first element of the array is Array of {@link protos.google.cloud.notebooks.v1.Runtime|Runtime}.
    *   The client library will perform auto-pagination by default: it will call the API as many
    *   times as needed and will merge results from all the pages into this array.
    *   Note that it can affect your quota.
    *   We recommend using `listRuntimesAsync()`
    *   method described below for async iteration which you can stop as needed.
    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
    *   for more details and examples.
    */
    listRuntimes(request?: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IRuntime[],
        protos.google.cloud.notebooks.v1.IListRuntimesRequest | null,
        protos.google.cloud.notebooks.v1.IListRuntimesResponse
    ]>;
    listRuntimes(request: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.notebooks.v1.IListRuntimesRequest, protos.google.cloud.notebooks.v1.IListRuntimesResponse | null | undefined, protos.google.cloud.notebooks.v1.IRuntime>): void;
    listRuntimes(request: protos.google.cloud.notebooks.v1.IListRuntimesRequest, callback: PaginationCallback<protos.google.cloud.notebooks.v1.IListRuntimesRequest, protos.google.cloud.notebooks.v1.IListRuntimesResponse | null | undefined, protos.google.cloud.notebooks.v1.IRuntime>): void;
    /**
     * Equivalent to `listRuntimes`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. Format:
     *   `parent=projects/{project_id}/locations/{location}`
     * @param {number} request.pageSize
     *   Maximum return size of the list call.
     * @param {string} request.pageToken
     *   A previous returned page token that can be used to continue listing
     *   from the last result.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Stream}
     *   An object stream which emits an object representing {@link protos.google.cloud.notebooks.v1.Runtime|Runtime} on 'data' event.
     *   The client library will perform auto-pagination by default: it will call the API as many
     *   times as needed. Note that it can affect your quota.
     *   We recommend using `listRuntimesAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     */
    listRuntimesStream(request?: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listRuntimes`, but returns an iterable object.
     *
     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. Format:
     *   `parent=projects/{project_id}/locations/{location}`
     * @param {number} request.pageSize
     *   Maximum return size of the list call.
     * @param {string} request.pageToken
     *   A previous returned page token that can be used to continue listing
     *   from the last result.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Object}
     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
     *   When you iterate the returned iterable, each element will be an object representing
     *   {@link protos.google.cloud.notebooks.v1.Runtime|Runtime}. The API will be called under the hood as needed, once per the page,
     *   so you can stop the iteration when you don't need more results.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/managed_notebook_service.list_runtimes.js</caption>
     * region_tag:notebooks_v1_generated_ManagedNotebookService_ListRuntimes_async
     */
    listRuntimesAsync(request?: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.notebooks.v1.IRuntime>;
    /**
     * Gets the access control policy for a resource. Returns an empty policy
     * if the resource exists and does not have a policy set.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.resource
     *   REQUIRED: The resource for which the policy is being requested.
     *   See the operation documentation for the appropriate value for this field.
     * @param {Object} [request.options]
     *   OPTIONAL: A `GetPolicyOptions` object for specifying options to
     *   `GetIamPolicy`. This field is only used by Cloud IAM.
     *
     *   This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}.
     * @param {Object} [options]
     *   Optional parameters. You can override the default settings for this call, e.g, timeout,
     *   retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details.
     * @param {function(?Error, ?Object)} [callback]
     *   The function which will be called with the result of the API call.
     *
     *   The second parameter to the callback is an object representing {@link google.iam.v1.Policy | Policy}.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}.
     *   The promise has a method named "cancel" which cancels the ongoing API call.
     */
    getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;
    /**
     * Returns permissions that a caller has on the specified resource. If the
     * resource does not exist, this will return an empty set of
     * permissions, not a NOT_FOUND error.
     *
     * Note: This operation is designed to be used for building
     * permission-aware UIs and command-line tools, not for authorization
     * checking. This operation may "fail open" without warning.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.resource
     *   REQUIRED: The resource for which the policy detail is being requested.
     *   See the operation documentation for the appropriate value for this field.
     * @param {string[]} request.permissions
     *   The set of permissions to check for the `resource`. Permissions with