import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * Provides methods for interacting with reports. * @class * @memberof v1 */ export declare class ReportServiceClient { 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; }; operationsClient: gax.OperationsClient; reportServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of ReportServiceClient. * * @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 ReportServiceClient({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(): never[]; getProjectId(): Promise; getProjectId(callback: Callback): void; /** * API to retrieve a `Report` object. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the report. * Format: `networks/{network_code}/reports/{report_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.ads.admanager.v1.Report|Report}. * 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/report_service.get_report.js * region_tag:admanager_v1_generated_ReportService_GetReport_async */ getReport(request?: protos.google.ads.admanager.v1.IGetReportRequest, options?: CallOptions): Promise<[ protos.google.ads.admanager.v1.IReport, protos.google.ads.admanager.v1.IGetReportRequest | undefined, {} | undefined ]>; getReport(request: protos.google.ads.admanager.v1.IGetReportRequest, options: CallOptions, callback: Callback): void; getReport(request: protos.google.ads.admanager.v1.IGetReportRequest, callback: Callback): void; /** * API to create a `Report` object. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource where this `Report` will be created. * Format: `networks/{network_code}` * @param {google.ads.admanager.v1.Report} request.report * Required. The `Report` 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.ads.admanager.v1.Report|Report}. * 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/report_service.create_report.js * region_tag:admanager_v1_generated_ReportService_CreateReport_async */ createReport(request?: protos.google.ads.admanager.v1.ICreateReportRequest, options?: CallOptions): Promise<[ protos.google.ads.admanager.v1.IReport, protos.google.ads.admanager.v1.ICreateReportRequest | undefined, {} | undefined ]>; createReport(request: protos.google.ads.admanager.v1.ICreateReportRequest, options: CallOptions, callback: Callback): void; createReport(request: protos.google.ads.admanager.v1.ICreateReportRequest, callback: Callback): void; /** * API to update a `Report` object. * * @param {Object} request * The request object that will be sent. * @param {google.ads.admanager.v1.Report} request.report * Required. The `Report` to update. * @param {google.protobuf.FieldMask} request.updateMask * Required. The list of fields to update. * @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.ads.admanager.v1.Report|Report}. * 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/report_service.update_report.js * region_tag:admanager_v1_generated_ReportService_UpdateReport_async */ updateReport(request?: protos.google.ads.admanager.v1.IUpdateReportRequest, options?: CallOptions): Promise<[ protos.google.ads.admanager.v1.IReport, protos.google.ads.admanager.v1.IUpdateReportRequest | undefined, {} | undefined ]>; updateReport(request: protos.google.ads.admanager.v1.IUpdateReportRequest, options: CallOptions, callback: Callback): void; updateReport(request: protos.google.ads.admanager.v1.IUpdateReportRequest, callback: Callback): void; /** * Initiates the execution of an existing report asynchronously. Users can * get the report by polling this operation via * `OperationsService.GetOperation`. * Poll every 5 seconds initially, with an exponential * backoff. Once a report is complete, the operation will contain a * `RunReportResponse` in its response field containing a report_result that * can be passed to the `FetchReportResultRows` method to retrieve the report * data. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The report to run. * Format: `networks/{network_code}/reports/{report_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 * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/report_service.run_report.js * region_tag:admanager_v1_generated_ReportService_RunReport_async */ runReport(request?: protos.google.ads.admanager.v1.IRunReportRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; runReport(request: protos.google.ads.admanager.v1.IRunReportRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; runReport(request: protos.google.ads.admanager.v1.IRunReportRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `runReport()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/report_service.run_report.js * region_tag:admanager_v1_generated_ReportService_RunReport_async */ checkRunReportProgress(name: string): Promise>; /** * API to retrieve a list of `Report` objects. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent, which owns this collection of reports. * Format: `networks/{network_code}` * @param {number} [request.pageSize] * Optional. The maximum number of `Reports` to return. The service may return * fewer than this value. If unspecified, at most 50 `Reports` will be * returned. The maximum value is 1000; values above 1000 will be coerced to * 1000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListReports` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListReports` must * match the call that provided the page token. * @param {string} [request.filter] * Optional. Expression to filter the response. * See syntax details at * https://developers.google.com/ad-manager/api/beta/filters * @param {string} [request.orderBy] * Optional. Expression to specify sorting order. * See syntax details at * https://developers.google.com/ad-manager/api/beta/filters#order * @param {number} [request.skip] * Optional. Number of individual resources to skip while paginating. * @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.ads.admanager.v1.Report|Report}. * 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 `listReportsAsync()` * 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. */ listReports(request?: protos.google.ads.admanager.v1.IListReportsRequest, options?: CallOptions): Promise<[ protos.google.ads.admanager.v1.IReport[], protos.google.ads.admanager.v1.IListReportsRequest | null, protos.google.ads.admanager.v1.IListReportsResponse ]>; listReports(request: protos.google.ads.admanager.v1.IListReportsRequest, options: CallOptions, callback: PaginationCallback): void; listReports(request: protos.google.ads.admanager.v1.IListReportsRequest, callback: PaginationCallback): void; /** * Equivalent to `listReports`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent, which owns this collection of reports. * Format: `networks/{network_code}` * @param {number} [request.pageSize] * Optional. The maximum number of `Reports` to return. The service may return * fewer than this value. If unspecified, at most 50 `Reports` will be * returned. The maximum value is 1000; values above 1000 will be coerced to * 1000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListReports` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListReports` must * match the call that provided the page token. * @param {string} [request.filter] * Optional. Expression to filter the response. * See syntax details at * https://developers.google.com/ad-manager/api/beta/filters * @param {string} [request.orderBy] * Optional. Expression to specify sorting order. * See syntax details at * https://developers.google.com/ad-manager/api/beta/filters#order * @param {number} [request.skip] * Optional. Number of individual resources to skip while paginating. * @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.ads.admanager.v1.Report|Report} 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 `listReportsAsync()` * 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. */ listReportsStream(request?: protos.google.ads.admanager.v1.IListReportsRequest, options?: CallOptions): Transform; /** * Equivalent to `listReports`, 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 parent, which owns this collection of reports. * Format: `networks/{network_code}` * @param {number} [request.pageSize] * Optional. The maximum number of `Reports` to return. The service may return * fewer than this value. If unspecified, at most 50 `Reports` will be * returned. The maximum value is 1000; values above 1000 will be coerced to * 1000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListReports` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListReports` must * match the call that provided the page token. * @param {string} [request.filter] * Optional. Expression to filter the response. * See syntax details at * https://developers.google.com/ad-manager/api/beta/filters * @param {string} [request.orderBy] * Optional. Expression to specify sorting order. * See syntax details at * https://developers.google.com/ad-manager/api/beta/filters#order * @param {number} [request.skip] * Optional. Number of individual resources to skip while paginating. * @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.ads.admanager.v1.Report|Report}. 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/report_service.list_reports.js * region_tag:admanager_v1_generated_ReportService_ListReports_async */ listReportsAsync(request?: protos.google.ads.admanager.v1.IListReportsRequest, options?: CallOptions): AsyncIterable; /** * Returns the result rows from a completed report. * The caller must have previously called `RunReport` and waited for that * operation to complete. The rows will be returned according to the order * specified by the `sorts` member of the report definition. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * The report result being fetched. * Format: * `networks/{network_code}/reports/{report_id}/results/{report_result_id}` * @param {number} [request.pageSize] * Optional. The maximum number of rows to return. The service may return * fewer than this value. If unspecified, at most 1,000 rows will be returned. * The maximum value is 10,000; values above 10,000 will be reduced to 10,000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `FetchReportResultRows` * call. Provide this to retrieve the second and subsequent batches of rows. * @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.ads.admanager.v1.Report.DataTable.Row|Row}. * 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 `fetchReportResultRowsAsync()` * 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. */ fetchReportResultRows(request?: protos.google.ads.admanager.v1.IFetchReportResultRowsRequest, options?: CallOptions): Promise<[ protos.google.ads.admanager.v1.Report.DataTable.IRow[], protos.google.ads.admanager.v1.IFetchReportResultRowsRequest | null, protos.google.ads.admanager.v1.IFetchReportResultRowsResponse ]>; fetchReportResultRows(request: protos.google.ads.admanager.v1.IFetchReportResultRowsRequest, options: CallOptions, callback: PaginationCallback): void; fetchReportResultRows(request: protos.google.ads.admanager.v1.IFetchReportResultRowsRequest, callback: PaginationCallback): void; /** * Equivalent to `fetchReportResultRows`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.name * The report result being fetched. * Format: * `networks/{network_code}/reports/{report_id}/results/{report_result_id}` * @param {number} [request.pageSize] * Optional. The maximum number of rows to return. The service may return * fewer than this value. If unspecified, at most 1,000 rows will be returned. * The maximum value is 10,000; values above 10,000 will be reduced to 10,000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `FetchReportResultRows` * call. Provide this to retrieve the second and subsequent batches of rows. * @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.ads.admanager.v1.Report.DataTable.Row|Row} 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 `fetchReportResultRowsAsync()` * 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. */ fetchReportResultRowsStream(request?: protos.google.ads.admanager.v1.IFetchReportResultRowsRequest, options?: CallOptions): Transform; /** * Equivalent to `fetchReportResultRows`, 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.name * The report result being fetched. * Format: * `networks/{network_code}/reports/{report_id}/results/{report_result_id}` * @param {number} [request.pageSize] * Optional. The maximum number of rows to return. The service may return * fewer than this value. If unspecified, at most 1,000 rows will be returned. * The maximum value is 10,000; values above 10,000 will be reduced to 10,000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `FetchReportResultRows` * call. Provide this to retrieve the second and subsequent batches of rows. * @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.ads.admanager.v1.Report.DataTable.Row|Row}. 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/report_service.fetch_report_result_rows.js * region_tag:admanager_v1_generated_ReportService_FetchReportResultRows_async */ fetchReportResultRowsAsync(request?: protos.google.ads.admanager.v1.IFetchReportResultRowsRequest, options?: CallOptions): AsyncIterable; /** * 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. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error, ?Object)=} callback * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * @return {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * {@link google.longrunning.Operation | 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) * ``` */ getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise<[protos.google.longrunning.Operation]>; /** * 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. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation collection. * @param {string} request.filter - The standard list filter. * @param {number=} request.pageSize - * 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. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @returns {Object} * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}. * * @example * ``` * const client = longrunning.operationsClient(); * for await (const response of client.listOperationsAsync(request)); * // doThingsWith(response) * ``` */ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable; /** * 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 * {@link 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 {@link Operation.error} value with a {@link google.rpc.Status.code} of * 1, corresponding to `Code.CANCELLED`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be cancelled. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {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: ''}); * ``` */ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): 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`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be deleted. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {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: ''}); * ``` */ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * Return a fully-qualified adUnit resource name string. * * @param {string} network_code * @param {string} ad_unit * @returns {string} Resource name string. */ adUnitPath(networkCode: string, adUnit: string): string; /** * Parse the network_code from AdUnit resource. * * @param {string} adUnitName * A fully-qualified path representing AdUnit resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromAdUnitName(adUnitName: string): string | number; /** * Parse the ad_unit from AdUnit resource. * * @param {string} adUnitName * A fully-qualified path representing AdUnit resource. * @returns {string} A string representing the ad_unit. */ matchAdUnitFromAdUnitName(adUnitName: string): string | number; /** * Return a fully-qualified company resource name string. * * @param {string} network_code * @param {string} company * @returns {string} Resource name string. */ companyPath(networkCode: string, company: string): string; /** * Parse the network_code from Company resource. * * @param {string} companyName * A fully-qualified path representing Company resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromCompanyName(companyName: string): string | number; /** * Parse the company from Company resource. * * @param {string} companyName * A fully-qualified path representing Company resource. * @returns {string} A string representing the company. */ matchCompanyFromCompanyName(companyName: string): string | number; /** * Return a fully-qualified contact resource name string. * * @param {string} network_code * @param {string} contact * @returns {string} Resource name string. */ contactPath(networkCode: string, contact: string): string; /** * Parse the network_code from Contact resource. * * @param {string} contactName * A fully-qualified path representing Contact resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromContactName(contactName: string): string | number; /** * Parse the contact from Contact resource. * * @param {string} contactName * A fully-qualified path representing Contact resource. * @returns {string} A string representing the contact. */ matchContactFromContactName(contactName: string): string | number; /** * Return a fully-qualified customField resource name string. * * @param {string} network_code * @param {string} custom_field * @returns {string} Resource name string. */ customFieldPath(networkCode: string, customField: string): string; /** * Parse the network_code from CustomField resource. * * @param {string} customFieldName * A fully-qualified path representing CustomField resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromCustomFieldName(customFieldName: string): string | number; /** * Parse the custom_field from CustomField resource. * * @param {string} customFieldName * A fully-qualified path representing CustomField resource. * @returns {string} A string representing the custom_field. */ matchCustomFieldFromCustomFieldName(customFieldName: string): string | number; /** * Return a fully-qualified customTargetingKey resource name string. * * @param {string} network_code * @param {string} custom_targeting_key * @returns {string} Resource name string. */ customTargetingKeyPath(networkCode: string, customTargetingKey: string): string; /** * Parse the network_code from CustomTargetingKey resource. * * @param {string} customTargetingKeyName * A fully-qualified path representing CustomTargetingKey resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromCustomTargetingKeyName(customTargetingKeyName: string): string | number; /** * Parse the custom_targeting_key from CustomTargetingKey resource. * * @param {string} customTargetingKeyName * A fully-qualified path representing CustomTargetingKey resource. * @returns {string} A string representing the custom_targeting_key. */ matchCustomTargetingKeyFromCustomTargetingKeyName(customTargetingKeyName: string): string | number; /** * Return a fully-qualified customTargetingValue resource name string. * * @param {string} network_code * @param {string} custom_targeting_key * @param {string} custom_targeting_value * @returns {string} Resource name string. */ customTargetingValuePath(networkCode: string, customTargetingKey: string, customTargetingValue: string): string; /** * Parse the network_code from CustomTargetingValue resource. * * @param {string} customTargetingValueName * A fully-qualified path representing CustomTargetingValue resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromCustomTargetingValueName(customTargetingValueName: string): string | number; /** * Parse the custom_targeting_key from CustomTargetingValue resource. * * @param {string} customTargetingValueName * A fully-qualified path representing CustomTargetingValue resource. * @returns {string} A string representing the custom_targeting_key. */ matchCustomTargetingKeyFromCustomTargetingValueName(customTargetingValueName: string): string | number; /** * Parse the custom_targeting_value from CustomTargetingValue resource. * * @param {string} customTargetingValueName * A fully-qualified path representing CustomTargetingValue resource. * @returns {string} A string representing the custom_targeting_value. */ matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName: string): string | number; /** * Return a fully-qualified entitySignalsMapping resource name string. * * @param {string} network_code * @param {string} entity_signals_mapping * @returns {string} Resource name string. */ entitySignalsMappingPath(networkCode: string, entitySignalsMapping: string): string; /** * Parse the network_code from EntitySignalsMapping resource. * * @param {string} entitySignalsMappingName * A fully-qualified path representing EntitySignalsMapping resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromEntitySignalsMappingName(entitySignalsMappingName: string): string | number; /** * Parse the entity_signals_mapping from EntitySignalsMapping resource. * * @param {string} entitySignalsMappingName * A fully-qualified path representing EntitySignalsMapping resource. * @returns {string} A string representing the entity_signals_mapping. */ matchEntitySignalsMappingFromEntitySignalsMappingName(entitySignalsMappingName: string): string | number; /** * Return a fully-qualified label resource name string. * * @param {string} network_code * @param {string} label * @returns {string} Resource name string. */ labelPath(networkCode: string, label: string): string; /** * Parse the network_code from Label resource. * * @param {string} labelName * A fully-qualified path representing Label resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromLabelName(labelName: string): string | number; /** * Parse the label from Label resource. * * @param {string} labelName * A fully-qualified path representing Label resource. * @returns {string} A string representing the label. */ matchLabelFromLabelName(labelName: string): string | number; /** * Return a fully-qualified network resource name string. * * @param {string} network_code * @returns {string} Resource name string. */ networkPath(networkCode: string): string; /** * Parse the network_code from Network resource. * * @param {string} networkName * A fully-qualified path representing Network resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromNetworkName(networkName: string): string | number; /** * Return a fully-qualified order resource name string. * * @param {string} network_code * @param {string} order * @returns {string} Resource name string. */ orderPath(networkCode: string, order: string): string; /** * Parse the network_code from Order resource. * * @param {string} orderName * A fully-qualified path representing Order resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromOrderName(orderName: string): string | number; /** * Parse the order from Order resource. * * @param {string} orderName * A fully-qualified path representing Order resource. * @returns {string} A string representing the order. */ matchOrderFromOrderName(orderName: string): string | number; /** * Return a fully-qualified placement resource name string. * * @param {string} network_code * @param {string} placement * @returns {string} Resource name string. */ placementPath(networkCode: string, placement: string): string; /** * Parse the network_code from Placement resource. * * @param {string} placementName * A fully-qualified path representing Placement resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromPlacementName(placementName: string): string | number; /** * Parse the placement from Placement resource. * * @param {string} placementName * A fully-qualified path representing Placement resource. * @returns {string} A string representing the placement. */ matchPlacementFromPlacementName(placementName: string): string | number; /** * Return a fully-qualified report resource name string. * * @param {string} network_code * @param {string} report * @returns {string} Resource name string. */ reportPath(networkCode: string, report: string): string; /** * Parse the network_code from Report resource. * * @param {string} reportName * A fully-qualified path representing Report resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromReportName(reportName: string): string | number; /** * Parse the report from Report resource. * * @param {string} reportName * A fully-qualified path representing Report resource. * @returns {string} A string representing the report. */ matchReportFromReportName(reportName: string): string | number; /** * Return a fully-qualified role resource name string. * * @param {string} network_code * @param {string} role * @returns {string} Resource name string. */ rolePath(networkCode: string, role: string): string; /** * Parse the network_code from Role resource. * * @param {string} roleName * A fully-qualified path representing Role resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromRoleName(roleName: string): string | number; /** * Parse the role from Role resource. * * @param {string} roleName * A fully-qualified path representing Role resource. * @returns {string} A string representing the role. */ matchRoleFromRoleName(roleName: string): string | number; /** * Return a fully-qualified taxonomyCategory resource name string. * * @param {string} network_code * @param {string} taxonomy_category * @returns {string} Resource name string. */ taxonomyCategoryPath(networkCode: string, taxonomyCategory: string): string; /** * Parse the network_code from TaxonomyCategory resource. * * @param {string} taxonomyCategoryName * A fully-qualified path representing TaxonomyCategory resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromTaxonomyCategoryName(taxonomyCategoryName: string): string | number; /** * Parse the taxonomy_category from TaxonomyCategory resource. * * @param {string} taxonomyCategoryName * A fully-qualified path representing TaxonomyCategory resource. * @returns {string} A string representing the taxonomy_category. */ matchTaxonomyCategoryFromTaxonomyCategoryName(taxonomyCategoryName: string): string | number; /** * Return a fully-qualified team resource name string. * * @param {string} network_code * @param {string} team * @returns {string} Resource name string. */ teamPath(networkCode: string, team: string): string; /** * Parse the network_code from Team resource. * * @param {string} teamName * A fully-qualified path representing Team resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromTeamName(teamName: string): string | number; /** * Parse the team from Team resource. * * @param {string} teamName * A fully-qualified path representing Team resource. * @returns {string} A string representing the team. */ matchTeamFromTeamName(teamName: string): string | number; /** * Return a fully-qualified user resource name string. * * @param {string} network_code * @param {string} user * @returns {string} Resource name string. */ userPath(networkCode: string, user: string): string; /** * Parse the network_code from User resource. * * @param {string} userName * A fully-qualified path representing User resource. * @returns {string} A string representing the network_code. */ matchNetworkCodeFromUserName(userName: string): string | number; /** * Parse the user from User resource. * * @param {string} userName * A fully-qualified path representing User resource. * @returns {string} A string representing the user. */ matchUserFromUserName(userName: 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; }