Class v1.NativeDashboardServiceClient (0.6.0)

A service providing functionality for managing native dashboards. v1

Package

@google-cloud/chronicle

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of NativeDashboardServiceClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: 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); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

nativeDashboardServiceStub

nativeDashboardServiceStub?: Promise<{
        [name: string]: Function;
    }>;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

addChart(request, options)

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
    ]>;

Add chart in a dashboard.

Parameters
Name Description
request IAddChartRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.IAddChartResponse, protos.google.cloud.chronicle.v1.IAddChartRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing AddChartResponse. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The dashboard name to add chart in.
   *  Format:
   *  projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
   */
  // const name = 'abc123'
  /**
   *  Optional. Query used to create the chart.
   */
  // const dashboardQuery = {}
  /**
   *  Required. Chart to be added to the dashboard.
   */
  // const dashboardChart = {}
  /**
   *  Required. ChartLayout for newly added chart.
   */
  // const chartLayout = {}

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callAddChart() {
    // Construct request
    const request = {
      name,
      dashboardChart,
      chartLayout,
    };

    // Run request
    const response = await chronicleClient.addChart(request);
    console.log(response);
  }

  callAddChart();

addChart(request, options, callback)

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;
Parameters
Name Description
request IAddChartRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IAddChartResponse, protos.google.cloud.chronicle.v1.IAddChartRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

addChart(request, callback)

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;
Parameters
Name Description
request IAddChartRequest
callback Callback<protos.google.cloud.chronicle.v1.IAddChartResponse, protos.google.cloud.chronicle.v1.IAddChartRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

bigQueryExportPath(project, location, instance)

bigQueryExportPath(project: string, location: string, instance: string): string;

Return a fully-qualified bigQueryExport resource name string.

Parameters
Name Description
project string
location string
instance string
Returns
Type Description
string

{string} Resource name string.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createNativeDashboard(request, options)

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
    ]>;

Create a dashboard.

Parameters
Name Description
request ICreateNativeDashboardRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.INativeDashboard, (protos.google.cloud.chronicle.v1.ICreateNativeDashboardRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing NativeDashboard. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource where this dashboard will be created.
   *  Format: projects/{project}/locations/{location}/instances/{instance}
   */
  // const parent = 'abc123'
  /**
   *  Required. The dashboard to create.
   */
  // const nativeDashboard = {}

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callCreateNativeDashboard() {
    // Construct request
    const request = {
      parent,
      nativeDashboard,
    };

    // Run request
    const response = await chronicleClient.createNativeDashboard(request);
    console.log(response);
  }

  callCreateNativeDashboard();

createNativeDashboard(request, options, callback)

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;
Parameters
Name Description
request ICreateNativeDashboardRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.ICreateNativeDashboardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createNativeDashboard(request, callback)

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;
Parameters
Name Description
request ICreateNativeDashboardRequest
callback Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.ICreateNativeDashboardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

dashboardChartPath(project, location, instance, chart)

dashboardChartPath(project: string, location: string, instance: string, chart: string): string;

Return a fully-qualified dashboardChart resource name string.

Parameters
Name Description
project string
location string
instance string
chart string
Returns
Type Description
string

{string} Resource name string.

dashboardQueryPath(project, location, instance, query)

dashboardQueryPath(project: string, location: string, instance: string, query: string): string;

Return a fully-qualified dashboardQuery resource name string.

Parameters
Name Description
project string
location string
instance string
query string
Returns
Type Description
string

{string} Resource name string.

dataAccessLabelPath(project, location, instance, dataAccessLabel)

dataAccessLabelPath(project: string, location: string, instance: string, dataAccessLabel: string): string;

Return a fully-qualified dataAccessLabel resource name string.

Parameters
Name Description
project string
location string
instance string
dataAccessLabel string
Returns
Type Description
string

{string} Resource name string.

dataAccessScopePath(project, location, instance, dataAccessScope)

dataAccessScopePath(project: string, location: string, instance: string, dataAccessScope: string): string;

Return a fully-qualified dataAccessScope resource name string.

Parameters
Name Description
project string
location string
instance string
dataAccessScope string
Returns
Type Description
string

{string} Resource name string.

dataTableOperationErrorsPath(project, location, instance, dataTableOperationErrors)

dataTableOperationErrorsPath(project: string, location: string, instance: string, dataTableOperationErrors: string): string;

Return a fully-qualified dataTableOperationErrors resource name string.

Parameters
Name Description
project string
location string
instance string
dataTableOperationErrors string
Returns
Type Description
string

{string} Resource name string.

dataTablePath(project, location, instance, dataTable)

dataTablePath(project: string, location: string, instance: string, dataTable: string): string;

Return a fully-qualified dataTable resource name string.

Parameters
Name Description
project string
location string
instance string
dataTable string
Returns
Type Description
string

{string} Resource name string.

dataTableRowPath(project, location, instance, dataTable, dataTableRow)

dataTableRowPath(project: string, location: string, instance: string, dataTable: string, dataTableRow: string): string;

Return a fully-qualified dataTableRow resource name string.

Parameters
Name Description
project string
location string
instance string
dataTable string
dataTableRow string
Returns
Type Description
string

{string} Resource name string.

deleteNativeDashboard(request, options)

deleteNativeDashboard(request?: protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest | undefined),
        {} | undefined
    ]>;

