NotebookServiceClient - Documentation

Constructor

new NotebookServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of NotebookServiceClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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.

port

number

The port on which to connect to the remote host.

projectId

string

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 Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new NotebookServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be cancelled.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

(async) checkCreateEnvironmentProgress(name) → {Promise}

Check the status of the long running operation returned by createEnvironment().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}`
   */
  // const parent = 'abc123'
  /**
   *  Required. User-defined unique ID of this environment. The `environment_id` must
   *  be 1 to 63 characters long and contain only lowercase letters,
   *  numeric characters, and dashes. The first character must be a lowercase
   *  letter and the last character cannot be a dash.
   */
  // const environmentId = 'abc123'
  /**
   *  Required. The environment to be created.
   */
  // const environment = {}

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

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

  async function callCreateEnvironment() {
    // Construct request
    const request = {
      parent,
      environmentId,
      environment,
    };

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

  callCreateEnvironment();

(async) checkCreateInstanceProgress(name) → {Promise}

Check the status of the long running operation returned by createInstance().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 instance.
   */
  // const instanceId = 'abc123'
  /**
   *  Required. The instance to be created.
   */
  // const instance = {}

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

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

  async function callCreateInstance() {
    // Construct request
    const request = {
      parent,
      instanceId,
      instance,
    };

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

  callCreateInstance();

(async) checkDeleteEnvironmentProgress(name) → {Promise}

Check the status of the long running operation returned by deleteEnvironment().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/environments/{environment_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteEnvironment();

(async) checkDeleteInstanceProgress(name) → {Promise}

Check the status of the long running operation returned by deleteInstance().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/instances/{instance_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteInstance();

(async) checkRegisterInstanceProgress(name) → {Promise}

Check the status of the long running operation returned by registerInstance().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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 instance. The `instance_id` must
   *  be 1 to 63 characters long and contain only lowercase letters,
   *  numeric characters, and dashes. The first character must be a lowercase
   *  letter and the last character cannot be a dash.
   */
  // const instanceId = 'abc123'

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

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

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

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

  callRegisterInstance();

(async) checkReportInstanceInfoProgress(name) → {Promise}

Check the status of the long running operation returned by reportInstanceInfo().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/instances/{instance_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'
  /**
   *  The metadata reported to Notebooks API. This will be merged to the instance
   *  metadata store
   */
  // const metadata = [1,2,3,4]

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

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

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

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

  callReportInstanceInfo();

(async) checkResetInstanceProgress(name) → {Promise}

Check the status of the long running operation returned by resetInstance().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/instances/{instance_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callResetInstance();

(async) checkSetInstanceAcceleratorProgress(name) → {Promise}

Check the status of the long running operation returned by setInstanceAccelerator().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/instances/{instance_id}`
   */
  // const name = 'abc123'
  /**
   *  Required. Type of this accelerator.
   */
  // const type = {}
  /**
   *  Required. Count of cores of this accelerator. Note that not all combinations
   *  of `type` and `core_count` are valid. Check GPUs on
   *  Compute Engine (https://cloud.google.com/compute/docs/gpus/#gpus-list) to
   *  find a valid combination. TPUs are not supported.
   */
  // const coreCount = 1234

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

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

  async function callSetInstanceAccelerator() {
    // Construct request
    const request = {
      name,
      type,
      coreCount,
    };

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

  callSetInstanceAccelerator();

(async) checkSetInstanceLabelsProgress(name) → {Promise}

Check the status of the long running operation returned by setInstanceLabels().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/instances/{instance_id}`
   */
  // const name = 'abc123'
  /**
   *  Labels to apply to this instance.
   *  These can be later modified by the setLabels method
   */
  // const labels = [1,2,3,4]

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

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

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

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

  callSetInstanceLabels();

(async) checkSetInstanceMachineTypeProgress(name) → {Promise}

Check the status of the long running operation returned by setInstanceMachineType().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/instances/{instance_id}`
   */
  // const name = 'abc123'
  /**
   *  Required. The Compute Engine machine
   *  type (https://cloud.google.com/compute/docs/machine-types).
   */
  // const machineType = 'abc123'

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

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

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

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

  callSetInstanceMachineType();

(async) checkStartInstanceProgress(name) → {Promise}

Check the status of the long running operation returned by startInstance().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/instances/{instance_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callStartInstance();

(async) checkStopInstanceProgress(name) → {Promise}

Check the status of the long running operation returned by stopInstance().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/instances/{instance_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callStopInstance();

(async) checkUpgradeInstanceInternalProgress(name) → {Promise}

Check the status of the long running operation returned by upgradeInstanceInternal().

Deprecated: UpgradeInstanceInternal is deprecated and may be removed in a future version.

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/instances/{instance_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 {NotebookServiceClient} = require('@google-cloud/notebooks').v1beta1;

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

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

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

  callUpgradeInstanceInternal();

(async) checkUpgradeInstanceProgress(name) → {Promise}

Check the status of the long running operation returned by upgradeInstance().

Deprecated: UpgradeInstance is deprecated and may be removed in a future version.

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * 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}/instances/{instance_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callUpgradeInstance();

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be deleted.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

environmentPath(project, environment) → {string}

Return a fully-qualified environment resource name string.

Parameters:

Name	Type	Description
`project`	string
`environment`	string

Returns:

Type	Description
string	Resource name string.

getIamPolicy(request, optionsopt, callbackopt) → {Promise}

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Attributes Description

resource

string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

options

Object

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 GetPolicyOptions.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Policy.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	Resource name for the location.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.

Example

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

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

initialize() → {Promise}

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:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

instancePath(project, instance) → {string}

Return a fully-qualified instance resource name string.

Parameters:

Name	Type	Description
`project`	string
`instance`	string

Returns:

Type	Description
string	Resource name string.

listEnvironmentsAsync(request, optionsopt) → {Object}

Equivalent to listEnvironments, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. Format: `projects/{project_id}/locations/{location}`
`pageSize`	number	Maximum return size of the list call.
`pageToken`	string	A previous returned page token that can be used to continue listing from the last result.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Environment. 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 documentation for more details and examples.

Example

  /**
   * 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}`
   */
  // 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 {NotebookServiceClient} = require('@google-cloud/notebooks').v1beta1;

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

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

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

  callListEnvironments();

listEnvironmentsStream(request, optionsopt) → {Stream}

Equivalent to listEnvironments, but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. Format: `projects/{project_id}/locations/{location}`
`pageSize`	number	Maximum return size of the list call.
`pageToken`	string	A previous returned page token that can be used to continue listing from the last result.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing Environment 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 listEnvironmentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInstancesAsync(request, optionsopt) → {Object}

Equivalent to listInstances, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. Format: `parent=projects/{project_id}/locations/{location}`
`pageSize`	number	Maximum return size of the list call.
`pageToken`	string	A previous returned page token that can be used to continue listing from the last result.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Instance. 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 documentation for more details and examples.

Example

  /**
   * 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 {NotebookServiceClient} = require('@google-cloud/notebooks').v1beta1;

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

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

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

  callListInstances();

listInstancesStream(request, optionsopt) → {Stream}

Equivalent to listInstances, but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. Format: `parent=projects/{project_id}/locations/{location}`
`pageSize`	number	Maximum return size of the list call.
`pageToken`	string	A previous returned page token that can be used to continue listing from the last result.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Instance 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 `listInstancesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, optionsopt) → {Object}

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The resource that owns the locations collection, if applicable.
`filter`	string	The standard list filter.
`pageSize`	number	The standard list page size.
`pageToken`	string	The standard list page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. 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 documentation for more details and examples.

Example

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

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`name`	string		The name of the operation collection.
`filter`	string		The standard list filter.
`pageSize`	number	<optional>	The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns:

Type	Description
Object	An iterable Object that conforms to iteration protocols.

Example

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

matchEnvironmentFromEnvironmentName(environmentName) → {string}

Parse the environment from Environment resource.

Parameters:

Name	Type	Description
`environmentName`	string	A fully-qualified path representing Environment resource.

Returns:

Type	Description
string	A string representing the environment.

matchInstanceFromInstanceName(instanceName) → {string}

Parse the instance from Instance resource.

Parameters:

Name	Type	Description
`instanceName`	string	A fully-qualified path representing Instance resource.

Returns:

Type	Description
string	A string representing the instance.

matchProjectFromEnvironmentName(environmentName) → {string}

Parse the project from Environment resource.

Parameters:

Name	Type	Description
`environmentName`	string	A fully-qualified path representing Environment resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromInstanceName(instanceName) → {string}

Parse the project from Instance resource.

Parameters:

Name	Type	Description
`instanceName`	string	A fully-qualified path representing Instance resource.

Returns:

Type	Description
string	A string representing the project.

setIamPolicy(request, optionsopt, callbackopt) → {Promise}

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.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	Array.<string>	The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.

testIamPermissions(request, optionsopt, callbackopt) → {Promise}

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.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	Array.<string>	The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.