import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * Service definition for the Maps Platform Datasets API. * @class * @memberof v1 */ export declare class MapsPlatformDatasetsClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; private _log; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; pathTemplates: { [name: string]: gax.PathTemplate; }; mapsPlatformDatasetsStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of MapsPlatformDatasetsClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or * .p12 key downloaded from the Google Developers Console. If you provide * a path to a JSON file, the projectId option below is not necessary. * NOTE: .pem and .p12 require you to specify options.email as well. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - The project ID from the Google * Developer's Console, e.g. 'grape-spaceship-123'. We will also check * the environment variable GCLOUD_PROJECT for your project ID. If your * app is running in an environment which supports * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you * need to avoid loading the default gRPC version and want to use the fallback * HTTP implementation. Load only fallback version and pass it to the constructor: * ``` * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC * const client = new MapsPlatformDatasetsClient({fallback: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * Initialize the client. * Performs asynchronous operations (such as authentication) and prepares the client. * This function will be called automatically when any class method is called for the * first time, but if you need to initialize it before calling an actual method, * feel free to call initialize() directly. * * You can await on this method if you want to make sure the client is initialized. * * @returns {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise; getProjectId(callback: Callback): void; /** * Creates a new dataset for the specified project. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Parent project that will own the dataset. * Format: projects/{project} * @param {google.maps.mapsplatformdatasets.v1.Dataset} request.dataset * Required. The dataset version to create. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.maps.mapsplatformdatasets.v1.Dataset|Dataset}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/maps_platform_datasets.create_dataset.js * region_tag:mapsplatformdatasets_v1_generated_MapsPlatformDatasets_CreateDataset_async */ createDataset(request?: protos.google.maps.mapsplatformdatasets.v1.ICreateDatasetRequest, options?: CallOptions): Promise<[ protos.google.maps.mapsplatformdatasets.v1.IDataset, protos.google.maps.mapsplatformdatasets.v1.ICreateDatasetRequest | undefined, {} | undefined ]>; createDataset(request: protos.google.maps.mapsplatformdatasets.v1.ICreateDatasetRequest, options: CallOptions, callback: Callback): void; createDataset(request: protos.google.maps.mapsplatformdatasets.v1.ICreateDatasetRequest, callback: Callback): void; /** * Updates the metadata for the dataset. * * @param {Object} request * The request object that will be sent. * @param {google.maps.mapsplatformdatasets.v1.Dataset} request.dataset * Required. Resource name of the dataset to update. * Format: projects/{project}/datasets/{dataset_id} * @param {google.protobuf.FieldMask} request.updateMask * The list of fields to be updated. * * The value "*" is used for full replacement (default). * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.maps.mapsplatformdatasets.v1.Dataset|Dataset}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/maps_platform_datasets.update_dataset_metadata.js * region_tag:mapsplatformdatasets_v1_generated_MapsPlatformDatasets_UpdateDatasetMetadata_async */ updateDatasetMetadata(request?: protos.google.maps.mapsplatformdatasets.v1.IUpdateDatasetMetadataRequest, options?: CallOptions): Promise<[ protos.google.maps.mapsplatformdatasets.v1.IDataset, protos.google.maps.mapsplatformdatasets.v1.IUpdateDatasetMetadataRequest | undefined, {} | undefined ]>; updateDatasetMetadata(request: protos.google.maps.mapsplatformdatasets.v1.IUpdateDatasetMetadataRequest, options: CallOptions, callback: Callback): void; updateDatasetMetadata(request: protos.google.maps.mapsplatformdatasets.v1.IUpdateDatasetMetadataRequest, callback: Callback): void; /** * Gets the dataset. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Resource name. * Format: projects/{project}/datasets/{dataset_id} * * * Can also fetch some special versions by appending "@" and a tag. * Format: projects/{project}/datasets/{dataset_id}@{tag} * * Tag "active": The info of the latest completed version will be included, * and NOT_FOUND if the dataset does not have one. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.maps.mapsplatformdatasets.v1.Dataset|Dataset}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/maps_platform_datasets.get_dataset.js * region_tag:mapsplatformdatasets_v1_generated_MapsPlatformDatasets_GetDataset_async */ getDataset(request?: protos.google.maps.mapsplatformdatasets.v1.IGetDatasetRequest, options?: CallOptions): Promise<[ protos.google.maps.mapsplatformdatasets.v1.IDataset, protos.google.maps.mapsplatformdatasets.v1.IGetDatasetRequest | undefined, {} | undefined ]>; getDataset(request: protos.google.maps.mapsplatformdatasets.v1.IGetDatasetRequest, options: CallOptions, callback: Callback): void; getDataset(request: protos.google.maps.mapsplatformdatasets.v1.IGetDatasetRequest, callback: Callback): void; /** * Deletes the specified dataset. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the dataset to delete. * Format: projects/{project}/datasets/{dataset_id} * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/maps_platform_datasets.delete_dataset.js * region_tag:mapsplatformdatasets_v1_generated_MapsPlatformDatasets_DeleteDataset_async */ deleteDataset(request?: protos.google.maps.mapsplatformdatasets.v1.IDeleteDatasetRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.maps.mapsplatformdatasets.v1.IDeleteDatasetRequest | undefined, {} | undefined ]>; deleteDataset(request: protos.google.maps.mapsplatformdatasets.v1.IDeleteDatasetRequest, options: CallOptions, callback: Callback): void; deleteDataset(request: protos.google.maps.mapsplatformdatasets.v1.IDeleteDatasetRequest, callback: Callback): void; /** * Gets all the errors of a dataset. * * @param {Object} request * The request object that will be sent. * @param {string} request.dataset * Required. The name of the dataset to list all the errors for. * Format: projects/{project}/datasets/{dataset_id} * @param {number} request.pageSize * The maximum number of errors to return per page. * * The maximum value is 500; values above 500 will be capped to 500. * * If unspecified, at most 50 errors will be returned. * @param {string} request.pageToken * The page token, received from a previous ListDatasetErrors call. * Provide this to retrieve the subsequent page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.rpc.Status|Status}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `fetchDatasetErrorsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ fetchDatasetErrors(request?: protos.google.maps.mapsplatformdatasets.v1.IFetchDatasetErrorsRequest, options?: CallOptions): Promise<[ protos.google.rpc.IStatus[], protos.google.maps.mapsplatformdatasets.v1.IFetchDatasetErrorsRequest | null, protos.google.maps.mapsplatformdatasets.v1.IFetchDatasetErrorsResponse ]>; fetchDatasetErrors(request: protos.google.maps.mapsplatformdatasets.v1.IFetchDatasetErrorsRequest, options: CallOptions, callback: PaginationCallback): void; fetchDatasetErrors(request: protos.google.maps.mapsplatformdatasets.v1.IFetchDatasetErrorsRequest, callback: PaginationCallback): void; /** * Equivalent to `fetchDatasetErrors`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.dataset * Required. The name of the dataset to list all the errors for. * Format: projects/{project}/datasets/{dataset_id} * @param {number} request.pageSize * The maximum number of errors to return per page. * * The maximum value is 500; values above 500 will be capped to 500. * * If unspecified, at most 50 errors will be returned. * @param {string} request.pageToken * The page token, received from a previous ListDatasetErrors call. * Provide this to retrieve the subsequent page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.rpc.Status|Status} 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 `fetchDatasetErrorsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ fetchDatasetErrorsStream(request?: protos.google.maps.mapsplatformdatasets.v1.IFetchDatasetErrorsRequest, options?: CallOptions): Transform; /** * Equivalent to `fetchDatasetErrors`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.dataset * Required. The name of the dataset to list all the errors for. * Format: projects/{project}/datasets/{dataset_id} * @param {number} request.pageSize * The maximum number of errors to return per page. * * The maximum value is 500; values above 500 will be capped to 500. * * If unspecified, at most 50 errors will be returned. * @param {string} request.pageToken * The page token, received from a previous ListDatasetErrors call. * Provide this to retrieve the subsequent page. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.rpc.Status|Status}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/maps_platform_datasets.fetch_dataset_errors.js * region_tag:mapsplatformdatasets_v1_generated_MapsPlatformDatasets_FetchDatasetErrors_async */ fetchDatasetErrorsAsync(request?: protos.google.maps.mapsplatformdatasets.v1.IFetchDatasetErrorsRequest, options?: CallOptions): AsyncIterable; /** * Lists all the datasets for the specified project. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The name of the project to list all the datasets for. * Format: projects/{project} * @param {number} request.pageSize * The maximum number of datasets to return per page. * * If unspecified (or zero), all datasets will be returned. * @param {string} request.pageToken * The page token, received from a previous ListDatasets call. * Provide this to retrieve the subsequent page. * @param {string} request.tag * The tag that specifies the desired version for each dataset. * * Note that when pagination is also specified, some filtering can happen * after pagination, which may cause the response to contain fewer datasets * than the page size, even if it's not the last page. * * Tag "active": Each dataset in the response will include the info of its * latest completed version, and the dataset will be skipped if it does not * have one. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.maps.mapsplatformdatasets.v1.Dataset|Dataset}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDatasetsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDatasets(request?: protos.google.maps.mapsplatformdatasets.v1.IListDatasetsRequest, options?: CallOptions): Promise<[ protos.google.maps.mapsplatformdatasets.v1.IDataset[], protos.google.maps.mapsplatformdatasets.v1.IListDatasetsRequest | null, protos.google.maps.mapsplatformdatasets.v1.IListDatasetsResponse ]>; listDatasets(request: protos.google.maps.mapsplatformdatasets.v1.IListDatasetsRequest, options: CallOptions, callback: PaginationCallback): void; listDatasets(request: protos.google.maps.mapsplatformdatasets.v1.IListDatasetsRequest, callback: PaginationCallback): void; /** * Equivalent to `listDatasets`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The name of the project to list all the datasets for. * Format: projects/{project} * @param {number} request.pageSize * The maximum number of datasets to return per page. * * If unspecified (or zero), all datasets will be returned. * @param {string} request.pageToken * The page token, received from a previous ListDatasets call. * Provide this to retrieve the subsequent page. * @param {string} request.tag * The tag that specifies the desired version for each dataset. * * Note that when pagination is also specified, some filtering can happen * after pagination, which may cause the response to contain fewer datasets * than the page size, even if it's not the last page. * * Tag "active": Each dataset in the response will include the info of its * latest completed version, and the dataset will be skipped if it does not * have one. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.maps.mapsplatformdatasets.v1.Dataset|Dataset} 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 `listDatasetsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDatasetsStream(request?: protos.google.maps.mapsplatformdatasets.v1.IListDatasetsRequest, options?: CallOptions): Transform; /** * Equivalent to `listDatasets`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The name of the project to list all the datasets for. * Format: projects/{project} * @param {number} request.pageSize * The maximum number of datasets to return per page. * * If unspecified (or zero), all datasets will be returned. * @param {string} request.pageToken * The page token, received from a previous ListDatasets call. * Provide this to retrieve the subsequent page. * @param {string} request.tag * The tag that specifies the desired version for each dataset. * * Note that when pagination is also specified, some filtering can happen * after pagination, which may cause the response to contain fewer datasets * than the page size, even if it's not the last page. * * Tag "active": Each dataset in the response will include the info of its * latest completed version, and the dataset will be skipped if it does not * have one. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.maps.mapsplatformdatasets.v1.Dataset|Dataset}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/maps_platform_datasets.list_datasets.js * region_tag:mapsplatformdatasets_v1_generated_MapsPlatformDatasets_ListDatasets_async */ listDatasetsAsync(request?: protos.google.maps.mapsplatformdatasets.v1.IListDatasetsRequest, options?: CallOptions): AsyncIterable; /** * Return a fully-qualified dataset resource name string. * * @param {string} project * @param {string} dataset * @returns {string} Resource name string. */ datasetPath(project: string, dataset: string): string; /** * Parse the project from Dataset resource. * * @param {string} datasetName * A fully-qualified path representing Dataset resource. * @returns {string} A string representing the project. */ matchProjectFromDatasetName(datasetName: string): string | number; /** * Parse the dataset from Dataset resource. * * @param {string} datasetName * A fully-qualified path representing Dataset resource. * @returns {string} A string representing the dataset. */ matchDatasetFromDatasetName(datasetName: string): string | number; /** * 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; }