Delete a dashboard.

Parameters
Name Description
request IDeleteNativeDashboardRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The dashboard name to delete.
   *  Format:
   *  projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
   */
  // const name = 'abc123'

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callDeleteNativeDashboard() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await chronicleClient.deleteNativeDashboard(request);
    console.log(response);
  }

  callDeleteNativeDashboard();

deleteNativeDashboard(request, options, callback)

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;
Parameters
Name Description
request IDeleteNativeDashboardRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteNativeDashboard(request, callback)

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;
Parameters
Name Description
request IDeleteNativeDashboardRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteNativeDashboardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

duplicateChart(request, options)

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
    ]>;

Duplicate chart in a dashboard.

Parameters
Name Description
request IDuplicateChartRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.IDuplicateChartResponse, protos.google.cloud.chronicle.v1.IDuplicateChartRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DuplicateChartResponse. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The dashboard name that involves chart duplication.
   *  Format:
   *  projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
   */
  // const name = 'abc123'
  /**
   *  Required. The dashboard chart name to duplicate.
   */
  // const dashboardChart = 'abc123'

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callDuplicateChart() {
    // Construct request
    const request = {
      name,
      dashboardChart,
    };

    // Run request
    const response = await chronicleClient.duplicateChart(request);
    console.log(response);
  }

  callDuplicateChart();

duplicateChart(request, options, callback)

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;
Parameters
Name Description
request IDuplicateChartRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IDuplicateChartResponse, protos.google.cloud.chronicle.v1.IDuplicateChartRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

duplicateChart(request, callback)

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;
Parameters
Name Description
request IDuplicateChartRequest
callback Callback<protos.google.cloud.chronicle.v1.IDuplicateChartResponse, protos.google.cloud.chronicle.v1.IDuplicateChartRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

duplicateNativeDashboard(request, options)

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
    ]>;

Duplicate a dashboard.

Parameters
Name Description
request IDuplicateNativeDashboardRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.INativeDashboard, (protos.google.cloud.chronicle.v1.IDuplicateNativeDashboardRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing NativeDashboard. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The dashboard name to duplicate.
   *  Format:
   *  projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
   */
  // const name = 'abc123'
  /**
   *  Required. Any fields that need modification can be passed through this like
   *  name, description etc.
   */
  // const nativeDashboard = {}

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callDuplicateNativeDashboard() {
    // Construct request
    const request = {
      name,
      nativeDashboard,
    };

    // Run request
    const response = await chronicleClient.duplicateNativeDashboard(request);
    console.log(response);
  }

  callDuplicateNativeDashboard();

duplicateNativeDashboard(request, options, callback)

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;
Parameters
Name Description
request IDuplicateNativeDashboardRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IDuplicateNativeDashboardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

duplicateNativeDashboard(request, callback)

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;
Parameters
Name Description
request IDuplicateNativeDashboardRequest
callback Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IDuplicateNativeDashboardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

editChart(request, options)

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
    ]>;

Edit chart in a dashboard.

Parameters
Name Description
request IEditChartRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.IEditChartResponse, protos.google.cloud.chronicle.v1.IEditChartRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing EditChartResponse. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The dashboard name to edit chart in.
   *  Format:
   *  projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
   */
  // const name = 'abc123'
  /**
   *  Optional. Query for the edited chart.
   */
  // const dashboardQuery = {}
  /**
   *  Optional. Edited chart.
   */
  // const dashboardChart = {}
  /**
   *  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
   */
  // const editMask = {}
  /**
   *  Optional. Language Features present in the query.
   */
  // const languageFeatures = [1,2,3,4]

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callEditChart() {
    // Construct request
    const request = {
      name,
      editMask,
    };

    // Run request
    const response = await chronicleClient.editChart(request);
    console.log(response);
  }

  callEditChart();

editChart(request, options, callback)

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;
Parameters
Name Description
request IEditChartRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IEditChartResponse, protos.google.cloud.chronicle.v1.IEditChartRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

editChart(request, callback)

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;
Parameters
Name Description
request IEditChartRequest
callback Callback<protos.google.cloud.chronicle.v1.IEditChartResponse, protos.google.cloud.chronicle.v1.IEditChartRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportNativeDashboards(request, options)

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
    ]>;

Exports the dashboards.

