@google-ads/admanager/build/src/v1/ad_break_service_client.d.ts

Google Ad Manager API client for Node.js

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';
/**
 *  Provides methods for handling `AdBreak` objects.
 * @class
 * @memberof v1
 */
export declare class AdBreakServiceClient {
    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;
    };
    adBreakServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of AdBreakServiceClient.
     *
     * @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 AdBreakServiceClient({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<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    /**
     * API to retrieve an `AdBreak` object.
     *
     * Query an ad break by its resource name or custom asset key. Check the
     * resource's `breakState` field to determine its state.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The resource name of the AdBreak using the asset key or custom
     *   asset key.
     *
     *   Format:
     *   `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break_id}`
     *   `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}/adBreaks/{ad_break_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.AdBreak|AdBreak}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/ad_break_service.get_ad_break.js</caption>
     * region_tag:admanager_v1_generated_AdBreakService_GetAdBreak_async
     */
    getAdBreak(request?: protos.google.ads.admanager.v1.IGetAdBreakRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.IAdBreak,
        protos.google.ads.admanager.v1.IGetAdBreakRequest | undefined,
        {} | undefined
    ]>;
    getAdBreak(request: protos.google.ads.admanager.v1.IGetAdBreakRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IAdBreak, protos.google.ads.admanager.v1.IGetAdBreakRequest | null | undefined, {} | null | undefined>): void;
    getAdBreak(request: protos.google.ads.admanager.v1.IGetAdBreakRequest, callback: Callback<protos.google.ads.admanager.v1.IAdBreak, protos.google.ads.admanager.v1.IGetAdBreakRequest | null | undefined, {} | null | undefined>): void;
    /**
     * API to create an `AdBreak` object.
     *
     * Informs DAI of an upcoming ad break for a live stream event, with an
     * optional expected start time. DAI will begin decisioning ads for the break
     * shortly before the expected start time, if provided. Each live stream
     * event can only have one incomplete ad break at any given time. The next ad
     * break can be scheduled after the previous ad break has started serving,
     * indicated by its state being
     * {@link protos.google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.COMPLETE|`COMPLETE`},
     * or it has been deleted.
     *
     * This method cannot be used if the `LiveStreamEvent` has
     * [prefetching ad breaks
     * enabled](https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#prefetchenabled)
     * or the event is not active. If a `LiveStreamEvent` is deactivated after
     * creating an ad break and before the ad break is complete, the ad break
     * is discarded.
     *
     * An ad break's state is complete when the following occurs:
     *  - Full service DAI: after a matching ad break shows in the
     *  `LiveStreamEvent` manifest only when the ad break has started decisioning.
     *  - Pod Serving: after the ad break is requested using the ad break ID or
     *  break sequence.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent resource where this `AdBreak` will be created
     *   identified by an asset key or custom asset key.
     *
     *   Formats:
     *   `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}`
     *   `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}`
     * @param {google.ads.admanager.v1.AdBreak} request.adBreak
     *   Required. The `AdBreak` 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.AdBreak|AdBreak}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/ad_break_service.create_ad_break.js</caption>
     * region_tag:admanager_v1_generated_AdBreakService_CreateAdBreak_async
     */
    createAdBreak(request?: protos.google.ads.admanager.v1.ICreateAdBreakRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.IAdBreak,
        protos.google.ads.admanager.v1.ICreateAdBreakRequest | undefined,
        {} | undefined
    ]>;
    createAdBreak(request: protos.google.ads.admanager.v1.ICreateAdBreakRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IAdBreak, protos.google.ads.admanager.v1.ICreateAdBreakRequest | null | undefined, {} | null | undefined>): void;
    createAdBreak(request: protos.google.ads.admanager.v1.ICreateAdBreakRequest, callback: Callback<protos.google.ads.admanager.v1.IAdBreak, protos.google.ads.admanager.v1.ICreateAdBreakRequest | null | undefined, {} | null | undefined>): void;
    /**
     * API to update an `AdBreak` object.
     *
     * Modify an ad break when its state is
     * {@link protos.google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED|`SCHEDULED`}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.ads.admanager.v1.AdBreak} request.adBreak
     *   Required. The `AdBreak` to update.
     *
     *   The `AdBreak`'s `name` is used to identify the `AdBreak` 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.AdBreak|AdBreak}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/ad_break_service.update_ad_break.js</caption>
     * region_tag:admanager_v1_generated_AdBreakService_UpdateAdBreak_async
     */
    updateAdBreak(request?: protos.google.ads.admanager.v1.IUpdateAdBreakRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.IAdBreak,
        protos.google.ads.admanager.v1.IUpdateAdBreakRequest | undefined,
        {} | undefined
    ]>;
    updateAdBreak(request: protos.google.ads.admanager.v1.IUpdateAdBreakRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IAdBreak, protos.google.ads.admanager.v1.IUpdateAdBreakRequest | null | undefined, {} | null | undefined>): void;
    updateAdBreak(request: protos.google.ads.admanager.v1.IUpdateAdBreakRequest, callback: Callback<protos.google.ads.admanager.v1.IAdBreak, protos.google.ads.admanager.v1.IUpdateAdBreakRequest | null | undefined, {} | null | undefined>): void;
    /**
     * API to delete an `AdBreak` object.
     *
     * Deletes and cancels an incomplete ad break, mitigating the need to wait
     * for the current break to serve before recreating an ad break. You can
     * delete an ad break that has not started serving or seen in manifests,
     * indicated by its state being
     * {@link protos.google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED|`SCHEDULED`}
     * or
     * {@link protos.google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.DECISIONED|`DECISIONED`}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the ad break to delete.
     *
     *   Format:
     *   `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}`
     * @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 <caption>include:samples/generated/v1/ad_break_service.delete_ad_break.js</caption>
     * region_tag:admanager_v1_generated_AdBreakService_DeleteAdBreak_async
     */
    deleteAdBreak(request?: protos.google.ads.admanager.v1.IDeleteAdBreakRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.ads.admanager.v1.IDeleteAdBreakRequest | undefined,
        {} | undefined
    ]>;
    deleteAdBreak(request: protos.google.ads.admanager.v1.IDeleteAdBreakRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.ads.admanager.v1.IDeleteAdBreakRequest | null | undefined, {} | null | undefined>): void;
    deleteAdBreak(request: protos.google.ads.admanager.v1.IDeleteAdBreakRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.ads.admanager.v1.IDeleteAdBreakRequest | null | undefined, {} | null | undefined>): void;
    /**
    * API to retrieve a list of `AdBreak` objects.
    *
    * By default, when no `orderBy` query parameter is specified, ad breaks are
    * ordered reverse chronologically. However, ad breaks with a 'breakState' of
    * 'SCHEDULED' or 'DECISIONED' are prioritized and appear first.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The parent, which owns this collection of AdBreaks.
    *
    *   Formats:
    *   `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}`
    *   `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}`
    * @param {number} [request.pageSize]
    *   Optional. The maximum number of `AdBreaks` to return. The service might
    *   return fewer than this value. If unspecified, at most 10 ad breaks are
    *   returned. The maximum value is `100`. Values above `100` are coerced to
    *   `100`.
    * @param {string} [request.pageToken]
    *   Optional. A page token, received from a previous `ListAdBreaks` call.
    *   Provide this to retrieve the subsequent page.
    *
    *   When paginating, all other parameters provided to `ListAdBreaks` 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.AdBreak|AdBreak}.
    *   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 `listAdBreaksAsync()`
    *   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.
    */
    listAdBreaks(request?: protos.google.ads.admanager.v1.IListAdBreaksRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.IAdBreak[],
        protos.google.ads.admanager.v1.IListAdBreaksRequest | null,
        protos.google.ads.admanager.v1.IListAdBreaksResponse
    ]>;
    listAdBreaks(request: protos.google.ads.admanager.v1.IListAdBreaksRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.admanager.v1.IListAdBreaksRequest, protos.google.ads.admanager.v1.IListAdBreaksResponse | null | undefined, protos.google.ads.admanager.v1.IAdBreak>): void;
    listAdBreaks(request: protos.google.ads.admanager.v1.IListAdBreaksRequest, callback: PaginationCallback<protos.google.ads.admanager.v1.IListAdBreaksRequest, protos.google.ads.admanager.v1.IListAdBreaksResponse | null | undefined, protos.google.ads.admanager.v1.IAdBreak>): void;
    /**
     * Equivalent to `listAdBreaks`, 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 AdBreaks.
     *
     *   Formats:
     *   `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}`
     *   `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of `AdBreaks` to return. The service might
     *   return fewer than this value. If unspecified, at most 10 ad breaks are
     *   returned. The maximum value is `100`. Values above `100` are coerced to
     *   `100`.
     * @param {string} [request.pageToken]
     *   Optional. A page token, received from a previous `ListAdBreaks` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to `ListAdBreaks` 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.AdBreak|AdBreak} 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 `listAdBreaksAsync()`
     *   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.
     */
    listAdBreaksStream(request?: protos.google.ads.admanager.v1.IListAdBreaksRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listAdBreaks`, 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 AdBreaks.
     *
     *   Formats:
     *   `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}`
     *   `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of `AdBreaks` to return. The service might
     *   return fewer than this value. If unspecified, at most 10 ad breaks are
     *   returned. The maximum value is `100`. Values above `100` are coerced to
     *   `100`.
     * @param {string} [request.pageToken]
     *   Optional. A page token, received from a previous `ListAdBreaks` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to `ListAdBreaks` 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.AdBreak|AdBreak}. 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 <caption>include:samples/generated/v1/ad_break_service.list_ad_breaks.js</caption>
     * region_tag:admanager_v1_generated_AdBreakService_ListAdBreaks_async
     */
    listAdBreaksAsync(request?: protos.google.ads.admanager.v1.IListAdBreaksRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.IAdBreak>;
    /**
     * Return a fully-qualified adBreak resource name string.
     *
     * @param {string} network_code
     * @param {string} asset_key
     * @param {string} ad_break
     * @returns {string} Resource name string.
     */
    adBreakPath(networkCode: string, assetKey: string, adBreak: string): string;
    /**
     * Parse the network_code from AdBreak resource.
     *
     * @param {string} adBreakName
     *   A fully-qualified path representing AdBreak resource.
     * @returns {string} A string representing the network_code.
     */
    matchNetworkCodeFromAdBreakName(adBreakName: string): string | number;
    /**
     * Parse the asset_key from AdBreak resource.
     *
     * @param {string} adBreakName
     *   A fully-qualified path representing AdBreak resource.
     * @returns {string} A string representing the asset_key.
     */
    matchAssetKeyFromAdBreakName(adBreakName: string): string | number;
    /**
     * Parse the ad_break from AdBreak resource.
     *
     * @param {string} adBreakName
     *   A fully-qualified path representing AdBreak resource.
     * @returns {string} A string representing the ad_break.
     */
    matchAdBreakFromAdBreakName(adBreakName: string): string | number;
    /**
     * 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 bandwidthGroup resource name string.
     *
     * @param {string} network_code
     * @param {string} bandwidth_group
     * @returns {string} Resource name string.
     */
    bandwidthGroupPath(networkCode: string, bandwidthGroup: string): string;
    /**
     * Parse the network_code from BandwidthGroup resource.
     *
     * @param {string} bandwidthGroupName
     *   A fully-qualified path representing BandwidthGroup resource.
     * @returns {string} A string representing the network_code.
     */
    matchNetworkCodeFromBandwidthGroupName(bandwidthGroupName: string): string | number;
    /**
     * Parse the bandwidth_group from BandwidthGroup resource.
     *
     * @param {string} bandwidthGroupName
     *   A fully-qualified path representing BandwidthGroup resource.
     * @returns {string} A string representing the bandwidth_group.
     */
    matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName: 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_value
     * @returns {string} Resource name string.
     */
    customTargetingValuePath(networkCode: 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_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 deviceCategory resource name string.
     *
     * @param {string} network_code
     * @param {string} device_category
     * @returns {string} Resource name string.
     */
    deviceCategoryPath(networkCode: string, deviceCategory: string): string;
    /**
     * Parse the network_code from DeviceCategory resource.
     *
     * @param {string} deviceCategoryName
     *   A fully-qualified path representing DeviceCategory resource.
     * @returns {string} A string representing the network_code.
     */
    matchNetworkCodeFromDeviceCategoryName(deviceCategoryName: string): string | number;
    /**
     * Parse the device_category from DeviceCategory resource.
     *
     * @param {string} deviceCategoryName
     *   A fully-qualified path representing DeviceCategory resource.
     * @returns {string} A string representing the device_category.
     */
    matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName: 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 geoTarget resource name string.
     *
     * @param {string} network_code
     * @param {string} geo_target
     * @returns {string} Resource name string.
     */
    geoTargetPath(networkCode: string, geoTarget: string): string;
    /**
     * Parse the network_code from GeoTarget resource.
     *
     * @param {string} geoTargetName
     *   A fully-qualified path representing GeoTarget resource.
     * @returns {string} A string representing the network_code.
     */
    matchNetworkCodeFromGeoTargetName(geoTargetName: string): string | number;
    /**
     * Parse the geo_target from GeoTarget resource.
     *
     * @param {string} geoTargetName
     *   A fully-qualified path representing GeoTarget resource.
     * @returns {string} A string representing the geo_target.
     */
    matchGeoTargetFromGeoTargetName(geoTargetName: 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 liveStreamEvent resource name string.
     *
     * @param {string} network_code
     * @param {string} live_stream_event
     * @returns {string} Resource name string.
     */
    liveStreamEventPath(networkCode: string, liveStreamEvent: string): string;
    /**
     * Parse the network_code from LiveStreamEvent resource.
     *
     * @param {string} liveStreamEventName
     *   A fully-qualified path representing LiveStreamEvent resource.
     * @returns {string} A string representing the network_code.
     */
    matchNetworkCodeFromLiveStreamEventName(liveStreamEventName: string): string | number;
    /**
     * Parse the live_stream_event from LiveStreamEvent resource.
     *
     * @param {string} liveStreamEventName
     *   A fully-qualified path representing LiveStreamEvent resource.
     * @returns {string} A string representing the live_stream_event.
     */
    matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName: 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 operatingSystem resource name string.
     *
     * @param {string} network_code
     * @param {string} operating_system
     * @returns {string} Resource name string.
     */
    operatingSystemPath(networkCode: string, operatingSystem: string): string;
    /**
     * Parse the network_code from OperatingSystem resource.
     *
     * @param {string} operatingSystemName
     *   A fully-qualified path representing OperatingSystem resource.
     * @returns {string} A string representing the network_code.
     */
    matchNetworkCodeFromOperatingSystemName(operatingSystemName: string): string | number;
    /**
     * Parse the operating_system from OperatingSystem resource.
     *
     * @param {string} operatingSystemName
     *   A fully-qualified path representing OperatingSystem resource.
     * @returns {string} A string representing the operating_system.
     */
    matchOperatingSystemFromOperatingSystemName(operatingSystemName: string): string | number;
    /**
     * Return a fully-qualified operatingSystemVersion resource name string.
     *
     * @param {string} network_code
     * @param {string} operating_system_version
     * @returns {string} Resource name string.
     */
    operatingSystemVersionPath(networkCode: string, operatingSystemVersion: string): string;
    /**
     * Parse the network_code from OperatingSystemVersion resource.
     *
     * @param {string} operatingSystemVersionName
     *   A fully-qualified path representing OperatingSystemVersion resource.
     * @returns {string} A string representing the network_code.
     */
    matchNetworkCodeFromOperatingSystemVersionName(operatingSystemVersionName: string): string | number;
    /**
     * Parse the operating_system_version from OperatingSystemVersion resource.
     *
     * @param {string} operatingSystemVersionName
     *   A fully-qualified path representing OperatingSystemVersion resource.
     * @returns {string} A string representing the operating_system_version.
     */
    matchOperatingSystemVersionFromOperatingSystemVersionName(operatingSystemVersionName: 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 privateAuction resource name string.
     *
     * @param {string} network_code
     * @param {string} private_auction
     * @returns {string} Resource name string.
     */
    privateAuctionPath(networkCode: string, privateAuction: string): string;
    /**
     * Parse the network_code from PrivateAuction resource.
     *
     * @param {string} privateAuctionName
     *   A fully-qualified path representing PrivateAuction resource.
     * @returns {string} A string representing the network_code.
     */
    matchNetworkCodeFromPrivateAuctionName(privateAuctionName: string): string | number;
    /**
     * Parse the private_auction from PrivateAuction resource.
     *
     * @param {string} privateAuctionName
     *   A fully-qualified path representing PrivateAuction resource.
     * @returns {string} A string representing the private_auction.
     */
    matchPrivateAuctionFromPrivateAuctionName(privateAuctionName: string): string | number;
    /**
     * Return a fully-qualified privateAuctionDeal resource name string.
     *
     * @param {string} network_code
     * @param {string} private_auction_deal
     * @returns {string} Resource name string.
     */
    privateAuctionDealPath(networkCode: string, privateAuctionDeal: string): string;
    /**
     * Parse the network_code from PrivateAuctionDeal resource.
     *
     * @param {string} privateAuctionDealName
     *   A fully-qualified path representing PrivateAuctionDeal resource.
     * @returns {string} A string representing the network_code.
     */
    matchNetworkCodeFromPrivateAuctionDealName(privateAuctionDealName: string): string | number;
    /**
     * Parse the private_auction_deal from PrivateAuctionDeal resource.
     *
     * @param {string} privateAuctionDealName
     *   A fully-qualified path representing PrivateAuctionDeal resource.
     * @returns {string} A string representing the private_auction_deal.
     */
    matchPrivateAuctionDealFromPrivateAuctionDealName(privateAuctionDealName: string): string | number;
    /**
     * Return a fully-qualified programmaticBuyer resource name string.
     *
     * @param {string} network_code
     * @param {string} programmatic_buyer
     * @returns {string} Resource name string.
     */
    programmaticBuyerPath(networkCode: string, programmaticBuyer: string): string;
    /**
     * Parse the network_code from ProgrammaticBuyer resource.
     *
     * @param {string} programmaticBuyerName
     *   A fully-qualified path representing ProgrammaticBuyer resource.
     * @returns {string} A string representing the network_code.
     */
    matchNetworkCodeFromProgrammaticBuyerName(programmaticBuyerName: string): string | number;
    /**
     * Parse the programmatic_buyer from ProgrammaticBuyer resource.
     *
     * @param {string} programmaticBuyerName
     *   A fully-qualified path representing ProgrammaticBuyer resource.
     * @returns {string} A string representing the programmatic_buyer.
     */
    matchProgrammaticBuyerFromProgrammaticBuyerName(programmaticBuyerName: 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<void>;
}