@google-cloud/chronicle
Version:
Chronicle API client for Node.js
852 lines (851 loc) • 68.5 kB
TypeScript
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';
/**
* A service providing functionality for managing native dashboards.
* @class
* @memberof v1
*/
export declare class NativeDashboardServiceClient {
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;
};
nativeDashboardServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of NativeDashboardServiceClient.
*
* @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 NativeDashboardServiceClient({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;
/**
* Create a dashboard.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this dashboard will be created.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {google.cloud.chronicle.v1.NativeDashboard} request.nativeDashboard
* Required. The dashboard 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.cloud.chronicle.v1.NativeDashboard|NativeDashboard}.
* 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/native_dashboard_service.create_native_dashboard.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_CreateNativeDashboard_async
*/
createNativeDashboard(request?: protos.google.cloud.chronicle.v1.ICreateNativeDashboardRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.INativeDashboard,
(protos.google.cloud.chronicle.v1.ICreateNativeDashboardRequest | undefined),
{} | undefined
]>;
createNativeDashboard(request: protos.google.cloud.chronicle.v1.ICreateNativeDashboardRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.ICreateNativeDashboardRequest | null | undefined, {} | null | undefined>): void;
createNativeDashboard(request: protos.google.cloud.chronicle.v1.ICreateNativeDashboardRequest, callback: Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.ICreateNativeDashboardRequest | null | undefined, {} | null | undefined>): void;
/**
* Get a dashboard.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The dashboard name to fetch.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
* @param {google.cloud.chronicle.v1.NativeDashboardView} [request.view]
* Optional. View indicates the scope of fields to populate when returning the
* dashboard resource. If unspecified, defaults to the basic view.
* @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.cloud.chronicle.v1.NativeDashboard|NativeDashboard}.
* 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/native_dashboard_service.get_native_dashboard.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_GetNativeDashboard_async
*/
getNativeDashboard(request?: protos.google.cloud.chronicle.v1.IGetNativeDashboardRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.INativeDashboard,
protos.google.cloud.chronicle.v1.IGetNativeDashboardRequest | undefined,
{} | undefined
]>;
getNativeDashboard(request: protos.google.cloud.chronicle.v1.IGetNativeDashboardRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IGetNativeDashboardRequest | null | undefined, {} | null | undefined>): void;
getNativeDashboard(request: protos.google.cloud.chronicle.v1.IGetNativeDashboardRequest, callback: Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IGetNativeDashboardRequest | null | undefined, {} | null | undefined>): void;
/**
* Update a dashboard.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.chronicle.v1.NativeDashboard} request.nativeDashboard
* Required. The dashboard to update.
*
* The dashboard's `name` field is used to identify the dashboard to update.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
* @param {google.protobuf.FieldMask} request.updateMask
* Required. LINT.IfChange(update_mask_values)
* The list of fields to update.
* Supported paths are -
* display_name
* description
* definition.filters
* definition.charts
* type
* access
* dashboard_user_data.is_pinned
* @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.cloud.chronicle.v1.NativeDashboard|NativeDashboard}.
* 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/native_dashboard_service.update_native_dashboard.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_UpdateNativeDashboard_async
*/
updateNativeDashboard(request?: protos.google.cloud.chronicle.v1.IUpdateNativeDashboardRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.INativeDashboard,
(protos.google.cloud.chronicle.v1.IUpdateNativeDashboardRequest | undefined),
{} | undefined
]>;
updateNativeDashboard(request: protos.google.cloud.chronicle.v1.IUpdateNativeDashboardRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IUpdateNativeDashboardRequest | null | undefined, {} | null | undefined>): void;
updateNativeDashboard(request: protos.google.cloud.chronicle.v1.IUpdateNativeDashboardRequest, callback: Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IUpdateNativeDashboardRequest | null | undefined, {} | null | undefined>): void;
/**
* Duplicate a dashboard.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The dashboard name to duplicate.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
* @param {google.cloud.chronicle.v1.NativeDashboard} request.nativeDashboard
* Required. Any fields that need modification can be passed through this like
* name, description etc.
* @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.cloud.chronicle.v1.NativeDashboard|NativeDashboard}.
* 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/native_dashboard_service.duplicate_native_dashboard.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_DuplicateNativeDashboard_async
*/
duplicateNativeDashboard(request?: protos.google.cloud.chronicle.v1.IDuplicateNativeDashboardRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.INativeDashboard,
(protos.google.cloud.chronicle.v1.IDuplicateNativeDashboardRequest | undefined),
{} | undefined
]>;
duplicateNativeDashboard(request: protos.google.cloud.chronicle.v1.IDuplicateNativeDashboardRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IDuplicateNativeDashboardRequest | null | undefined, {} | null | undefined>): void;
duplicateNativeDashboard(request: protos.google.cloud.chronicle.v1.IDuplicateNativeDashboardRequest, callback: Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IDuplicateNativeDashboardRequest | null | undefined, {} | null | undefined>): void;
/**
* Delete a dashboard.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The dashboard name to delete.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
* @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/native_dashboard_service.delete_native_dashboard.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_DeleteNativeDashboard_async
*/
deleteNativeDashboard(request?: protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest | undefined),
{} | undefined
]>;
deleteNativeDashboard(request: protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest | null | undefined, {} | null | undefined>): void;
deleteNativeDashboard(request: protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest | null | undefined, {} | null | undefined>): void;
/**
* Add chart in a dashboard.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The dashboard name to add chart in.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
* @param {google.cloud.chronicle.v1.DashboardQuery} [request.dashboardQuery]
* Optional. Query used to create the chart.
* @param {google.cloud.chronicle.v1.DashboardChart} request.dashboardChart
* Required. Chart to be added to the dashboard.
* @param {google.cloud.chronicle.v1.DashboardDefinition.ChartConfig.ChartLayout} request.chartLayout
* Required. ChartLayout for newly added chart.
* @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.cloud.chronicle.v1.AddChartResponse|AddChartResponse}.
* 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/native_dashboard_service.add_chart.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_AddChart_async
*/
addChart(request?: protos.google.cloud.chronicle.v1.IAddChartRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IAddChartResponse,
protos.google.cloud.chronicle.v1.IAddChartRequest | undefined,
{} | undefined
]>;
addChart(request: protos.google.cloud.chronicle.v1.IAddChartRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IAddChartResponse, protos.google.cloud.chronicle.v1.IAddChartRequest | null | undefined, {} | null | undefined>): void;
addChart(request: protos.google.cloud.chronicle.v1.IAddChartRequest, callback: Callback<protos.google.cloud.chronicle.v1.IAddChartResponse, protos.google.cloud.chronicle.v1.IAddChartRequest | null | undefined, {} | null | undefined>): void;
/**
* Remove chart from a dashboard.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The dashboard name to remove chart from.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
* @param {string} request.dashboardChart
* Required. The dashboard chart name to remove.
* @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.cloud.chronicle.v1.NativeDashboard|NativeDashboard}.
* 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/native_dashboard_service.remove_chart.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_RemoveChart_async
*/
removeChart(request?: protos.google.cloud.chronicle.v1.IRemoveChartRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.INativeDashboard,
protos.google.cloud.chronicle.v1.IRemoveChartRequest | undefined,
{} | undefined
]>;
removeChart(request: protos.google.cloud.chronicle.v1.IRemoveChartRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IRemoveChartRequest | null | undefined, {} | null | undefined>): void;
removeChart(request: protos.google.cloud.chronicle.v1.IRemoveChartRequest, callback: Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IRemoveChartRequest | null | undefined, {} | null | undefined>): void;
/**
* Edit chart in a dashboard.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The dashboard name to edit chart in.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
* @param {google.cloud.chronicle.v1.DashboardQuery} [request.dashboardQuery]
* Optional. Query for the edited chart.
* @param {google.cloud.chronicle.v1.DashboardChart} [request.dashboardChart]
* Optional. Edited chart.
* @param {google.protobuf.FieldMask} request.editMask
* Required. The list of fields to edit for chart and query.
* Supported paths in chart are -
* dashboard_chart.display_name
* dashboard_chart.description
* dashboard_chart.chart_datasource.data_sources
* dashboard_chart.visualization
* dashboard_chart.visualization.button
* dashboard_chart.visualization.markdown
* dashboard_chart.drill_down_config
* Supported paths in query are -
* dashboard_query.query
* dashboard_query.input
* @param {number[]} [request.languageFeatures]
* Optional. Language Features present in the query.
* @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.cloud.chronicle.v1.EditChartResponse|EditChartResponse}.
* 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/native_dashboard_service.edit_chart.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_EditChart_async
*/
editChart(request?: protos.google.cloud.chronicle.v1.IEditChartRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IEditChartResponse,
protos.google.cloud.chronicle.v1.IEditChartRequest | undefined,
{} | undefined
]>;
editChart(request: protos.google.cloud.chronicle.v1.IEditChartRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IEditChartResponse, protos.google.cloud.chronicle.v1.IEditChartRequest | null | undefined, {} | null | undefined>): void;
editChart(request: protos.google.cloud.chronicle.v1.IEditChartRequest, callback: Callback<protos.google.cloud.chronicle.v1.IEditChartResponse, protos.google.cloud.chronicle.v1.IEditChartRequest | null | undefined, {} | null | undefined>): void;
/**
* Duplicate chart in a dashboard.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The dashboard name that involves chart duplication.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
* @param {string} request.dashboardChart
* Required. The dashboard chart name to duplicate.
* @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.cloud.chronicle.v1.DuplicateChartResponse|DuplicateChartResponse}.
* 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/native_dashboard_service.duplicate_chart.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_DuplicateChart_async
*/
duplicateChart(request?: protos.google.cloud.chronicle.v1.IDuplicateChartRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDuplicateChartResponse,
protos.google.cloud.chronicle.v1.IDuplicateChartRequest | undefined,
{} | undefined
]>;
duplicateChart(request: protos.google.cloud.chronicle.v1.IDuplicateChartRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDuplicateChartResponse, protos.google.cloud.chronicle.v1.IDuplicateChartRequest | null | undefined, {} | null | undefined>): void;
duplicateChart(request: protos.google.cloud.chronicle.v1.IDuplicateChartRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDuplicateChartResponse, protos.google.cloud.chronicle.v1.IDuplicateChartRequest | null | undefined, {} | null | undefined>): void;
/**
* Exports the dashboards.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource that the dashboards to be exported belong to.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {string[]} request.names
* Required. The resource names of the dashboards to export.
* @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.cloud.chronicle.v1.ExportNativeDashboardsResponse|ExportNativeDashboardsResponse}.
* 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/native_dashboard_service.export_native_dashboards.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_ExportNativeDashboards_async
*/
exportNativeDashboards(request?: protos.google.cloud.chronicle.v1.IExportNativeDashboardsRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IExportNativeDashboardsResponse,
(protos.google.cloud.chronicle.v1.IExportNativeDashboardsRequest | undefined),
{} | undefined
]>;
exportNativeDashboards(request: protos.google.cloud.chronicle.v1.IExportNativeDashboardsRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IExportNativeDashboardsResponse, protos.google.cloud.chronicle.v1.IExportNativeDashboardsRequest | null | undefined, {} | null | undefined>): void;
exportNativeDashboards(request: protos.google.cloud.chronicle.v1.IExportNativeDashboardsRequest, callback: Callback<protos.google.cloud.chronicle.v1.IExportNativeDashboardsResponse, protos.google.cloud.chronicle.v1.IExportNativeDashboardsRequest | null | undefined, {} | null | undefined>): void;
/**
* Imports the dashboards.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this dashboard will be created.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {google.cloud.chronicle.v1.ImportNativeDashboardsInlineSource} request.source
* Required. The data will imported from this proto.
* @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.cloud.chronicle.v1.ImportNativeDashboardsResponse|ImportNativeDashboardsResponse}.
* 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/native_dashboard_service.import_native_dashboards.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_ImportNativeDashboards_async
*/
importNativeDashboards(request?: protos.google.cloud.chronicle.v1.IImportNativeDashboardsRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IImportNativeDashboardsResponse,
(protos.google.cloud.chronicle.v1.IImportNativeDashboardsRequest | undefined),
{} | undefined
]>;
importNativeDashboards(request: protos.google.cloud.chronicle.v1.IImportNativeDashboardsRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IImportNativeDashboardsResponse, protos.google.cloud.chronicle.v1.IImportNativeDashboardsRequest | null | undefined, {} | null | undefined>): void;
importNativeDashboards(request: protos.google.cloud.chronicle.v1.IImportNativeDashboardsRequest, callback: Callback<protos.google.cloud.chronicle.v1.IImportNativeDashboardsResponse, protos.google.cloud.chronicle.v1.IImportNativeDashboardsRequest | null | undefined, {} | null | undefined>): void;
/**
* List all dashboards.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent owning this dashboard collection.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {number} [request.pageSize]
* Optional. The maximum number of dashboards to return. The service may
* return fewer than this value.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDashboards` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListDashboards` must
* match the call that provided the page token.
* @param {google.cloud.chronicle.v1.NativeDashboardView} [request.view]
* Optional. View indicates the scope of fields to populate when returning the
* dashboard resource. If unspecified, defaults to the basic view.
* @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.cloud.chronicle.v1.NativeDashboard|NativeDashboard}.
* 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 `listNativeDashboardsAsync()`
* 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.
*/
listNativeDashboards(request?: protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.INativeDashboard[],
protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest | null,
protos.google.cloud.chronicle.v1.IListNativeDashboardsResponse
]>;
listNativeDashboards(request: protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest, protos.google.cloud.chronicle.v1.IListNativeDashboardsResponse | null | undefined, protos.google.cloud.chronicle.v1.INativeDashboard>): void;
listNativeDashboards(request: protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest, protos.google.cloud.chronicle.v1.IListNativeDashboardsResponse | null | undefined, protos.google.cloud.chronicle.v1.INativeDashboard>): void;
/**
* Equivalent to `listNativeDashboards`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent owning this dashboard collection.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {number} [request.pageSize]
* Optional. The maximum number of dashboards to return. The service may
* return fewer than this value.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDashboards` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListDashboards` must
* match the call that provided the page token.
* @param {google.cloud.chronicle.v1.NativeDashboardView} [request.view]
* Optional. View indicates the scope of fields to populate when returning the
* dashboard resource. If unspecified, defaults to the basic view.
* @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.NativeDashboard|NativeDashboard} 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 `listNativeDashboardsAsync()`
* 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.
*/
listNativeDashboardsStream(request?: protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listNativeDashboards`, 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 owning this dashboard collection.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {number} [request.pageSize]
* Optional. The maximum number of dashboards to return. The service may
* return fewer than this value.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDashboards` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListDashboards` must
* match the call that provided the page token.
* @param {google.cloud.chronicle.v1.NativeDashboardView} [request.view]
* Optional. View indicates the scope of fields to populate when returning the
* dashboard resource. If unspecified, defaults to the basic view.
* @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.NativeDashboard|NativeDashboard}. 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/native_dashboard_service.list_native_dashboards.js</caption>
* region_tag:chronicle_v1_generated_NativeDashboardService_ListNativeDashboards_async
*/
listNativeDashboardsAsync(request?: protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.chronicle.v1.INativeDashboard>;
/**
* Return a fully-qualified bigQueryExport resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @returns {string} Resource name string.
*/
bigQueryExportPath(project: string, location: string, instance: string): string;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string, location: string, instance: string, chart: string): string;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string, location: string, instance: string, query: string): string;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string, location: string, instance: string, dataAccessLabel: string): string;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string, location: string, instance: string, dataAccessScope: string): string;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string, location: string, instance: string, dataTable: string): string;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string, location: string, instance: string, dataTableOperationErrors: string): string;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string): string | number;
/**
* 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: string, location: string, instance: string, dataTable: string, dataTableRow: string): string;
/**
* 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: string): string | number;