Parameters
Name Description
request IExportNativeDashboardsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.IExportNativeDashboardsResponse, (protos.google.cloud.chronicle.v1.IExportNativeDashboardsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ExportNativeDashboardsResponse. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource that the dashboards to be exported belong to.
   *  Format: projects/{project}/locations/{location}/instances/{instance}
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource names of the dashboards to export.
   */
  // const names = ['abc','def']

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callExportNativeDashboards() {
    // Construct request
    const request = {
      parent,
      names,
    };

    // Run request
    const response = await chronicleClient.exportNativeDashboards(request);
    console.log(response);
  }

  callExportNativeDashboards();

exportNativeDashboards(request, options, callback)

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;
Parameters
Name Description
request IExportNativeDashboardsRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IExportNativeDashboardsResponse, protos.google.cloud.chronicle.v1.IExportNativeDashboardsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportNativeDashboards(request, callback)

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;
Parameters
Name Description
request IExportNativeDashboardsRequest
callback Callback<protos.google.cloud.chronicle.v1.IExportNativeDashboardsResponse, protos.google.cloud.chronicle.v1.IExportNativeDashboardsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

featuredContentNativeDashboardPath(project, location, instance, featuredContentNativeDashboard)

featuredContentNativeDashboardPath(project: string, location: string, instance: string, featuredContentNativeDashboard: string): string;

Return a fully-qualified featuredContentNativeDashboard resource name string.

Parameters
Name Description
project string
location string
instance string
featuredContentNativeDashboard string
Returns
Type Description
string

{string} Resource name string.

findingsRefinementDeploymentPath(project, location, instance, findingsRefinement)

findingsRefinementDeploymentPath(project: string, location: string, instance: string, findingsRefinement: string): string;

Return a fully-qualified findingsRefinementDeployment resource name string.

Parameters
Name Description
project string
location string
instance string
findingsRefinement string
Returns
Type Description
string

{string} Resource name string.

findingsRefinementPath(project, location, instance, findingsRefinement)

findingsRefinementPath(project: string, location: string, instance: string, findingsRefinement: string): string;

Return a fully-qualified findingsRefinement resource name string.

Parameters
Name Description
project string
location string
instance string
findingsRefinement string
Returns
Type Description
string

{string} Resource name string.

getNativeDashboard(request, options)

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
    ]>;

Get a dashboard.

Parameters
Name Description
request IGetNativeDashboardRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IGetNativeDashboardRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing NativeDashboard. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The dashboard name to fetch.
   *  Format:
   *  projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
   */
  // const name = 'abc123'
  /**
   *  Optional. View indicates the scope of fields to populate when returning the
   *  dashboard resource. If unspecified, defaults to the basic view.
   */
  // const view = {}

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callGetNativeDashboard() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await chronicleClient.getNativeDashboard(request);
    console.log(response);
  }

  callGetNativeDashboard();

getNativeDashboard(request, options, callback)

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;
Parameters
Name Description
request IGetNativeDashboardRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IGetNativeDashboardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getNativeDashboard(request, callback)

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;
Parameters
Name Description
request IGetNativeDashboardRequest
callback Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IGetNativeDashboardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

importNativeDashboards(request, options)

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
    ]>;

Imports the dashboards.

Parameters
Name Description
request IImportNativeDashboardsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.IImportNativeDashboardsResponse, (protos.google.cloud.chronicle.v1.IImportNativeDashboardsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ImportNativeDashboardsResponse. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource where this dashboard will be created.
   *  Format: projects/{project}/locations/{location}/instances/{instance}
   */
  // const parent = 'abc123'
  /**
   *  Required. The data will imported from this proto.
   */
  // const source = {}

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callImportNativeDashboards() {
    // Construct request
    const request = {
      parent,
      source,
    };

    // Run request
    const response = await chronicleClient.importNativeDashboards(request);
    console.log(response);
  }

  callImportNativeDashboards();

importNativeDashboards(request, options, callback)

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;
Parameters
Name Description
request IImportNativeDashboardsRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IImportNativeDashboardsResponse, protos.google.cloud.chronicle.v1.IImportNativeDashboardsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

importNativeDashboards(request, callback)

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;
Parameters
Name Description
request IImportNativeDashboardsRequest
callback Callback<protos.google.cloud.chronicle.v1.IImportNativeDashboardsResponse, protos.google.cloud.chronicle.v1.IImportNativeDashboardsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

instancePath(project, location, instance)

instancePath(project: string, location: string, instance: string): string;

Return a fully-qualified instance resource name string.

Parameters
Name Description
project string
location string
instance string
Returns
Type Description
string

{string} Resource name string.

listNativeDashboards(request, options)

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
    ]>;

List all dashboards.

Parameters
Name Description
request IListNativeDashboardsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.INativeDashboard[], protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest | null, protos.google.cloud.chronicle.v1.IListNativeDashboardsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of 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 documentation for more details and examples.

listNativeDashboards(request, options, callback)

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;
Parameters
Name Description
request 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>
Returns
Type Description
void

listNativeDashboards(request, callback)

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;
Parameters
Name Description
request IListNativeDashboardsRequest
callback PaginationCallback<protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest, protos.google.cloud.chronicle.v1.IListNativeDashboardsResponse | null | undefined, protos.google.cloud.chronicle.v1.INativeDashboard>
Returns
Type Description
void

listNativeDashboardsAsync(request, options)

