@google-cloud/chronicle
Version:
Chronicle API client for Node.js
1,071 lines • 73.6 kB
JavaScript
"use strict";
// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **
Object.defineProperty(exports, "__esModule", { value: true });
exports.FeaturedContentNativeDashboardServiceClient = void 0;
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v1/featured_content_native_dashboard_service_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./featured_content_native_dashboard_service_client_config.json");
const version = require('../../../package.json').version;
/**
* This service provides functionality for managing
* FeaturedContentNativeDashboard.
* @class
* @memberof v1
*/
class FeaturedContentNativeDashboardServiceClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('chronicle');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
pathTemplates;
featuredContentNativeDashboardServiceStub;
/**
* Construct an instance of FeaturedContentNativeDashboardServiceClient.
*
* @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 FeaturedContentNativeDashboardServiceClient({fallback: true}, gax);
* ```
*/
constructor(opts, gaxInstance) {
// Ensure that options include all the required fields.
const staticMembers = this
.constructor;
if (opts?.universe_domain &&
opts?.universeDomain &&
opts?.universe_domain !== opts?.universeDomain) {
throw new Error('Please set either universe_domain or universeDomain, but not both.');
}
const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
: undefined;
this._universeDomain =
opts?.universeDomain ??
opts?.universe_domain ??
universeDomainEnvVar ??
'googleapis.com';
this._servicePath = 'chronicle.' + this._universeDomain;
const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
const port = opts?.port || staticMembers.port;
const clientConfig = opts?.clientConfig ?? {};
const fallback = opts?.fallback ??
(typeof window !== 'undefined' && typeof window?.fetch === 'function');
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
// Request numeric enum values if REST transport is used.
opts.numericEnums = true;
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
if (servicePath !== this._servicePath && !('scopes' in opts)) {
opts['scopes'] = staticMembers.scopes;
}
// Load google-gax module synchronously if needed
if (!gaxInstance) {
gaxInstance = require('google-gax');
}
// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
// Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
// Save options to use in initialize() method.
this._opts = opts;
// Save the auth object to the client, for use by other methods.
this.auth = this._gaxGrpc.auth;
// Set useJWTAccessWithScope on the auth object.
this.auth.useJWTAccessWithScope = true;
// Set defaultServicePath on the auth object.
this.auth.defaultServicePath = this._servicePath;
// Set the default scopes in auth client if needed.
if (servicePath === this._servicePath) {
this.auth.defaultScopes = staticMembers.scopes;
}
// Determine the client header string.
const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
if (typeof process === 'object' && 'versions' in process) {
clientHeader.push(`gl-node/${process.versions.node}`);
}
else {
clientHeader.push(`gl-web/${this._gaxModule.version}`);
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
}
else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
clientHeader.push(`${opts.libName}/${opts.libVersion}`);
}
// Load the applicable protos.
this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
// This API contains "path templates"; forward-slash-separated
// identifiers to uniquely identify resources within the API.
// Create useful helper objects for these.
this.pathTemplates = {
bigQueryExportPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/bigQueryExport'),
contentHubPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/contentHub'),
dashboardChartPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}'),
dashboardQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/dashboardQueries/{query}'),
dataAccessLabelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}'),
dataAccessScopePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}'),
dataTablePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}'),
dataTableOperationErrorsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/dataTableOperationErrors/{data_table_operation_errors}'),
dataTableRowPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}'),
featuredContentNativeDashboardPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_dashboard}'),
instancePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}'),
locationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}'),
nativeDashboardPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}'),
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
referenceListPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}'),
retrohuntPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}'),
rulePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/rules/{rule}'),
ruleDeploymentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment'),
ruleExecutionErrorPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/ruleExecutionErrors/{rule_execution_error}'),
watchlistPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}'),
};
// Some of the methods on this service return "paged" results,
// (e.g. 50 results at a time, with tokens to get subsequent
// pages). Denote the keys used for pagination and results.
this.descriptors.page = {
listFeaturedContentNativeDashboards: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'featuredContentNativeDashboards'),
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.cloud.chronicle.v1.FeaturedContentNativeDashboardService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
this.innerApiCalls = {};
// Add a warn function to the client constructor so it can be easily tested.
this.warn = this._gaxModule.warn;
}
/**
* 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() {
// If the client stub promise is already initialized, return immediately.
if (this.featuredContentNativeDashboardServiceStub) {
return this.featuredContentNativeDashboardServiceStub;
}
// Put together the "service stub" for
// google.cloud.chronicle.v1.FeaturedContentNativeDashboardService.
this.featuredContentNativeDashboardServiceStub = this._gaxGrpc.createStub(this._opts.fallback
? this._protos.lookupService('google.cloud.chronicle.v1.FeaturedContentNativeDashboardService')
: // eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.cloud.chronicle.v1
.FeaturedContentNativeDashboardService, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const featuredContentNativeDashboardServiceStubMethods = [
'getFeaturedContentNativeDashboard',
'listFeaturedContentNativeDashboards',
'installFeaturedContentNativeDashboard',
];
for (const methodName of featuredContentNativeDashboardServiceStubMethods) {
const callPromise = this.featuredContentNativeDashboardServiceStub.then((stub) => (...args) => {
if (this._terminated) {
return Promise.reject('The client has already been closed.');
}
const func = stub[methodName];
return func.apply(stub, args);
}, (err) => () => {
throw err;
});
const descriptor = this.descriptors.page[methodName] || undefined;
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
this.innerApiCalls[methodName] = apiCall;
}
return this.featuredContentNativeDashboardServiceStub;
}
/**
* 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() {
if (typeof process === 'object' &&
typeof process.emitWarning === 'function') {
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'chronicle.googleapis.com';
}
/**
* 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() {
if (typeof process === 'object' &&
typeof process.emitWarning === 'function') {
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'chronicle.googleapis.com';
}
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint() {
return this._servicePath;
}
get universeDomain() {
return this._universeDomain;
}
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port() {
return 443;
}
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes() {
return [
'https://www.googleapis.com/auth/chronicle',
'https://www.googleapis.com/auth/chronicle.readonly',
'https://www.googleapis.com/auth/cloud-platform',
];
}
/**
* Return the project ID used by this class.
* @returns {Promise} A promise that resolves to string containing the project ID.
*/
getProjectId(callback) {
if (callback) {
this.auth.getProjectId(callback);
return;
}
return this.auth.getProjectId();
}
getFeaturedContentNativeDashboard(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch((err) => {
throw err;
});
this._log.info('getFeaturedContentNativeDashboard request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getFeaturedContentNativeDashboard response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.getFeaturedContentNativeDashboard(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getFeaturedContentNativeDashboard response %j', response);
return [response, options, rawResponse];
})
.catch((error) => {
if (error &&
'statusDetails' in error &&
error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
installFeaturedContentNativeDashboard(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch((err) => {
throw err;
});
this._log.info('installFeaturedContentNativeDashboard request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('installFeaturedContentNativeDashboard response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.installFeaturedContentNativeDashboard(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('installFeaturedContentNativeDashboard response %j', response);
return [response, options, rawResponse];
})
.catch((error) => {
if (error &&
'statusDetails' in error &&
error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
listFeaturedContentNativeDashboards(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
parent: request.parent ?? '',
});
this.initialize().catch((err) => {
throw err;
});
const wrappedCallback = callback
? (error, values, nextPageRequest, rawResponse) => {
this._log.info('listFeaturedContentNativeDashboards values %j', values);
callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
}
: undefined;
this._log.info('listFeaturedContentNativeDashboards request %j', request);
return this.innerApiCalls
.listFeaturedContentNativeDashboards(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('listFeaturedContentNativeDashboards values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `listFeaturedContentNativeDashboards`, 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
* FeaturedContentNativeDashboards. Format:
* projects/{project}/locations/{location}/instances/{instance}/contentHub
* @param {number} [request.pageSize]
* Optional. The maximum number of FeaturedContentNativeDashboards to return.
* The service may return fewer than this value. If unspecified, at most 100
* FeaturedContentNativeDashboards will be returned. The maximum value is 100;
* values above 100 will be coerced to 100.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous
* `ListFeaturedContentNativeDashboards` call. Provide this to retrieve the
* subsequent page.
*
* When paginating, all other parameters provided to
* `ListFeaturedContentNativeDashboards` must match the call that provided the
* page token.
* @param {string} [request.filter]
* Optional. The filter to apply to list the FeaturedContentNativeDashboards.
*
* The filter syntax follows Google Cloud syntax: https://google.aip.dev/160.
*
* Supported fields for filtering:
*
* * `name`: The resource name of the featured content.
* * `content_metadata.description`: The description of the featured
* content.
*
* When a literal value is provided without a field, it will perform a
* substring search across both `name` and `content_metadata.description`.
*
* Examples:
*
* * `"test"`: Matches featured content where either the name or description
* contains "test" as a substring.
* * `name="test"`: Matches featured content where the name contains "test".
* * `content_metadata.description="test"`: Matches featured content where
* the description contains "test".
* @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.cloud.chronicle.v1.FeaturedContentNativeDashboard|FeaturedContentNativeDashboard} 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 `listFeaturedContentNativeDashboardsAsync()`
* 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.
*/
listFeaturedContentNativeDashboardsStream(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
parent: request.parent ?? '',
});
const defaultCallSettings = this._defaults['listFeaturedContentNativeDashboards'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch((err) => {
throw err;
});
this._log.info('listFeaturedContentNativeDashboards stream %j', request);
return this.descriptors.page.listFeaturedContentNativeDashboards.createStream(this.innerApiCalls.listFeaturedContentNativeDashboards, request, callSettings);
}
/**
* Equivalent to `listFeaturedContentNativeDashboards`, 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
* FeaturedContentNativeDashboards. Format:
* projects/{project}/locations/{location}/instances/{instance}/contentHub
* @param {number} [request.pageSize]
* Optional. The maximum number of FeaturedContentNativeDashboards to return.
* The service may return fewer than this value. If unspecified, at most 100
* FeaturedContentNativeDashboards will be returned. The maximum value is 100;
* values above 100 will be coerced to 100.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous
* `ListFeaturedContentNativeDashboards` call. Provide this to retrieve the
* subsequent page.
*
* When paginating, all other parameters provided to
* `ListFeaturedContentNativeDashboards` must match the call that provided the
* page token.
* @param {string} [request.filter]
* Optional. The filter to apply to list the FeaturedContentNativeDashboards.
*
* The filter syntax follows Google Cloud syntax: https://google.aip.dev/160.
*
* Supported fields for filtering:
*
* * `name`: The resource name of the featured content.
* * `content_metadata.description`: The description of the featured
* content.
*
* When a literal value is provided without a field, it will perform a
* substring search across both `name` and `content_metadata.description`.
*
* Examples:
*
* * `"test"`: Matches featured content where either the name or description
* contains "test" as a substring.
* * `name="test"`: Matches featured content where the name contains "test".
* * `content_metadata.description="test"`: Matches featured content where
* the description contains "test".
* @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.cloud.chronicle.v1.FeaturedContentNativeDashboard|FeaturedContentNativeDashboard}. 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/featured_content_native_dashboard_service.list_featured_content_native_dashboards.js</caption>
* region_tag:chronicle_v1_generated_FeaturedContentNativeDashboardService_ListFeaturedContentNativeDashboards_async
*/
listFeaturedContentNativeDashboardsAsync(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
parent: request.parent ?? '',
});
const defaultCallSettings = this._defaults['listFeaturedContentNativeDashboards'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch((err) => {
throw err;
});
this._log.info('listFeaturedContentNativeDashboards iterate %j', request);
return this.descriptors.page.listFeaturedContentNativeDashboards.asyncIterate(this.innerApiCalls['listFeaturedContentNativeDashboards'], request, callSettings);
}
// --------------------
// -- Path templates --
// --------------------
/**
* Return a fully-qualified bigQueryExport resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @returns {string} Resource name string.
*/
bigQueryExportPath(project, location, instance) {
return this.pathTemplates.bigQueryExportPathTemplate.render({
project: project,
location: location,
instance: instance,
});
}
/**
* Parse the project from BigQueryExport resource.
*
* @param {string} bigQueryExportName
* A fully-qualified path representing BigQueryExport resource.
* @returns {string} A string representing the project.
*/
matchProjectFromBigQueryExportName(bigQueryExportName) {
return this.pathTemplates.bigQueryExportPathTemplate.match(bigQueryExportName).project;
}
/**
* Parse the location from BigQueryExport resource.
*
* @param {string} bigQueryExportName
* A fully-qualified path representing BigQueryExport resource.
* @returns {string} A string representing the location.
*/
matchLocationFromBigQueryExportName(bigQueryExportName) {
return this.pathTemplates.bigQueryExportPathTemplate.match(bigQueryExportName).location;
}
/**
* Parse the instance from BigQueryExport resource.
*
* @param {string} bigQueryExportName
* A fully-qualified path representing BigQueryExport resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromBigQueryExportName(bigQueryExportName) {
return this.pathTemplates.bigQueryExportPathTemplate.match(bigQueryExportName).instance;
}
/**
* Return a fully-qualified contentHub resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @returns {string} Resource name string.
*/
contentHubPath(project, location, instance) {
return this.pathTemplates.contentHubPathTemplate.render({
project: project,
location: location,
instance: instance,
});
}
/**
* Parse the project from ContentHub resource.
*
* @param {string} contentHubName
* A fully-qualified path representing ContentHub resource.
* @returns {string} A string representing the project.
*/
matchProjectFromContentHubName(contentHubName) {
return this.pathTemplates.contentHubPathTemplate.match(contentHubName)
.project;
}
/**
* Parse the location from ContentHub resource.
*
* @param {string} contentHubName
* A fully-qualified path representing ContentHub resource.
* @returns {string} A string representing the location.
*/
matchLocationFromContentHubName(contentHubName) {
return this.pathTemplates.contentHubPathTemplate.match(contentHubName)
.location;
}
/**
* Parse the instance from ContentHub resource.
*
* @param {string} contentHubName
* A fully-qualified path representing ContentHub resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromContentHubName(contentHubName) {
return this.pathTemplates.contentHubPathTemplate.match(contentHubName)
.instance;
}
/**
* Return a fully-qualified dashboardChart resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} chart
* @returns {string} Resource name string.
*/
dashboardChartPath(project, location, instance, chart) {
return this.pathTemplates.dashboardChartPathTemplate.render({
project: project,
location: location,
instance: instance,
chart: chart,
});
}
/**
* Parse the project from DashboardChart resource.
*
* @param {string} dashboardChartName
* A fully-qualified path representing DashboardChart resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDashboardChartName(dashboardChartName) {
return this.pathTemplates.dashboardChartPathTemplate.match(dashboardChartName).project;
}
/**
* Parse the location from DashboardChart resource.
*
* @param {string} dashboardChartName
* A fully-qualified path representing DashboardChart resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDashboardChartName(dashboardChartName) {
return this.pathTemplates.dashboardChartPathTemplate.match(dashboardChartName).location;
}
/**
* Parse the instance from DashboardChart resource.
*
* @param {string} dashboardChartName
* A fully-qualified path representing DashboardChart resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromDashboardChartName(dashboardChartName) {
return this.pathTemplates.dashboardChartPathTemplate.match(dashboardChartName).instance;
}
/**
* Parse the chart from DashboardChart resource.
*
* @param {string} dashboardChartName
* A fully-qualified path representing DashboardChart resource.
* @returns {string} A string representing the chart.
*/
matchChartFromDashboardChartName(dashboardChartName) {
return this.pathTemplates.dashboardChartPathTemplate.match(dashboardChartName).chart;
}
/**
* Return a fully-qualified dashboardQuery resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} query
* @returns {string} Resource name string.
*/
dashboardQueryPath(project, location, instance, query) {
return this.pathTemplates.dashboardQueryPathTemplate.render({
project: project,
location: location,
instance: instance,
query: query,
});
}
/**
* Parse the project from DashboardQuery resource.
*
* @param {string} dashboardQueryName
* A fully-qualified path representing DashboardQuery resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDashboardQueryName(dashboardQueryName) {
return this.pathTemplates.dashboardQueryPathTemplate.match(dashboardQueryName).project;
}
/**
* Parse the location from DashboardQuery resource.
*
* @param {string} dashboardQueryName
* A fully-qualified path representing DashboardQuery resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDashboardQueryName(dashboardQueryName) {
return this.pathTemplates.dashboardQueryPathTemplate.match(dashboardQueryName).location;
}
/**
* Parse the instance from DashboardQuery resource.
*
* @param {string} dashboardQueryName
* A fully-qualified path representing DashboardQuery resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromDashboardQueryName(dashboardQueryName) {
return this.pathTemplates.dashboardQueryPathTemplate.match(dashboardQueryName).instance;
}
/**
* Parse the query from DashboardQuery resource.
*
* @param {string} dashboardQueryName
* A fully-qualified path representing DashboardQuery resource.
* @returns {string} A string representing the query.
*/
matchQueryFromDashboardQueryName(dashboardQueryName) {
return this.pathTemplates.dashboardQueryPathTemplate.match(dashboardQueryName).query;
}
/**
* Return a fully-qualified dataAccessLabel resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} data_access_label
* @returns {string} Resource name string.
*/
dataAccessLabelPath(project, location, instance, dataAccessLabel) {
return this.pathTemplates.dataAccessLabelPathTemplate.render({
project: project,
location: location,
instance: instance,
data_access_label: dataAccessLabel,
});
}
/**
* Parse the project from DataAccessLabel resource.
*
* @param {string} dataAccessLabelName
* A fully-qualified path representing DataAccessLabel resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDataAccessLabelName(dataAccessLabelName) {
return this.pathTemplates.dataAccessLabelPathTemplate.match(dataAccessLabelName).project;
}
/**
* Parse the location from DataAccessLabel resource.
*
* @param {string} dataAccessLabelName
* A fully-qualified path representing DataAccessLabel resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDataAccessLabelName(dataAccessLabelName) {
return this.pathTemplates.dataAccessLabelPathTemplate.match(dataAccessLabelName).location;
}
/**
* Parse the instance from DataAccessLabel resource.
*
* @param {string} dataAccessLabelName
* A fully-qualified path representing DataAccessLabel resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromDataAccessLabelName(dataAccessLabelName) {
return this.pathTemplates.dataAccessLabelPathTemplate.match(dataAccessLabelName).instance;
}
/**
* Parse the data_access_label from DataAccessLabel resource.
*
* @param {string} dataAccessLabelName
* A fully-qualified path representing DataAccessLabel resource.
* @returns {string} A string representing the data_access_label.
*/
matchDataAccessLabelFromDataAccessLabelName(dataAccessLabelName) {
return this.pathTemplates.dataAccessLabelPathTemplate.match(dataAccessLabelName).data_access_label;
}
/**
* Return a fully-qualified dataAccessScope resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} data_access_scope
* @returns {string} Resource name string.
*/
dataAccessScopePath(project, location, instance, dataAccessScope) {
return this.pathTemplates.dataAccessScopePathTemplate.render({
project: project,
location: location,
instance: instance,
data_access_scope: dataAccessScope,
});
}
/**
* Parse the project from DataAccessScope resource.
*
* @param {string} dataAccessScopeName
* A fully-qualified path representing DataAccessScope resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDataAccessScopeName(dataAccessScopeName) {
return this.pathTemplates.dataAccessScopePathTemplate.match(dataAccessScopeName).project;
}
/**
* Parse the location from DataAccessScope resource.
*
* @param {string} dataAccessScopeName
* A fully-qualified path representing DataAccessScope resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDataAccessScopeName(dataAccessScopeName) {
return this.pathTemplates.dataAccessScopePathTemplate.match(dataAccessScopeName).location;
}
/**
* Parse the instance from DataAccessScope resource.
*
* @param {string} dataAccessScopeName
* A fully-qualified path representing DataAccessScope resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromDataAccessScopeName(dataAccessScopeName) {
return this.pathTemplates.dataAccessScopePathTemplate.match(dataAccessScopeName).instance;
}
/**
* Parse the data_access_scope from DataAccessScope resource.
*
* @param {string} dataAccessScopeName
* A fully-qualified path representing DataAccessScope resource.
* @returns {string} A string representing the data_access_scope.
*/
matchDataAccessScopeFromDataAccessScopeName(dataAccessScopeName) {
return this.pathTemplates.dataAccessScopePathTemplate.match(dataAccessScopeName).data_access_scope;
}
/**
* Return a fully-qualified dataTable resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} data_table
* @returns {string} Resource name string.
*/
dataTablePath(project, location, instance, dataTable) {
return this.pathTemplates.dataTablePathTemplate.render({
project: project,
location: location,
instance: instance,
data_table: dataTable,
});
}
/**
* Parse the project from DataTable resource.
*
* @param {string} dataTableName
* A fully-qualified path representing DataTable resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDataTableName(dataTableName) {
return this.pathTemplates.dataTablePathTemplate.match(dataTableName)
.project;
}
/**
* Parse the location from DataTable resource.
*
* @param {string} dataTableName
* A fully-qualified path representing DataTable resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDataTableName(dataTableName) {
return this.pathTemplates.dataTablePathTemplate.match(dataTableName)
.location;
}
/**
* Parse the instance from DataTable resource.
*
* @param {string} dataTableName
* A fully-qualified path representing DataTable resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromDataTableName(dataTableName) {
return this.pathTemplates.dataTablePathTemplate.match(dataTableName)
.instance;
}
/**
* Parse the data_table from DataTable resource.
*
* @param {string} dataTableName
* A fully-qualified path representing DataTable resource.
* @returns {string} A string representing the data_table.
*/
matchDataTableFromDataTableName(dataTableName) {
return this.pathTemplates.dataTablePathTemplate.match(dataTableName)
.data_table;
}
/**
* Return a fully-qualified dataTableOperationErrors resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} data_table_operation_errors
* @returns {string} Resource name string.
*/
dataTableOperationErrorsPath(project, location, instance, dataTableOperationErrors) {
return this.pathTemplates.dataTableOperationErrorsPathTemplate.render({
project: project,
location: location,
instance: instance,
data_table_operation_errors: dataTableOperationErrors,
});
}
/**
* Parse the project from DataTableOperationErrors resource.
*
* @param {string} dataTableOperationErrorsName
* A fully-qualified path representing DataTableOperationErrors resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDataTableOperationErrorsName(dataTableOperationErrorsName) {
return this.pathTemplates.dataTableOperationErrorsPathTemplate.match(dataTableOperationErrorsName).project;
}
/**
* Parse the location from DataTableOperationErrors resource.
*
* @param {string} dataTableOperationErrorsName
* A fully-qualified path representing DataTableOperationErrors resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDataTableOperationErrorsName(dataTableOperationErrorsName) {
return this.pathTemplates.dataTableOperationErrorsPathTemplate.match(dataTableOperationErrorsName).location;
}
/**
* Parse the instance from DataTableOperationErrors resource.
*
* @param {string} dataTableOperationErrorsName
* A fully-qualified path representing DataTableOperationErrors resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromDataTableOperationErrorsName(dataTableOperationErrorsName) {
return this.pathTemplates.dataTableOperationErrorsPathTemplate.match(dataTableOperationErrorsName).instance;
}
/**
* Parse the data_table_operation_errors from DataTableOperationErrors resource.
*
* @param {string} dataTableOperationErrorsName
* A fully-qualified path representing DataTableOperationErrors resource.
* @returns {string} A string representing the data_table_operation_errors.
*/
matchDataTableOperationErrorsFromDataTableOperationErrorsName(dataTableOperationErrorsName) {
return this.pathTemplates.dataTableOperationErrorsPathTemplate.match(dataTableOperationErrorsName).data_table_operation_errors;
}
/**
* Return a fully-qualified dataTableRow resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} data_table
* @param {string} data_table_row
* @returns {string} Resource name string.
*/
dataTableRowPath(project, location, instance, dataTable, dataTableRow) {
return this.pathTemplates.dataTableRowPathTemplate.render({
project: project,
location: location,
instance: instance,
data_table: dataTable,
data_table_row: dataTableRow,
});
}
/**
* Parse the project from DataTableRow resource.
*
* @param {string} dataTableRowName
* A fully-qualified path representing DataTableRow resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDataTableRowName(dataTableRowName) {
return this.pathTemplates.dataTableRowPathTemplate.match(dataTableRowName)
.project;
}
/**
* Parse the location from DataTableRow resource.
*
* @param {string} dataTableRowName
* A fully-qualified path representing DataTableRow resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDataTableRowName(dataTableRowName) {
return this.pathTemplates.dataTableRowPathTemplate.match(dataTableRowName)
.location;
}
/**
* Parse the instance from DataTableRow resource.
*
* @param {string} dataTableRowName
* A fully-qualified path representing DataTableRow resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromDataTableRowName(dataTableRowName) {
return this.pathTemplates.dataTableRowPathTemplate.match(dataTableRowNa