Class v1.DataAccessControlServiceClient (0.10.1)

DataAccessControlService exposes resources and endpoints related to data access control. v1

Package

@google-cloud/chronicle

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of DataAccessControlServiceClient.

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 DataAccessControlServiceClient({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;

dataAccessControlServiceStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [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

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.

createDataAccessLabel(request, options)

createDataAccessLabel(request?: protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IDataAccessLabel,
        (protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest | undefined),
        {} | undefined
    ]>;

Creates a data access label. Data access labels are applied to incoming event data and selected in data access scopes (another resource), and only users with scopes containing the label can see data with that label. Currently, the data access label resource only includes custom labels, which are labels that correspond to UDM queries over event data.

Parameters
Name Description
request ICreateDataAccessLabelRequest

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.IDataAccessLabel, (protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DataAccessLabel. 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 Data Access Label will be created.
   *  Format: `projects/{project}/locations/{location}/instances/{instance}`
   */
  // const parent = 'abc123'
  /**
   *  Required. Data access label to create.
   */
  // const dataAccessLabel = {}
  /**
   *  Required. The ID to use for the data access label, which will become the
   *  label's display name and the final component of the label's resource name.
   *  The maximum number of characters should be 63. Regex pattern is as per AIP:
   *  https://google.aip.dev/122#resource-id-segments
   */
  // const dataAccessLabelId = 'abc123'

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

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

  async function callCreateDataAccessLabel() {
    // Construct request
    const request = {
      parent,
      dataAccessLabel,
      dataAccessLabelId,
    };

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

  callCreateDataAccessLabel();

createDataAccessLabel(request, options, callback)

createDataAccessLabel(request: protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDataAccessLabelRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDataAccessLabel(request, callback)

createDataAccessLabel(request: protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDataAccessLabelRequest
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDataAccessScope(request, options)

createDataAccessScope(request?: protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IDataAccessScope,
        (protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest | undefined),
        {} | undefined
    ]>;

Creates a data access scope. Data access scope is a combination of allowed and denied labels attached to a permission group. If a scope has allowed labels A and B and denied labels C and D, then the group of people attached to the scope will have permissions to see all events labeled with A or B (or both) and not labeled with either C or D.

Parameters
Name Description
request ICreateDataAccessScopeRequest

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.IDataAccessScope, (protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DataAccessScope. 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 Data Access Scope will be created.
   *  Format: `projects/{project}/locations/{location}/instances/{instance}`
   */
  // const parent = 'abc123'
  /**
   *  Required. Data access scope to create.
   */
  // const dataAccessScope = {}
  /**
   *  Required. The user provided scope id which will become the last part of the
   *  name of the scope resource. Needs to be compliant with
   *  https://google.aip.dev/122
   */
  // const dataAccessScopeId = 'abc123'

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

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

  async function callCreateDataAccessScope() {
    // Construct request
    const request = {
      parent,
      dataAccessScope,
      dataAccessScopeId,
    };

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

  callCreateDataAccessScope();

createDataAccessScope(request, options, callback)

createDataAccessScope(request: protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDataAccessScopeRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDataAccessScope(request, callback)

createDataAccessScope(request: protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDataAccessScopeRequest
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest | 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.

deleteDataAccessLabel(request, options)

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

Deletes a data access label. When a label is deleted, new data that enters in the system will not receive the label, but the label will not be removed from old data that still refers to it.

Parameters
Name Description
request IDeleteDataAccessLabelRequest

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.IDeleteDataAccessLabelRequest | 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 ID of the data access label to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteDataAccessLabel();

deleteDataAccessLabel(request, options, callback)

deleteDataAccessLabel(request: protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDataAccessLabelRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDataAccessLabel(request, callback)

deleteDataAccessLabel(request: protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDataAccessLabelRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDataAccessScope(request, options)

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

Deletes a data access scope.

Parameters
Name Description
request IDeleteDataAccessScopeRequest

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.IDeleteDataAccessScopeRequest | 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 ID of the data access scope to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteDataAccessScope();

deleteDataAccessScope(request, options, callback)

deleteDataAccessScope(request: protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDataAccessScopeRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDataAccessScope(request, callback)

deleteDataAccessScope(request: protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDataAccessScopeRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest | 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.

feedPackPath(project, location, instance, feedPack)

feedPackPath(project: string, location: string, instance: string, feedPack: string): string;

Return a fully-qualified feedPack resource name string.

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

{string} Resource name string.

feedPath(project, location, instance, feed)

feedPath(project: string, location: string, instance: string, feed: string): string;

Return a fully-qualified feed resource name string.

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

{string} Resource name string.

feedServiceAccountPath(project, location, instance, feedServiceAccount)

feedServiceAccountPath(project: string, location: string, instance: string, feedServiceAccount: string): string;

Return a fully-qualified feedServiceAccount resource name string.

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

{string} Resource name string.

feedSourceTypeSchemaPath(project, location, instance, feedSourceType)

feedSourceTypeSchemaPath(project: string, location: string, instance: string, feedSourceType: string): string;

Return a fully-qualified feedSourceTypeSchema resource name string.

Parameters
Name Description
project string
location string
instance string
feedSourceType 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.

getDataAccessLabel(request, options)

getDataAccessLabel(request?: protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IDataAccessLabel,
        protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest | undefined,
        {} | undefined
    ]>;

Gets a data access label.

Parameters
Name Description
request IGetDataAccessLabelRequest

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.IDataAccessLabel, protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DataAccessLabel. 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 ID of the data access label to retrieve.
   *  Format:
   *  `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetDataAccessLabel();

getDataAccessLabel(request, options, callback)

getDataAccessLabel(request: protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDataAccessLabelRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDataAccessLabel(request, callback)

getDataAccessLabel(request: protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDataAccessLabelRequest
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDataAccessScope(request, options)

getDataAccessScope(request?: protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IDataAccessScope,
        protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest | undefined,
        {} | undefined
    ]>;

Retrieves an existing data access scope.

Parameters
Name Description
request IGetDataAccessScopeRequest

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.IDataAccessScope, protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DataAccessScope. 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 ID of the data access scope to retrieve.
   *  Format:
   *  `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetDataAccessScope();

getDataAccessScope(request, options, callback)

getDataAccessScope(request: protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDataAccessScopeRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDataAccessScope(request, callback)

getDataAccessScope(request: protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDataAccessScopeRequest
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest | 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

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.

listDataAccessLabels(request, options)

listDataAccessLabels(request?: protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IDataAccessLabel[],
        protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest | null,
        protos.google.cloud.chronicle.v1.IListDataAccessLabelsResponse
    ]>;

Lists all data access labels for the customer.

Parameters
Name Description
request IListDataAccessLabelsRequest

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.IDataAccessLabel[], protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest | null, protos.google.cloud.chronicle.v1.IListDataAccessLabelsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of DataAccessLabel. 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 listDataAccessLabelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDataAccessLabels(request, options, callback)

listDataAccessLabels(request: protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, protos.google.cloud.chronicle.v1.IListDataAccessLabelsResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessLabel>): void;
Parameters
Name Description
request IListDataAccessLabelsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, protos.google.cloud.chronicle.v1.IListDataAccessLabelsResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessLabel>
Returns
Type Description
void

listDataAccessLabels(request, callback)

listDataAccessLabels(request: protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, protos.google.cloud.chronicle.v1.IListDataAccessLabelsResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessLabel>): void;
Parameters
Name Description
request IListDataAccessLabelsRequest
callback PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, protos.google.cloud.chronicle.v1.IListDataAccessLabelsResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessLabel>
Returns
Type Description
void

listDataAccessLabelsAsync(request, options)

listDataAccessLabelsAsync(request?: protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.chronicle.v1.IDataAccessLabel>;

Equivalent to listDataAccessLabels, but returns an iterable object.

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

Parameters
Name Description
request IListDataAccessLabelsRequest

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.IDataAccessLabel>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DataAccessLabel. 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 resource where this data access label will be created.
   *  Format: `projects/{project}/locations/{location}/instances/{instance}`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of data access labels to return. The service may return
   *  fewer than this value. If unspecified, at most 100 data access labels will
   *  be returned. The maximum value is 1000; values above 1000 will be coerced
   *  to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListDataAccessLabelsRequest` call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A filter which should follow the guidelines of AIP-160.
   *  Supports filtering on all fieds of DataAccessLabel and all operations as
   *  mentioned in https://google.aip.dev/160.
   *  example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
   *  display_name:\"-21-1\"".
   */
  // const filter = 'abc123'

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

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

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

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

  callListDataAccessLabels();

listDataAccessLabelsStream(request, options)

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

Equivalent to listDataAccessLabels, but returns a NodeJS Stream object.

Parameters
Name Description
request IListDataAccessLabelsRequest

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 DataAccessLabel 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 listDataAccessLabelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDataAccessScopes(request, options)

listDataAccessScopes(request?: protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IDataAccessScope[],
        protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest | null,
        protos.google.cloud.chronicle.v1.IListDataAccessScopesResponse
    ]>;

Lists all existing data access scopes for the customer.

Parameters
Name Description
request IListDataAccessScopesRequest

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.IDataAccessScope[], protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest | null, protos.google.cloud.chronicle.v1.IListDataAccessScopesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of DataAccessScope. 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 listDataAccessScopesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDataAccessScopes(request, options, callback)

listDataAccessScopes(request: protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, protos.google.cloud.chronicle.v1.IListDataAccessScopesResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessScope>): void;
Parameters
Name Description
request IListDataAccessScopesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, protos.google.cloud.chronicle.v1.IListDataAccessScopesResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessScope>
Returns
Type Description
void

listDataAccessScopes(request, callback)

listDataAccessScopes(request: protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, protos.google.cloud.chronicle.v1.IListDataAccessScopesResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessScope>): void;
Parameters
Name Description
request IListDataAccessScopesRequest
callback PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, protos.google.cloud.chronicle.v1.IListDataAccessScopesResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessScope>
Returns
Type Description
void

listDataAccessScopesAsync(request, options)

listDataAccessScopesAsync(request?: protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.chronicle.v1.IDataAccessScope>;

Equivalent to listDataAccessScopes, but returns an iterable object.

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

Parameters
Name Description
request IListDataAccessScopesRequest

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.IDataAccessScope>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DataAccessScope. 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 resource where this data access scope will be created.
   *  Format: `projects/{project}/locations/{location}/instances/{instance}`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of data access scopes to return. The service may return
   *  fewer than this value. If unspecified, at most 100 data access scopes will
   *  be returned. The maximum value is 1000; values above 1000 will be coerced
   *  to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListDataAccessScopesRequest` call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A filter which should follow the guidelines of AIP-160.
   *  Supports filtering on all fieds of DataAccessScope and all operations as
   *  mentioned in https://google.aip.dev/160.
   *  example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
   *  display_name:\"-21-1\"".
   */
  // const filter = 'abc123'

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

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

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

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

  callListDataAccessScopes();

listDataAccessScopesStream(request, options)

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

Equivalent to listDataAccessScopes, but returns a NodeJS Stream object.

Parameters
Name Description
request IListDataAccessScopesRequest

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 DataAccessScope 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 listDataAccessScopesAsync() 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.

logTypeSchemaPath(project, location, instance, feedSourceType, logType)

logTypeSchemaPath(project: string, location: string, instance: string, feedSourceType: string, logType: string): string;

Return a fully-qualified logTypeSchema resource name string.

Parameters
Name Description
project string
location string
instance string
feedSourceType string
logType 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.

matchFeedFromFeedName(feedName)

matchFeedFromFeedName(feedName: string): string | number;

Parse the feed from Feed resource.

Parameter
Name Description
feedName string

A fully-qualified path representing Feed resource.

Returns
Type Description
string | number

{string} A string representing the feed.

matchFeedPackFromFeedPackName(feedPackName)

matchFeedPackFromFeedPackName(feedPackName: string): string | number;

Parse the feed_pack from FeedPack resource.

Parameter
Name Description
feedPackName string

A fully-qualified path representing FeedPack resource.

Returns
Type Description
string | number

{string} A string representing the feed_pack.

matchFeedServiceAccountFromFeedServiceAccountName(feedServiceAccountName)

matchFeedServiceAccountFromFeedServiceAccountName(feedServiceAccountName: string): string | number;

Parse the feed_service_account from FeedServiceAccount resource.

Parameter
Name Description
feedServiceAccountName string

A fully-qualified path representing FeedServiceAccount resource.

Returns
Type Description
string | number

{string} A string representing the feed_service_account.

matchFeedSourceTypeFromFeedSourceTypeSchemaName(feedSourceTypeSchemaName)

matchFeedSourceTypeFromFeedSourceTypeSchemaName(feedSourceTypeSchemaName: string): string | number;

Parse the feed_source_type from FeedSourceTypeSchema resource.

Parameter
Name Description
feedSourceTypeSchemaName string

A fully-qualified path representing FeedSourceTypeSchema resource.

Returns
Type Description
string | number

{string} A string representing the feed_source_type.

matchFeedSourceTypeFromLogTypeSchemaName(logTypeSchemaName)

matchFeedSourceTypeFromLogTypeSchemaName(logTypeSchemaName: string): string | number;

Parse the feed_source_type from LogTypeSchema resource.

Parameter
Name Description
logTypeSchemaName string

A fully-qualified path representing LogTypeSchema resource.

Returns
Type Description
string | number

{string} A string representing the feed_source_type.

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.

matchInstanceFromFeedName(feedName)

matchInstanceFromFeedName(feedName: string): string | number;

Parse the instance from Feed resource.

Parameter
Name Description
feedName string

A fully-qualified path representing Feed resource.

Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromFeedPackName(feedPackName)

matchInstanceFromFeedPackName(feedPackName: string): string | number;

Parse the instance from FeedPack resource.

Parameter
Name Description
feedPackName string

A fully-qualified path representing FeedPack resource.

Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromFeedServiceAccountName(feedServiceAccountName)

matchInstanceFromFeedServiceAccountName(feedServiceAccountName: string): string | number;

Parse the instance from FeedServiceAccount resource.

Parameter
Name Description
feedServiceAccountName string

A fully-qualified path representing FeedServiceAccount resource.

Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromFeedSourceTypeSchemaName(feedSourceTypeSchemaName)

matchInstanceFromFeedSourceTypeSchemaName(feedSourceTypeSchemaName: string): string | number;

Parse the instance from FeedSourceTypeSchema resource.

Parameter
Name Description
feedSourceTypeSchemaName string

A fully-qualified path representing FeedSourceTypeSchema 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.

matchInstanceFromLogTypeSchemaName(logTypeSchemaName)

matchInstanceFromLogTypeSchemaName(logTypeSchemaName: string): string | number;

Parse the instance from LogTypeSchema resource.

Parameter
Name Description
logTypeSchemaName string

A fully-qualified path representing LogTypeSchema 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.

matchLocationFromFeedName(feedName)

matchLocationFromFeedName(feedName: string): string | number;

Parse the location from Feed resource.

Parameter
Name Description
feedName string

A fully-qualified path representing Feed resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFeedPackName(feedPackName)

matchLocationFromFeedPackName(feedPackName: string): string | number;

Parse the location from FeedPack resource.

Parameter
Name Description
feedPackName string

A fully-qualified path representing FeedPack resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFeedServiceAccountName(feedServiceAccountName)

matchLocationFromFeedServiceAccountName(feedServiceAccountName: string): string | number;

Parse the location from FeedServiceAccount resource.

Parameter
Name Description
feedServiceAccountName string

A fully-qualified path representing FeedServiceAccount resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFeedSourceTypeSchemaName(feedSourceTypeSchemaName)

matchLocationFromFeedSourceTypeSchemaName(feedSourceTypeSchemaName: string): string | number;

Parse the location from FeedSourceTypeSchema resource.

Parameter
Name Description
feedSourceTypeSchemaName string

A fully-qualified path representing FeedSourceTypeSchema 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.

matchLocationFromLogTypeSchemaName(logTypeSchemaName)

matchLocationFromLogTypeSchemaName(logTypeSchemaName: string): string | number;

Parse the location from LogTypeSchema resource.

Parameter
Name Description
logTypeSchemaName string

A fully-qualified path representing LogTypeSchema 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.

matchLogTypeFromLogTypeSchemaName(logTypeSchemaName)

matchLogTypeFromLogTypeSchemaName(logTypeSchemaName: string): string | number;

Parse the log_type from LogTypeSchema resource.

Parameter
Name Description
logTypeSchemaName string

A fully-qualified path representing LogTypeSchema resource.

Returns
Type Description
string | number

{string} A string representing the log_type.

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.

matchProjectFromFeedName(feedName)

matchProjectFromFeedName(feedName: string): string | number;

Parse the project from Feed resource.

Parameter
Name Description
feedName string

A fully-qualified path representing Feed resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromFeedPackName(feedPackName)

matchProjectFromFeedPackName(feedPackName: string): string | number;

Parse the project from FeedPack resource.

Parameter
Name Description
feedPackName string

A fully-qualified path representing FeedPack resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromFeedServiceAccountName(feedServiceAccountName)

matchProjectFromFeedServiceAccountName(feedServiceAccountName: string): string | number;

Parse the project from FeedServiceAccount resource.

Parameter
Name Description
feedServiceAccountName string

A fully-qualified path representing FeedServiceAccount resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromFeedSourceTypeSchemaName(feedSourceTypeSchemaName)

matchProjectFromFeedSourceTypeSchemaName(feedSourceTypeSchemaName: string): string | number;

Parse the project from FeedSourceTypeSchema resource.

Parameter
Name Description
feedSourceTypeSchemaName string

A fully-qualified path representing FeedSourceTypeSchema 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.

matchProjectFromLogTypeSchemaName(logTypeSchemaName)

matchProjectFromLogTypeSchemaName(logTypeSchemaName: string): string | number;

Parse the project from LogTypeSchema resource.

Parameter
Name Description
logTypeSchemaName string

A fully-qualified path representing LogTypeSchema 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.

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.

updateDataAccessLabel(request, options)

updateDataAccessLabel(request?: protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IDataAccessLabel,
        (protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest | undefined),
        {} | undefined
    ]>;

Updates a data access label.

Parameters
Name Description
request IUpdateDataAccessLabelRequest

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.IDataAccessLabel, (protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DataAccessLabel. 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 data access label to update.
   *  The label's `name` field is used to identify the label to update.
   *  Format:
   *  `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
   */
  // const dataAccessLabel = {}
  /**
   *  The list of fields to update. If not included, all fields with a non-empty
   *  value will be overwritten. Currently, only the description and definition
   *  fields are supported for update; an update call that attempts to update any
   *  other fields will return INVALID_ARGUMENT.
   */
  // const updateMask = {}

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

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

  async function callUpdateDataAccessLabel() {
    // Construct request
    const request = {
      dataAccessLabel,
    };

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

  callUpdateDataAccessLabel();

updateDataAccessLabel(request, options, callback)

updateDataAccessLabel(request: protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDataAccessLabelRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataAccessLabel(request, callback)

updateDataAccessLabel(request: protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDataAccessLabelRequest
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataAccessScope(request, options)

updateDataAccessScope(request?: protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IDataAccessScope,
        (protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest | undefined),
        {} | undefined
    ]>;

Updates a data access scope.

Parameters
Name Description
request IUpdateDataAccessScopeRequest

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.IDataAccessScope, (protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DataAccessScope. 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 data access scope to update.
   *  The scope's `name` field is used to identify the scope to update.
   *  Format:
   *  `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
   */
  // const dataAccessScope = {}
  /**
   *  The list of fields to update. If not included, all fields with a non-empty
   *  value will be overwritten. Currently, only the description, the allowed
   *  and denied labels list fields are supported for update;
   *  an update call that attempts to update any
   *  other fields will return INVALID_ARGUMENT.
   */
  // const updateMask = {}

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

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

  async function callUpdateDataAccessScope() {
    // Construct request
    const request = {
      dataAccessScope,
    };

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

  callUpdateDataAccessScope();

updateDataAccessScope(request, options, callback)

updateDataAccessScope(request: protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDataAccessScopeRequest
options CallOptions
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataAccessScope(request, callback)

updateDataAccessScope(request: protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDataAccessScopeRequest
callback Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest | 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.