listNativeDashboardsAsync(request?: protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.chronicle.v1.INativeDashboard>;

Equivalent to listNativeDashboards, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListNativeDashboardsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.chronicle.v1.INativeDashboard>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing 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 documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent owning this dashboard collection.
   *  Format: projects/{project}/locations/{location}/instances/{instance}
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of dashboards to return. The service may
   *  return fewer than this value.
   */
  // const pageSize = 1234
  /**
   *  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.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. View indicates the scope of fields to populate when returning the
   *  dashboard resource. If unspecified, defaults to the basic view.
   */
  // const view = {}

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callListNativeDashboards() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = chronicleClient.listNativeDashboardsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListNativeDashboards();

listNativeDashboardsStream(request, options)

listNativeDashboardsStream(request?: protos.google.cloud.chronicle.v1.IListNativeDashboardsRequest, options?: CallOptions): Transform;

Equivalent to listNativeDashboards, but returns a NodeJS Stream object.

Parameters
Name Description
request IListNativeDashboardsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing 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 documentation for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchChartFromDashboardChartName(dashboardChartName)

matchChartFromDashboardChartName(dashboardChartName: string): string | number;

Parse the chart from DashboardChart resource.

Parameter
Name Description
dashboardChartName string

A fully-qualified path representing DashboardChart resource.
Returns
Type Description
string | number

{string} A string representing the chart.

matchDashboardFromNativeDashboardName(nativeDashboardName)

matchDashboardFromNativeDashboardName(nativeDashboardName: string): string | number;

Parse the dashboard from NativeDashboard resource.

Parameter
Name Description
nativeDashboardName string

A fully-qualified path representing NativeDashboard resource.
Returns
Type Description
string | number

{string} A string representing the dashboard.

matchDataAccessLabelFromDataAccessLabelName(dataAccessLabelName)

matchDataAccessLabelFromDataAccessLabelName(dataAccessLabelName: string): string | number;

Parse the data_access_label from DataAccessLabel resource.

Parameter
Name Description
dataAccessLabelName string

A fully-qualified path representing DataAccessLabel resource.
Returns
Type Description
string | number

{string} A string representing the data_access_label.

matchDataAccessScopeFromDataAccessScopeName(dataAccessScopeName)

matchDataAccessScopeFromDataAccessScopeName(dataAccessScopeName: string): string | number;

Parse the data_access_scope from DataAccessScope resource.

Parameter
Name Description
dataAccessScopeName string

A fully-qualified path representing DataAccessScope resource.
Returns
Type Description
string | number

{string} A string representing the data_access_scope.

matchDataTableFromDataTableName(dataTableName)

matchDataTableFromDataTableName(dataTableName: string): string | number;

Parse the data_table from DataTable resource.

Parameter
Name Description
dataTableName string

A fully-qualified path representing DataTable resource.
Returns
Type Description
string | number

{string} A string representing the data_table.

matchDataTableFromDataTableRowName(dataTableRowName)

matchDataTableFromDataTableRowName(dataTableRowName: string): string | number;

Parse the data_table from DataTableRow resource.

Parameter
Name Description
dataTableRowName string

A fully-qualified path representing DataTableRow resource.
Returns
Type Description
string | number

{string} A string representing the data_table.

matchDataTableOperationErrorsFromDataTableOperationErrorsName(dataTableOperationErrorsName)

matchDataTableOperationErrorsFromDataTableOperationErrorsName(dataTableOperationErrorsName: string): string | number;

Parse the data_table_operation_errors from DataTableOperationErrors resource.

Parameter
Name Description
dataTableOperationErrorsName string

A fully-qualified path representing DataTableOperationErrors resource.
Returns
Type Description
string | number

{string} A string representing the data_table_operation_errors.

matchDataTableRowFromDataTableRowName(dataTableRowName)

matchDataTableRowFromDataTableRowName(dataTableRowName: string): string | number;

Parse the data_table_row from DataTableRow resource.

Parameter
Name Description
dataTableRowName string

A fully-qualified path representing DataTableRow resource.
Returns
Type Description
string | number

{string} A string representing the data_table_row.

matchFeaturedContentNativeDashboardFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName)

matchFeaturedContentNativeDashboardFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName: string): string | number;

Parse the featured_content_native_dashboard from FeaturedContentNativeDashboard resource.

Parameter
Name Description
featuredContentNativeDashboardName string

A fully-qualified path representing FeaturedContentNativeDashboard resource.
Returns
Type Description
string | number

{string} A string representing the featured_content_native_dashboard.

matchFindingsRefinementFromFindingsRefinementDeploymentName(findingsRefinementDeploymentName)

matchFindingsRefinementFromFindingsRefinementDeploymentName(findingsRefinementDeploymentName: string): string | number;

Parse the findings_refinement from FindingsRefinementDeployment resource.

Parameter
Name Description
findingsRefinementDeploymentName string

A fully-qualified path representing FindingsRefinementDeployment resource.
Returns
Type Description
string | number

{string} A string representing the findings_refinement.

matchFindingsRefinementFromFindingsRefinementName(findingsRefinementName)

matchFindingsRefinementFromFindingsRefinementName(findingsRefinementName: string): string | number;

Parse the findings_refinement from FindingsRefinement resource.

Parameter
Name Description
findingsRefinementName string

A fully-qualified path representing FindingsRefinement resource.
Returns
Type Description
string | number

{string} A string representing the findings_refinement.

matchInstanceFromBigQueryExportName(bigQueryExportName)

matchInstanceFromBigQueryExportName(bigQueryExportName: string): string | number;

Parse the instance from BigQueryExport resource.

Parameter
Name Description
bigQueryExportName string

A fully-qualified path representing BigQueryExport resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromDashboardChartName(dashboardChartName)

matchInstanceFromDashboardChartName(dashboardChartName: string): string | number;

Parse the instance from DashboardChart resource.

Parameter
Name Description
dashboardChartName string

A fully-qualified path representing DashboardChart resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromDashboardQueryName(dashboardQueryName)

matchInstanceFromDashboardQueryName(dashboardQueryName: string): string | number;

Parse the instance from DashboardQuery resource.

Parameter
Name Description
dashboardQueryName string

