Class v1.ManagedNotebookServiceClient (2.1.4)

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

managedNotebookServiceStub

managedNotebookServiceStub?: Promise<{
        [name: string]: Function;
    }>;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateRuntimeProgress(name)

checkCreateRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `parent=projects/{project_id}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. User-defined unique ID of this Runtime.
   */
  // const runtimeId = 'abc123'
  /**
   *  Required. The Runtime to be created.
   */
  // const runtime = {}
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callCreateRuntime() {
    // Construct request
    const request = {
      parent,
      runtimeId,
      runtime,
    };

    // Run request
    const [operation] = await notebooksClient.createRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateRuntime();

checkDeleteRuntimeProgress(name)

checkDeleteRuntimeProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.notebooks.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callDeleteRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.deleteRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteRuntime();

checkDiagnoseRuntimeProgress(name)

checkDiagnoseRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`
   */
  // const name = 'abc123'
  /**
   *  Required. Defines flags that are used to run the diagnostic tool
   */
  // const diagnosticConfig = {}

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callDiagnoseRuntime() {
    // Construct request
    const request = {
      name,
      diagnosticConfig,
    };

    // Run request
    const [operation] = await notebooksClient.diagnoseRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDiagnoseRuntime();

checkReportRuntimeEventProgress(name)

checkReportRuntimeEventProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Required. The VM hardware token for authenticating the VM.
   *  https://cloud.google.com/compute/docs/instances/verifying-instance-identity
   */
  // const vmId = 'abc123'
  /**
   *  Required. The Event to be reported.
   */
  // const event = {}

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callReportRuntimeEvent() {
    // Construct request
    const request = {
      name,
      vmId,
      event,
    };

    // Run request
    const [operation] = await notebooksClient.reportRuntimeEvent(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callReportRuntimeEvent();

checkResetRuntimeProgress(name)

checkResetRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callResetRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.resetRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callResetRuntime();

checkStartRuntimeProgress(name)

checkStartRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callStartRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.startRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callStartRuntime();

checkStopRuntimeProgress(name)

checkStopRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callStopRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.stopRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callStopRuntime();

checkSwitchRuntimeProgress(name)

checkSwitchRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  machine type.
   */
  // const machineType = 'abc123'
  /**
   *  accelerator config.
   */
  // const acceleratorConfig = {}
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callSwitchRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.switchRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callSwitchRuntime();

checkUpdateRuntimeProgress(name)

checkUpdateRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Runtime to be updated.
   */
  // const runtime = {}
  /**
   *  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`
   */
  // const updateMask = {}
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callUpdateRuntime() {
    // Construct request
    const request = {
      runtime,
      updateMask,
    };

    // Run request
    const [operation] = await notebooksClient.updateRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateRuntime();

checkUpgradeRuntimeProgress(name)

checkUpgradeRuntimeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1.Runtime, protos.google.cloud.notebooks.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callUpgradeRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.upgradeRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpgradeRuntime();

close()

close(): Promise<void>;

createRuntime(request, options)

createRuntime(request?: protos.google.cloud.notebooks.v1.ICreateRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `parent=projects/{project_id}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. User-defined unique ID of this Runtime.
   */
  // const runtimeId = 'abc123'
  /**
   *  Required. The Runtime to be created.
   */
  // const runtime = {}
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callCreateRuntime() {
    // Construct request
    const request = {
      parent,
      runtimeId,
      runtime,
    };

    // Run request
    const [operation] = await notebooksClient.createRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateRuntime();

createRuntime(request, options, callback)

createRuntime(request: protos.google.cloud.notebooks.v1.ICreateRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

createRuntime(request, callback)

createRuntime(request: protos.google.cloud.notebooks.v1.ICreateRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deleteRuntime(request, options)

deleteRuntime(request?: protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callDeleteRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.deleteRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteRuntime();

deleteRuntime(request, options, callback)

deleteRuntime(request: protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteRuntime(request, callback)

deleteRuntime(request: protos.google.cloud.notebooks.v1.IDeleteRuntimeRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

diagnoseRuntime(request, options)

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
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`
   */
  // const name = 'abc123'
  /**
   *  Required. Defines flags that are used to run the diagnostic tool
   */
  // const diagnosticConfig = {}

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callDiagnoseRuntime() {
    // Construct request
    const request = {
      name,
      diagnosticConfig,
    };

    // Run request
    const [operation] = await notebooksClient.diagnoseRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDiagnoseRuntime();

diagnoseRuntime(request, options, callback)

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, callback)

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;

environmentPath(project, environment)

environmentPath(project: string, environment: string): string;

executionPath(project, location, execution)

executionPath(project: string, location: string, execution: string): string;

getIamPolicy(request, options, callback)

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>;

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

const [response] = await client.getLocation(request);

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

getRuntime(request, options)

getRuntime(request?: protos.google.cloud.notebooks.v1.IGetRuntimeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IRuntime,
        protos.google.cloud.notebooks.v1.IGetRuntimeRequest | undefined,
        {} | undefined
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callGetRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await notebooksClient.getRuntime(request);
    console.log(response);
  }

  callGetRuntime();

getRuntime(request, options, callback)

getRuntime(request: protos.google.cloud.notebooks.v1.IGetRuntimeRequest, options: CallOptions, callback: Callback<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IGetRuntimeRequest | null | undefined, {} | null | undefined>): void;

getRuntime(request, callback)

getRuntime(request: protos.google.cloud.notebooks.v1.IGetRuntimeRequest, callback: Callback<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IGetRuntimeRequest | null | undefined, {} | null | undefined>): void;

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

instancePath(project, instance)

instancePath(project: string, instance: string): string;

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listRuntimes(request, options)

listRuntimes(request?: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.notebooks.v1.IRuntime[],
        protos.google.cloud.notebooks.v1.IListRuntimesRequest | null,
        protos.google.cloud.notebooks.v1.IListRuntimesResponse
    ]>;

listRuntimes(request, options, callback)

listRuntimes(request: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.notebooks.v1.IListRuntimesRequest, protos.google.cloud.notebooks.v1.IListRuntimesResponse | null | undefined, protos.google.cloud.notebooks.v1.IRuntime>): void;

listRuntimes(request, callback)

listRuntimes(request: protos.google.cloud.notebooks.v1.IListRuntimesRequest, callback: PaginationCallback<protos.google.cloud.notebooks.v1.IListRuntimesRequest, protos.google.cloud.notebooks.v1.IListRuntimesResponse | null | undefined, protos.google.cloud.notebooks.v1.IRuntime>): void;

listRuntimesAsync(request, options)

listRuntimesAsync(request?: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.notebooks.v1.IRuntime>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `parent=projects/{project_id}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Maximum return size of the list call.
   */
  // const pageSize = 1234
  /**
   *  A previous returned page token that can be used to continue listing
   *  from the last result.
   */
  // const pageToken = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callListRuntimes() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await notebooksClient.listRuntimesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListRuntimes();

listRuntimesStream(request, options)

listRuntimesStream(request?: protos.google.cloud.notebooks.v1.IListRuntimesRequest, options?: CallOptions): Transform;

locationPath(project, location)

locationPath(project: string, location: string): string;

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

matchExecutionFromExecutionName(executionName)

matchExecutionFromExecutionName(executionName: string): string | number;

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

matchLocationFromExecutionName(executionName)

matchLocationFromExecutionName(executionName: string): string | number;

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

matchLocationFromRuntimeName(runtimeName)

matchLocationFromRuntimeName(runtimeName: string): string | number;

matchLocationFromScheduleName(scheduleName)

matchLocationFromScheduleName(scheduleName: string): string | number;

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

matchProjectFromExecutionName(executionName)

matchProjectFromExecutionName(executionName: string): string | number;

matchProjectFromInstanceName(instanceName)

matchProjectFromInstanceName(instanceName: string): string | number;

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

matchProjectFromRuntimeName(runtimeName)

matchProjectFromRuntimeName(runtimeName: string): string | number;

matchProjectFromScheduleName(scheduleName)

matchProjectFromScheduleName(scheduleName: string): string | number;

matchRuntimeFromRuntimeName(runtimeName)

matchRuntimeFromRuntimeName(runtimeName: string): string | number;

matchScheduleFromScheduleName(scheduleName)

matchScheduleFromScheduleName(scheduleName: string): string | number;

projectPath(project)

projectPath(project: string): string;

refreshRuntimeTokenInternal(request, options)

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
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Required. The VM hardware token for authenticating the VM.
   *  https://cloud.google.com/compute/docs/instances/verifying-instance-identity
   */
  // const vmId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callRefreshRuntimeTokenInternal() {
    // Construct request
    const request = {
      name,
      vmId,
    };

    // Run request
    const response = await notebooksClient.refreshRuntimeTokenInternal(request);
    console.log(response);
  }

  callRefreshRuntimeTokenInternal();

refreshRuntimeTokenInternal(request, options, callback)

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, callback)

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;

reportRuntimeEvent(request, options)

reportRuntimeEvent(request?: protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Required. The VM hardware token for authenticating the VM.
   *  https://cloud.google.com/compute/docs/instances/verifying-instance-identity
   */
  // const vmId = 'abc123'
  /**
   *  Required. The Event to be reported.
   */
  // const event = {}

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callReportRuntimeEvent() {
    // Construct request
    const request = {
      name,
      vmId,
      event,
    };

    // Run request
    const [operation] = await notebooksClient.reportRuntimeEvent(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callReportRuntimeEvent();

reportRuntimeEvent(request, options, callback)

reportRuntimeEvent(request: protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

reportRuntimeEvent(request, callback)

reportRuntimeEvent(request: protos.google.cloud.notebooks.v1.IReportRuntimeEventRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

resetRuntime(request, options)

resetRuntime(request?: protos.google.cloud.notebooks.v1.IResetRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callResetRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.resetRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callResetRuntime();

resetRuntime(request, options, callback)

resetRuntime(request: protos.google.cloud.notebooks.v1.IResetRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

resetRuntime(request, callback)

resetRuntime(request: protos.google.cloud.notebooks.v1.IResetRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

runtimePath(project, location, runtime)

runtimePath(project: string, location: string, runtime: string): string;

schedulePath(project, location, schedule)

schedulePath(project: string, location: string, schedule: string): string;

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.Policy>;

startRuntime(request, options)

startRuntime(request?: protos.google.cloud.notebooks.v1.IStartRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callStartRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.startRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callStartRuntime();

startRuntime(request, options, callback)

startRuntime(request: protos.google.cloud.notebooks.v1.IStartRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

startRuntime(request, callback)

startRuntime(request: protos.google.cloud.notebooks.v1.IStartRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

stopRuntime(request, options)

stopRuntime(request?: protos.google.cloud.notebooks.v1.IStopRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callStopRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.stopRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callStopRuntime();

stopRuntime(request, options, callback)

stopRuntime(request: protos.google.cloud.notebooks.v1.IStopRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

stopRuntime(request, callback)

stopRuntime(request: protos.google.cloud.notebooks.v1.IStopRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

switchRuntime(request, options)

switchRuntime(request?: protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  machine type.
   */
  // const machineType = 'abc123'
  /**
   *  accelerator config.
   */
  // const acceleratorConfig = {}
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callSwitchRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.switchRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callSwitchRuntime();

switchRuntime(request, options, callback)

switchRuntime(request: protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

switchRuntime(request, callback)

switchRuntime(request: protos.google.cloud.notebooks.v1.ISwitchRuntimeRequest, callback: Callback<LROperation<protos.google.cloud.notebooks.v1.IRuntime, protos.google.cloud.notebooks.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.TestIamPermissionsResponse>;

updateRuntime(request, options)

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
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Runtime to be updated.
   */
  // const runtime = {}
  /**
   *  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`
   */
  // const updateMask = {}
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callUpdateRuntime() {
    // Construct request
    const request = {
      runtime,
      updateMask,
    };

    // Run request
    const [operation] = await notebooksClient.updateRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateRuntime();

updateRuntime(request, options, callback)

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, callback)

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;

upgradeRuntime(request, options)

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
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format:
   *  `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Notebooks library
  const {ManagedNotebookServiceClient} = require('@google-cloud/notebooks').v1;

  // Instantiates a client
  const notebooksClient = new ManagedNotebookServiceClient();

  async function callUpgradeRuntime() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await notebooksClient.upgradeRuntime(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpgradeRuntime();

upgradeRuntime(request, options, callback)

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, callback)

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;