@google-cloud/notebooks
Advanced tools
@google-cloud/notebooks - npm Package Compare versions
Comparing version 1.0.0 to 1.0.1
| import * as v1beta1 from './v1beta1'; | ||
| declare const NotebookServiceClient: typeof v1beta1.NotebookServiceClient; | ||
| declare type NotebookServiceClient = v1beta1.NotebookServiceClient; | ||
| export { v1beta1, NotebookServiceClient }; | ||
@@ -4,0 +5,0 @@ declare const _default: { |
@@ -7,3 +7,3 @@ /// <reference types="node" /> | ||
| /** | ||
| * API service for Cloud AI Platform Notebooks. | ||
| * API v1beta1 service for Cloud AI Platform Notebooks. | ||
| * @class | ||
@@ -34,4 +34,6 @@ * @memberof v1beta1 | ||
| * | ||
| * @param {object} [options] - The configuration object. See the subsequent | ||
| * parameters for more details. | ||
| * @param {object} [options] - The configuration object. | ||
| * The options accepted by the constructor are described in detail | ||
| * in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance). | ||
| * The common options are: | ||
| * @param {object} [options.credentials] - Credentials object. | ||
@@ -56,2 +58,9 @@ * @param {string} [options.credentials.client_email] | ||
| * API remote host. | ||
| * @param {gax.ClientConfig} [options.clientConfig] - client configuration override. | ||
| * TODO(@alexander-fenster): link to gax documentation. | ||
| * @param {boolean} fallback - Use HTTP fallback mode. | ||
| * In fallback mode, a special browser-compatible transport implementation is used | ||
| * instead of gRPC transport. In browser context (if the `window` object is defined) | ||
| * the fallback mode is enabled automatically; set `options.fallback` to `false` | ||
| * if you need to override this behavior. | ||
| */ | ||
@@ -75,2 +84,3 @@ constructor(opts?: ClientOptions); | ||
| * The DNS address for this API service. | ||
| * @returns {string} The DNS address for this service. | ||
| */ | ||
@@ -81,2 +91,3 @@ static get servicePath(): string; | ||
| * exists for compatibility reasons. | ||
| * @returns {string} The DNS address for this service. | ||
| */ | ||
@@ -86,2 +97,3 @@ static get apiEndpoint(): string; | ||
| * The port for this API service. | ||
| * @returns {number} The default port for this service. | ||
| */ | ||
@@ -92,2 +104,3 @@ static get port(): number; | ||
| * in this service. | ||
| * @returns {string[]} List of default scopes. | ||
| */ | ||
@@ -110,3 +123,3 @@ static get scopes(): string[]; | ||
| /** | ||
| * Check the status of the long running operation returned by the createInstance() method. | ||
| * Check the status of the long running operation returned by `createInstance()`. | ||
| * @param {String} name | ||
@@ -116,9 +129,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkCreateInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkCreateInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -130,3 +144,3 @@ checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the registerInstance() method. | ||
| * Check the status of the long running operation returned by `registerInstance()`. | ||
| * @param {String} name | ||
@@ -136,9 +150,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkRegisterInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkRegisterInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -150,3 +165,3 @@ checkRegisterInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the setInstanceAccelerator() method. | ||
| * Check the status of the long running operation returned by `setInstanceAccelerator()`. | ||
| * @param {String} name | ||
@@ -156,9 +171,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkSetInstanceAcceleratorProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkSetInstanceAcceleratorProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -170,3 +186,3 @@ checkSetInstanceAcceleratorProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the setInstanceMachineType() method. | ||
| * Check the status of the long running operation returned by `setInstanceMachineType()`. | ||
| * @param {String} name | ||
@@ -176,9 +192,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkSetInstanceMachineTypeProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkSetInstanceMachineTypeProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -190,3 +207,3 @@ checkSetInstanceMachineTypeProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the setInstanceLabels() method. | ||
| * Check the status of the long running operation returned by `setInstanceLabels()`. | ||
| * @param {String} name | ||
@@ -196,9 +213,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkSetInstanceLabelsProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkSetInstanceLabelsProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -210,3 +228,3 @@ checkSetInstanceLabelsProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the deleteInstance() method. | ||
| * Check the status of the long running operation returned by `deleteInstance()`. | ||
| * @param {String} name | ||
@@ -216,9 +234,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkDeleteInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkDeleteInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -230,3 +249,3 @@ checkDeleteInstanceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the startInstance() method. | ||
| * Check the status of the long running operation returned by `startInstance()`. | ||
| * @param {String} name | ||
@@ -236,9 +255,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkStartInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkStartInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -250,3 +270,3 @@ checkStartInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the stopInstance() method. | ||
| * Check the status of the long running operation returned by `stopInstance()`. | ||
| * @param {String} name | ||
@@ -256,9 +276,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkStopInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkStopInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -270,3 +291,3 @@ checkStopInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the resetInstance() method. | ||
| * Check the status of the long running operation returned by `resetInstance()`. | ||
| * @param {String} name | ||
@@ -276,9 +297,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkResetInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkResetInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -290,3 +312,3 @@ checkResetInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the reportInstanceInfo() method. | ||
| * Check the status of the long running operation returned by `reportInstanceInfo()`. | ||
| * @param {String} name | ||
@@ -296,9 +318,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkReportInstanceInfoProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkReportInstanceInfoProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -310,3 +333,3 @@ checkReportInstanceInfoProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the upgradeInstance() method. | ||
| * Check the status of the long running operation returned by `upgradeInstance()`. | ||
| * @param {String} name | ||
@@ -316,9 +339,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkUpgradeInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkUpgradeInstanceProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -330,3 +354,3 @@ checkUpgradeInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the upgradeInstanceInternal() method. | ||
| * Check the status of the long running operation returned by `upgradeInstanceInternal()`. | ||
| * @param {String} name | ||
@@ -336,9 +360,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkUpgradeInstanceInternalProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkUpgradeInstanceInternalProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -350,3 +375,3 @@ checkUpgradeInstanceInternalProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Instance, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the createEnvironment() method. | ||
| * Check the status of the long running operation returned by `createEnvironment()`. | ||
| * @param {String} name | ||
@@ -356,9 +381,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkCreateEnvironmentProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkCreateEnvironmentProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -370,3 +396,3 @@ checkCreateEnvironmentProgress(name: string): Promise<LROperation<protos.google.cloud.notebooks.v1beta1.Environment, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Check the status of the long running operation returned by the deleteEnvironment() method. | ||
| * Check the status of the long running operation returned by `deleteEnvironment()`. | ||
| * @param {String} name | ||
@@ -376,9 +402,10 @@ * The operation name that will be passed. | ||
| * The decoded operation object has result and metadata field to get information from. | ||
| * | ||
| * @example: | ||
| * const decodedOperation = await checkDeleteEnvironmentProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| * | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) | ||
| * for more details and examples. | ||
| * @example | ||
| * const decodedOperation = await checkDeleteEnvironmentProgress(name); | ||
| * console.log(decodedOperation.result); | ||
| * console.log(decodedOperation.done); | ||
| * console.log(decodedOperation.metadata); | ||
| */ | ||
@@ -390,14 +417,3 @@ checkDeleteEnvironmentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.notebooks.v1beta1.OperationMetadata>>; | ||
| /** | ||
| * Equivalent to {@link listInstances}, but returns a NodeJS Stream object. | ||
| * | ||
| * This fetches the paged responses for {@link listInstances} continuously | ||
| * and invokes the callback registered for 'data' event for each element in the | ||
| * responses. | ||
| * | ||
| * The returned object has 'end' method when no more elements are required. | ||
| * | ||
| * autoPaginate option will be ignored. | ||
| * | ||
| * @see {@link https://nodejs.org/api/stream.html} | ||
| * | ||
| * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. | ||
| * @param {Object} request | ||
@@ -417,9 +433,15 @@ * The request object that will be sent. | ||
| * An object stream which emits an object representing [Instance]{@link google.cloud.notebooks.v1beta1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| */ | ||
| listInstancesStream(request?: protos.google.cloud.notebooks.v1beta1.IListInstancesRequest, options?: gax.CallOptions): Transform; | ||
| /** | ||
| * Equivalent to {@link listInstances}, but returns an iterable object. | ||
| * Equivalent to `listInstances`, but returns an iterable object. | ||
| * | ||
| * for-await-of syntax is used with the iterable to recursively get response element on-demand. | ||
| * | ||
| * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. | ||
| * @param {Object} request | ||
@@ -438,3 +460,14 @@ * The request object that will be sent. | ||
| * @returns {Object} | ||
| * An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols. | ||
| * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). | ||
| * When you iterate the returned iterable, each element will be an object representing | ||
| * [Instance]{@link google.cloud.notebooks.v1beta1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listInstancesAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| */ | ||
@@ -446,14 +479,3 @@ listInstancesAsync(request?: protos.google.cloud.notebooks.v1beta1.IListInstancesRequest, options?: gax.CallOptions): AsyncIterable<protos.google.cloud.notebooks.v1beta1.IInstance>; | ||
| /** | ||
| * Equivalent to {@link listEnvironments}, but returns a NodeJS Stream object. | ||
| * | ||
| * This fetches the paged responses for {@link listEnvironments} continuously | ||
| * and invokes the callback registered for 'data' event for each element in the | ||
| * responses. | ||
| * | ||
| * The returned object has 'end' method when no more elements are required. | ||
| * | ||
| * autoPaginate option will be ignored. | ||
| * | ||
| * @see {@link https://nodejs.org/api/stream.html} | ||
| * | ||
| * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. | ||
| * @param {Object} request | ||
@@ -472,9 +494,15 @@ * The request object that will be sent. | ||
| * An object stream which emits an object representing [Environment]{@link google.cloud.notebooks.v1beta1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| */ | ||
| listEnvironmentsStream(request?: protos.google.cloud.notebooks.v1beta1.IListEnvironmentsRequest, options?: gax.CallOptions): Transform; | ||
| /** | ||
| * Equivalent to {@link listEnvironments}, but returns an iterable object. | ||
| * Equivalent to `listEnvironments`, but returns an iterable object. | ||
| * | ||
| * for-await-of syntax is used with the iterable to recursively get response element on-demand. | ||
| * | ||
| * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. | ||
| * @param {Object} request | ||
@@ -492,3 +520,14 @@ * The request object that will be sent. | ||
| * @returns {Object} | ||
| * An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols. | ||
| * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). | ||
| * When you iterate the returned iterable, each element will be an object representing | ||
| * [Environment]{@link google.cloud.notebooks.v1beta1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listEnvironmentsAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| */ | ||
@@ -545,7 +584,8 @@ listEnvironmentsAsync(request?: protos.google.cloud.notebooks.v1beta1.IListEnvironmentsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.cloud.notebooks.v1beta1.IEnvironment>; | ||
| /** | ||
| * Terminate the GRPC channel and close the client. | ||
| * Terminate the gRPC channel and close the client. | ||
| * | ||
| * The client will no longer be usable and all future behavior is undefined. | ||
| * @returns {Promise} A promise that resolves when the client is closed. | ||
| */ | ||
| close(): Promise<void>; | ||
| } |
| # Changelog | ||
| ### [1.0.1](https://www.github.com/googleapis/nodejs-notebooks/compare/v1.0.0...v1.0.1) (2020-11-14) | ||
| ### Bug Fixes | ||
| * export type for NotebookServiceClient ([#16](https://www.github.com/googleapis/nodejs-notebooks/issues/16)) ([a54fef9](https://www.github.com/googleapis/nodejs-notebooks/commit/a54fef99d2745b540f81421a2aff8c2f00bcf731)) | ||
| ## 1.0.0 (2020-09-03) | ||
@@ -4,0 +11,0 @@ |
| { | ||
| "name": "@google-cloud/notebooks", | ||
| "version": "1.0.0", | ||
| "version": "1.0.1", | ||
| "description": "Notebooks client for Node.js", | ||
@@ -60,4 +60,4 @@ "repository": "googleapis/nodejs-notebooks", | ||
| "typescript": "^3.9.7", | ||
| "webpack": "^4.44.1", | ||
| "webpack-cli": "^3.3.12" | ||
| "webpack": "^5.0.0", | ||
| "webpack-cli": "^4.0.0" | ||
| }, | ||
@@ -64,0 +64,0 @@ "engines": { |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.63%
1971355
- Lines of code
- increased by1.72%
32080