A fully-qualified path representing DashboardQuery resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromDataAccessLabelName(dataAccessLabelName)

matchInstanceFromDataAccessLabelName(dataAccessLabelName: string): string | number;

Parse the instance from DataAccessLabel resource.

Parameter
Name Description
dataAccessLabelName string

A fully-qualified path representing DataAccessLabel resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromDataAccessScopeName(dataAccessScopeName)

matchInstanceFromDataAccessScopeName(dataAccessScopeName: string): string | number;

Parse the instance from DataAccessScope resource.

Parameter
Name Description
dataAccessScopeName string

A fully-qualified path representing DataAccessScope resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromDataTableName(dataTableName)

matchInstanceFromDataTableName(dataTableName: string): string | number;

Parse the instance from DataTable resource.

Parameter
Name Description
dataTableName string

A fully-qualified path representing DataTable resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromDataTableOperationErrorsName(dataTableOperationErrorsName)

matchInstanceFromDataTableOperationErrorsName(dataTableOperationErrorsName: string): string | number;

Parse the instance from DataTableOperationErrors resource.

Parameter
Name Description
dataTableOperationErrorsName string

A fully-qualified path representing DataTableOperationErrors resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromDataTableRowName(dataTableRowName)

matchInstanceFromDataTableRowName(dataTableRowName: string): string | number;

Parse the instance from DataTableRow resource.

Parameter
Name Description
dataTableRowName string

A fully-qualified path representing DataTableRow resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName)

matchInstanceFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName: string): string | number;

Parse the instance from FeaturedContentNativeDashboard resource.

Parameter
Name Description
featuredContentNativeDashboardName string

A fully-qualified path representing FeaturedContentNativeDashboard resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromFindingsRefinementDeploymentName(findingsRefinementDeploymentName)

matchInstanceFromFindingsRefinementDeploymentName(findingsRefinementDeploymentName: string): string | number;

Parse the instance from FindingsRefinementDeployment resource.

Parameter
Name Description
findingsRefinementDeploymentName string

A fully-qualified path representing FindingsRefinementDeployment resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromFindingsRefinementName(findingsRefinementName)

matchInstanceFromFindingsRefinementName(findingsRefinementName: string): string | number;

Parse the instance from FindingsRefinement resource.

Parameter
Name Description
findingsRefinementName string

A fully-qualified path representing FindingsRefinement resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

Parse the instance from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromNativeDashboardName(nativeDashboardName)

matchInstanceFromNativeDashboardName(nativeDashboardName: string): string | number;

Parse the instance from NativeDashboard resource.

Parameter
Name Description
nativeDashboardName string

A fully-qualified path representing NativeDashboard resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromReferenceListName(referenceListName)

matchInstanceFromReferenceListName(referenceListName: string): string | number;

Parse the instance from ReferenceList resource.

Parameter
Name Description
referenceListName string

A fully-qualified path representing ReferenceList resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromRetrohuntName(retrohuntName)

matchInstanceFromRetrohuntName(retrohuntName: string): string | number;

Parse the instance from Retrohunt resource.

Parameter
Name Description
retrohuntName string

A fully-qualified path representing Retrohunt resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromRuleDeploymentName(ruleDeploymentName)

matchInstanceFromRuleDeploymentName(ruleDeploymentName: string): string | number;

Parse the instance from RuleDeployment resource.

Parameter
Name Description
ruleDeploymentName string

A fully-qualified path representing RuleDeployment resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromRuleExecutionErrorName(ruleExecutionErrorName)

matchInstanceFromRuleExecutionErrorName(ruleExecutionErrorName: string): string | number;

Parse the instance from RuleExecutionError resource.

Parameter
Name Description
ruleExecutionErrorName string

A fully-qualified path representing RuleExecutionError resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromRuleName(ruleName)

matchInstanceFromRuleName(ruleName: string): string | number;

Parse the instance from Rule resource.

Parameter
Name Description
ruleName string

A fully-qualified path representing Rule resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromWatchlistName(watchlistName)

matchInstanceFromWatchlistName(watchlistName: string): string | number;

Parse the instance from Watchlist resource.

Parameter
Name Description
watchlistName string

A fully-qualified path representing Watchlist resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchLocationFromBigQueryExportName(bigQueryExportName)

matchLocationFromBigQueryExportName(bigQueryExportName: string): string | number;

Parse the location from BigQueryExport resource.

Parameter
Name Description
bigQueryExportName string

A fully-qualified path representing BigQueryExport resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDashboardChartName(dashboardChartName)

matchLocationFromDashboardChartName(dashboardChartName: string): string | number;

Parse the location from DashboardChart resource.

Parameter
Name Description
dashboardChartName string

A fully-qualified path representing DashboardChart resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDashboardQueryName(dashboardQueryName)

matchLocationFromDashboardQueryName(dashboardQueryName: string): string | number;

Parse the location from DashboardQuery resource.

Parameter
Name Description
dashboardQueryName string

A fully-qualified path representing DashboardQuery resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDataAccessLabelName(dataAccessLabelName)

matchLocationFromDataAccessLabelName(dataAccessLabelName: string): string | number;

Parse the location from DataAccessLabel resource.

Parameter
Name Description
dataAccessLabelName string

A fully-qualified path representing DataAccessLabel resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDataAccessScopeName(dataAccessScopeName)

matchLocationFromDataAccessScopeName(dataAccessScopeName: string): string | number;

Parse the location from DataAccessScope resource.

Parameter
Name Description
dataAccessScopeName string

A fully-qualified path representing DataAccessScope resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDataTableName(dataTableName)

matchLocationFromDataTableName(dataTableName: string): string | number;

Parse the location from DataTable resource.

Parameter
Name Description
dataTableName string

A fully-qualified path representing DataTable resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDataTableOperationErrorsName(dataTableOperationErrorsName)

matchLocationFromDataTableOperationErrorsName(dataTableOperationErrorsName: string): string | number;

Parse the location from DataTableOperationErrors resource.

Parameter
Name Description
dataTableOperationErrorsName string

A fully-qualified path representing DataTableOperationErrors resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDataTableRowName(dataTableRowName)

matchLocationFromDataTableRowName(dataTableRowName: string): string | number;

Parse the location from DataTableRow resource.

Parameter
Name Description
dataTableRowName string

A fully-qualified path representing DataTableRow resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName)

matchLocationFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName: string): string | number;

Parse the location from FeaturedContentNativeDashboard resource.

Parameter
Name Description
featuredContentNativeDashboardName string

A fully-qualified path representing FeaturedContentNativeDashboard resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFindingsRefinementDeploymentName(findingsRefinementDeploymentName)

matchLocationFromFindingsRefinementDeploymentName(findingsRefinementDeploymentName: string): string | number;

Parse the location from FindingsRefinementDeployment resource.

Parameter
Name Description
findingsRefinementDeploymentName string

A fully-qualified path representing FindingsRefinementDeployment resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFindingsRefinementName(findingsRefinementName)

matchLocationFromFindingsRefinementName(findingsRefinementName: string): string | number;

Parse the location from FindingsRefinement resource.

Parameter
Name Description
findingsRefinementName string

A fully-qualified path representing FindingsRefinement resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromInstanceName(instanceName)

matchLocationFromInstanceName(instanceName: string): string | number;

Parse the location from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromNativeDashboardName(nativeDashboardName)

matchLocationFromNativeDashboardName(nativeDashboardName: string): string | number;

Parse the location from NativeDashboard resource.

Parameter
Name Description
nativeDashboardName string

A fully-qualified path representing NativeDashboard resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromReferenceListName(referenceListName)

matchLocationFromReferenceListName(referenceListName: string): string | number;

Parse the location from ReferenceList resource.

Parameter
Name Description
referenceListName string

A fully-qualified path representing ReferenceList resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromRetrohuntName(retrohuntName)

matchLocationFromRetrohuntName(retrohuntName: string): string | number;

Parse the location from Retrohunt resource.

Parameter
Name Description
retrohuntName string

A fully-qualified path representing Retrohunt resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromRuleDeploymentName(ruleDeploymentName)

matchLocationFromRuleDeploymentName(ruleDeploymentName: string): string | number;

Parse the location from RuleDeployment resource.

Parameter
Name Description
ruleDeploymentName string

A fully-qualified path representing RuleDeployment resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromRuleExecutionErrorName(ruleExecutionErrorName)

matchLocationFromRuleExecutionErrorName(ruleExecutionErrorName: string): string | number;

Parse the location from RuleExecutionError resource.

Parameter
Name Description
ruleExecutionErrorName string

A fully-qualified path representing RuleExecutionError resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromRuleName(ruleName)

matchLocationFromRuleName(ruleName: string): string | number;

Parse the location from Rule resource.

Parameter
Name Description
ruleName string

A fully-qualified path representing Rule resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromWatchlistName(watchlistName)

matchLocationFromWatchlistName(watchlistName: string): string | number;

Parse the location from Watchlist resource.

Parameter
Name Description
watchlistName string

A fully-qualified path representing Watchlist resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchProjectFromBigQueryExportName(bigQueryExportName)

matchProjectFromBigQueryExportName(bigQueryExportName: string): string | number;

Parse the project from BigQueryExport resource.

Parameter
Name Description
bigQueryExportName string

A fully-qualified path representing BigQueryExport resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDashboardChartName(dashboardChartName)

matchProjectFromDashboardChartName(dashboardChartName: string): string | number;

Parse the project from DashboardChart resource.

Parameter
Name Description
dashboardChartName string

A fully-qualified path representing DashboardChart resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDashboardQueryName(dashboardQueryName)

matchProjectFromDashboardQueryName(dashboardQueryName: string): string | number;

Parse the project from DashboardQuery resource.

Parameter
Name Description
dashboardQueryName string

A fully-qualified path representing DashboardQuery resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDataAccessLabelName(dataAccessLabelName)

matchProjectFromDataAccessLabelName(dataAccessLabelName: string): string | number;

Parse the project from DataAccessLabel resource.

Parameter
Name Description
dataAccessLabelName string

A fully-qualified path representing DataAccessLabel resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDataAccessScopeName(dataAccessScopeName)

matchProjectFromDataAccessScopeName(dataAccessScopeName: string): string | number;

Parse the project from DataAccessScope resource.

Parameter
Name Description
dataAccessScopeName string

A fully-qualified path representing DataAccessScope resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDataTableName(dataTableName)

matchProjectFromDataTableName(dataTableName: string): string | number;

Parse the project from DataTable resource.

Parameter
Name Description
dataTableName string

A fully-qualified path representing DataTable resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDataTableOperationErrorsName(dataTableOperationErrorsName)

matchProjectFromDataTableOperationErrorsName(dataTableOperationErrorsName: string): string | number;

Parse the project from DataTableOperationErrors resource.

Parameter
Name Description
dataTableOperationErrorsName string

A fully-qualified path representing DataTableOperationErrors resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDataTableRowName(dataTableRowName)

matchProjectFromDataTableRowName(dataTableRowName: string): string | number;

Parse the project from DataTableRow resource.

Parameter
Name Description
dataTableRowName string

A fully-qualified path representing DataTableRow resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName)

matchProjectFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName: string): string | number;

Parse the project from FeaturedContentNativeDashboard resource.

Parameter
Name Description
featuredContentNativeDashboardName string

A fully-qualified path representing FeaturedContentNativeDashboard resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromFindingsRefinementDeploymentName(findingsRefinementDeploymentName)

matchProjectFromFindingsRefinementDeploymentName(findingsRefinementDeploymentName: string): string | number;

Parse the project from FindingsRefinementDeployment resource.

Parameter
Name Description
findingsRefinementDeploymentName string

A fully-qualified path representing FindingsRefinementDeployment resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromFindingsRefinementName(findingsRefinementName)

matchProjectFromFindingsRefinementName(findingsRefinementName: string): string | number;

Parse the project from FindingsRefinement resource.

Parameter
Name Description
findingsRefinementName string

A fully-qualified path representing FindingsRefinement resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromInstanceName(instanceName)

matchProjectFromInstanceName(instanceName: string): string | number;

Parse the project from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromNativeDashboardName(nativeDashboardName)

matchProjectFromNativeDashboardName(nativeDashboardName: string): string | number;

Parse the project from NativeDashboard resource.

Parameter
Name Description
nativeDashboardName string

A fully-qualified path representing NativeDashboard resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromReferenceListName(referenceListName)

matchProjectFromReferenceListName(referenceListName: string): string | number;

Parse the project from ReferenceList resource.

Parameter
Name Description
referenceListName string

A fully-qualified path representing ReferenceList resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromRetrohuntName(retrohuntName)

matchProjectFromRetrohuntName(retrohuntName: string): string | number;

Parse the project from Retrohunt resource.

Parameter
Name Description
retrohuntName string

A fully-qualified path representing Retrohunt resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromRuleDeploymentName(ruleDeploymentName)

matchProjectFromRuleDeploymentName(ruleDeploymentName: string): string | number;

Parse the project from RuleDeployment resource.

Parameter
Name Description
ruleDeploymentName string

A fully-qualified path representing RuleDeployment resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromRuleExecutionErrorName(ruleExecutionErrorName)

matchProjectFromRuleExecutionErrorName(ruleExecutionErrorName: string): string | number;

Parse the project from RuleExecutionError resource.

Parameter
Name Description
ruleExecutionErrorName string

A fully-qualified path representing RuleExecutionError resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromRuleName(ruleName)

matchProjectFromRuleName(ruleName: string): string | number;

Parse the project from Rule resource.

Parameter
Name Description
ruleName string

A fully-qualified path representing Rule resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromWatchlistName(watchlistName)

matchProjectFromWatchlistName(watchlistName: string): string | number;

Parse the project from Watchlist resource.

Parameter
Name Description
watchlistName string

A fully-qualified path representing Watchlist resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchQueryFromDashboardQueryName(dashboardQueryName)

matchQueryFromDashboardQueryName(dashboardQueryName: string): string | number;

Parse the query from DashboardQuery resource.

Parameter
Name Description
dashboardQueryName string

A fully-qualified path representing DashboardQuery resource.
Returns
Type Description
string | number

{string} A string representing the query.

matchReferenceListFromReferenceListName(referenceListName)

matchReferenceListFromReferenceListName(referenceListName: string): string | number;

Parse the reference_list from ReferenceList resource.

Parameter
Name Description
referenceListName string

A fully-qualified path representing ReferenceList resource.
Returns
Type Description
string | number

{string} A string representing the reference_list.

matchRetrohuntFromRetrohuntName(retrohuntName)

matchRetrohuntFromRetrohuntName(retrohuntName: string): string | number;

Parse the retrohunt from Retrohunt resource.

Parameter
Name Description
retrohuntName string

A fully-qualified path representing Retrohunt resource.
Returns
Type Description
string | number

{string} A string representing the retrohunt.

matchRuleExecutionErrorFromRuleExecutionErrorName(ruleExecutionErrorName)

matchRuleExecutionErrorFromRuleExecutionErrorName(ruleExecutionErrorName: string): string | number;

Parse the rule_execution_error from RuleExecutionError resource.

Parameter
Name Description
ruleExecutionErrorName string

A fully-qualified path representing RuleExecutionError resource.
Returns
Type Description
string | number

{string} A string representing the rule_execution_error.

matchRuleFromRetrohuntName(retrohuntName)

matchRuleFromRetrohuntName(retrohuntName: string): string | number;

Parse the rule from Retrohunt resource.

Parameter
Name Description
retrohuntName string

A fully-qualified path representing Retrohunt resource.
Returns
Type Description
string | number

{string} A string representing the rule.

matchRuleFromRuleDeploymentName(ruleDeploymentName)

matchRuleFromRuleDeploymentName(ruleDeploymentName: string): string | number;

Parse the rule from RuleDeployment resource.

Parameter
Name Description
ruleDeploymentName string

A fully-qualified path representing RuleDeployment resource.
Returns
Type Description
string | number

{string} A string representing the rule.

matchRuleFromRuleName(ruleName)

matchRuleFromRuleName(ruleName: string): string | number;

Parse the rule from Rule resource.

Parameter
Name Description
ruleName string

A fully-qualified path representing Rule resource.
Returns
Type Description
string | number

{string} A string representing the rule.

matchWatchlistFromWatchlistName(watchlistName)

matchWatchlistFromWatchlistName(watchlistName: string): string | number;

Parse the watchlist from Watchlist resource.

Parameter
Name Description
watchlistName string

A fully-qualified path representing Watchlist resource.
Returns
Type Description
string | number

{string} A string representing the watchlist.

nativeDashboardPath(project, location, instance, dashboard)

nativeDashboardPath(project: string, location: string, instance: string, dashboard: string): string;

Return a fully-qualified nativeDashboard resource name string.

Parameters
Name Description
project string
location string
instance string
dashboard string
Returns
Type Description
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

referenceListPath(project, location, instance, referenceList)

referenceListPath(project: string, location: string, instance: string, referenceList: string): string;

Return a fully-qualified referenceList resource name string.

Parameters
Name Description
project string
location string
instance string
referenceList string
Returns
Type Description
string

{string} Resource name string.

removeChart(request, options)

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
    ]>;

Remove chart from a dashboard.

Parameters
Name Description
request IRemoveChartRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IRemoveChartRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing NativeDashboard. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The dashboard name to remove chart from.
   *  Format:
   *  projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
   */
  // const name = 'abc123'
  /**
   *  Required. The dashboard chart name to remove.
   */
  // const dashboardChart = 'abc123'

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callRemoveChart() {
    // Construct request
    const request = {
      name,
      dashboardChart,
    };

    // Run request
    const response = await chronicleClient.removeChart(request);
    console.log(response);
  }

  callRemoveChart();

removeChart(request, options, callback)

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;
Parameters
Name Description
request IRemoveChartRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IRemoveChartRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

removeChart(request, callback)

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;
Parameters
Name Description
request IRemoveChartRequest
callback Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IRemoveChartRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

retrohuntPath(project, location, instance, rule, retrohunt)

retrohuntPath(project: string, location: string, instance: string, rule: string, retrohunt: string): string;

Return a fully-qualified retrohunt resource name string.

Parameters
Name Description
project string
location string
instance string
rule string
retrohunt string
Returns
Type Description
string

{string} Resource name string.

ruleDeploymentPath(project, location, instance, rule)

ruleDeploymentPath(project: string, location: string, instance: string, rule: string): string;

Return a fully-qualified ruleDeployment resource name string.

Parameters
Name Description
project string
location string
instance string
rule string
Returns
Type Description
string

{string} Resource name string.

ruleExecutionErrorPath(project, location, instance, ruleExecutionError)

ruleExecutionErrorPath(project: string, location: string, instance: string, ruleExecutionError: string): string;

Return a fully-qualified ruleExecutionError resource name string.

Parameters
Name Description
project string
location string
instance string
ruleExecutionError string
Returns
Type Description
string

{string} Resource name string.

rulePath(project, location, instance, rule)

rulePath(project: string, location: string, instance: string, rule: string): string;

Return a fully-qualified rule resource name string.

Parameters
Name Description
project string
location string
instance string
rule string
Returns
Type Description
string

{string} Resource name string.

updateNativeDashboard(request, options)

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
    ]>;

Update a dashboard.

Parameters
Name Description
request IUpdateNativeDashboardRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.chronicle.v1.INativeDashboard, (protos.google.cloud.chronicle.v1.IUpdateNativeDashboardRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing NativeDashboard. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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}
   */
  // const nativeDashboard = {}
  /**
   *  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
   */
  // const updateMask = {}

  // Imports the Chronicle library
  const {NativeDashboardServiceClient} = require('@google-cloud/chronicle').v1;

  // Instantiates a client
  const chronicleClient = new NativeDashboardServiceClient();

  async function callUpdateNativeDashboard() {
    // Construct request
    const request = {
      nativeDashboard,
      updateMask,
    };

    // Run request
    const response = await chronicleClient.updateNativeDashboard(request);
    console.log(response);
  }

  callUpdateNativeDashboard();

updateNativeDashboard(request, options, callback)

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;
Parameters
Name Description
request IUpdateNativeDashboardRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IUpdateNativeDashboardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateNativeDashboard(request, callback)

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;
Parameters
Name Description
request IUpdateNativeDashboardRequest
callback Callback<protos.google.cloud.chronicle.v1.INativeDashboard, protos.google.cloud.chronicle.v1.IUpdateNativeDashboardRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

watchlistPath(project, location, instance, watchlist)

watchlistPath(project: string, location: string, instance: string, watchlist: string): string;

Return a fully-qualified watchlist resource name string.

Parameters
Name Description
project string
location string
instance string
watchlist string
Returns
Type Description
string

{string} Resource name string.