Class v1.SecurityCenterClient (8.12.0)

Version latest

• 8.12.0 (latest)
• 8.11.0
• 8.10.0
• 8.9.0
• 8.7.0
• 8.5.0
• 8.4.0
• 8.3.0
• 8.1.0
• 8.0.0
• 7.4.0
• 7.2.1
• 7.0.0
• 6.3.1
• 6.2.0
• 5.10.0
• 5.9.0
• 5.8.0
• 5.7.0
• 5.6.0
• 5.5.1
• 5.4.1
• 5.3.5

V1 APIs for Security Center service. v1

Package

@google-cloud/security-center

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of SecurityCenterClient.

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 SecurityCenterClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

operationsClient

operationsClient: gax.OperationsClient;

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.

securityCenterStub

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

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

attackPathPath(organization, simulation, valuedResource, attackPath)

attackPathPath(organization: string, simulation: string, valuedResource: string, attackPath: string): string;

Return a fully-qualified attackPath resource name string.

Parameters
Name	Description
organization	string
simulation	string
valuedResource	string
attackPath	string

Returns
Type	Description
string	{string} Resource name string.

batchCreateResourceValueConfigs(request, options)

batchCreateResourceValueConfigs(request?: protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsResponse,
        (protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsRequest | undefined),
        {} | undefined
    ]>;

Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation.

Parameters
Name	Description
request	IBatchCreateResourceValueConfigsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsResponse, (protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing BatchCreateResourceValueConfigsResponse. 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. Resource name of the new ResourceValueConfig's parent.
   *  The parent field in the CreateResourceValueConfigRequest
   *  messages must either be empty or match this field.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource value configs to be created.
   */
  // const requests = [1,2,3,4]

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.batchCreateResourceValueConfigs(request);
    console.log(response);
  }

  callBatchCreateResourceValueConfigs();

batchCreateResourceValueConfigs(request, options, callback)

batchCreateResourceValueConfigs(request: protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsResponse, protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchCreateResourceValueConfigsRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsResponse, protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchCreateResourceValueConfigs(request, callback)

batchCreateResourceValueConfigs(request: protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsResponse, protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchCreateResourceValueConfigsRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsResponse, protos.google.cloud.securitycenter.v1.IBatchCreateResourceValueConfigsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

bulkMuteFindings(request, options)

bulkMuteFindings(request?: protos.google.cloud.securitycenter.v1.IBulkMuteFindingsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.securitycenter.v1.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.

Parameters
Name	Description
request	IBulkMuteFindingsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.securitycenter.v1.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. 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, at which bulk action needs to be applied. Its format
   *  is `organizations/[organization_id]`, `folders/[folder_id]`,
   *  `projects/[project_id]`.
   */
  // const parent = 'abc123'
  /**
   *  Expression that identifies findings that should be updated.
   *  The expression is a list of zero or more restrictions combined
   *  via logical operators `AND` and `OR`. Parentheses are supported, and `OR`
   *  has higher precedence than `AND`.
   *  Restrictions have the form `

bulkMuteFindings(request, options, callback)

bulkMuteFindings(request: protos.google.cloud.securitycenter.v1.IBulkMuteFindingsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.securitycenter.v1.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBulkMuteFindingsRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.securitycenter.v1.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

bulkMuteFindings(request, callback)

bulkMuteFindings(request: protos.google.cloud.securitycenter.v1.IBulkMuteFindingsRequest, callback: Callback<LROperation<protos.google.cloud.securitycenter.v1.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBulkMuteFindingsRequest
callback	Callback<LROperation<protos.google.cloud.securitycenter.v1.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
request	CancelOperationRequest The request object that will be sent.
options	CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkBulkMuteFindingsProgress(name)

checkBulkMuteFindingsProgress(name: string): Promise<LROperation<protos.google.cloud.securitycenter.v1.BulkMuteFindingsResponse, protos.google.protobuf.Empty>>;

Check the status of the long running operation returned by bulkMuteFindings().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.securitycenter.v1.BulkMuteFindingsResponse, protos.google.protobuf.Empty>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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, at which bulk action needs to be applied. Its format
   *  is `organizations/[organization_id]`, `folders/[folder_id]`,
   *  `projects/[project_id]`.
   */
  // const parent = 'abc123'
  /**
   *  Expression that identifies findings that should be updated.
   *  The expression is a list of zero or more restrictions combined
   *  via logical operators `AND` and `OR`. Parentheses are supported, and `OR`
   *  has higher precedence than `AND`.
   *  Restrictions have the form `

checkRunAssetDiscoveryProgress(name)

checkRunAssetDiscoveryProgress(name: string): Promise<LROperation<protos.google.cloud.securitycenter.v1.RunAssetDiscoveryResponse, protos.google.protobuf.Empty>>;

Check the status of the long running operation returned by runAssetDiscovery().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.securitycenter.v1.RunAssetDiscoveryResponse, protos.google.protobuf.Empty>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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. Name of the organization to run asset discovery for. Its format
   *  is `organizations/[organization_id]`.
   */
  // const parent = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const [operation] = await securitycenterClient.runAssetDiscovery(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRunAssetDiscovery();

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.

createBigQueryExport(request, options)

createBigQueryExport(request?: protos.google.cloud.securitycenter.v1.ICreateBigQueryExportRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IBigQueryExport,
        (protos.google.cloud.securitycenter.v1.ICreateBigQueryExportRequest | undefined),
        {} | undefined
    ]>;

Creates a BigQuery export.

Parameters
Name	Description
request	ICreateBigQueryExportRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IBigQueryExport, (protos.google.cloud.securitycenter.v1.ICreateBigQueryExportRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing BigQueryExport. 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 name of the parent resource of the new BigQuery export. Its
   *  format is `organizations/[organization_id]`, `folders/[folder_id]`, or
   *  `projects/[project_id]`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The BigQuery export being created.
   */
  // const bigQueryExport = {}
  /**
   *  Required. Unique identifier provided by the client within the parent scope.
   *  It must consist of only lowercase letters, numbers, and hyphens, must start
   *  with a letter, must end with either a letter or a number, and must be 63
   *  characters or less.
   */
  // const bigQueryExportId = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callCreateBigQueryExport() {
    // Construct request
    const request = {
      parent,
      bigQueryExport,
      bigQueryExportId,
    };

    // Run request
    const response = await securitycenterClient.createBigQueryExport(request);
    console.log(response);
  }

  callCreateBigQueryExport();

createBigQueryExport(request, options, callback)

createBigQueryExport(request: protos.google.cloud.securitycenter.v1.ICreateBigQueryExportRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.ICreateBigQueryExportRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateBigQueryExportRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.ICreateBigQueryExportRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createBigQueryExport(request, callback)

createBigQueryExport(request: protos.google.cloud.securitycenter.v1.ICreateBigQueryExportRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.ICreateBigQueryExportRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateBigQueryExportRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.ICreateBigQueryExportRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createEventThreatDetectionCustomModule(request, options)

createEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycenter.v1.ICreateEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule,
        (protos.google.cloud.securitycenter.v1.ICreateEventThreatDetectionCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

Parameters
Name	Description
request	ICreateEventThreatDetectionCustomModuleRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, (protos.google.cloud.securitycenter.v1.ICreateEventThreatDetectionCustomModuleRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 new custom module's parent.
   *  Its format is:
   *    * `organizations/{organization}/eventThreatDetectionSettings`.
   *    * `folders/{folder}/eventThreatDetectionSettings`.
   *    * `projects/{project}/eventThreatDetectionSettings`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The module to create. The
   *  event_threat_detection_custom_module.name will be ignored and server
   *  generated.
   */
  // const eventThreatDetectionCustomModule = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.createEventThreatDetectionCustomModule(request);
    console.log(response);
  }

  callCreateEventThreatDetectionCustomModule();

createEventThreatDetectionCustomModule(request, options, callback)

createEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.ICreateEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.ICreateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateEventThreatDetectionCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.ICreateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createEventThreatDetectionCustomModule(request, callback)

createEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.ICreateEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.ICreateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateEventThreatDetectionCustomModuleRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.ICreateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFinding(request, options)

createFinding(request?: protos.google.cloud.securitycenter.v1.ICreateFindingRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IFinding,
        protos.google.cloud.securitycenter.v1.ICreateFindingRequest | undefined,
        {} | undefined
    ]>;

Creates a finding. The corresponding source must exist for finding creation to succeed.

Parameters
Name	Description
request	ICreateFindingRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ICreateFindingRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Resource name of the new finding's parent. Its format should be
   *  `organizations/[organization_id]/sources/[source_id]`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Unique identifier provided by the client within the parent scope.
   *  It must be alphanumeric and less than or equal to 32 characters and
   *  greater than 0 characters in length.
   */
  // const findingId = 'abc123'
  /**
   *  Required. The Finding being created. The name and security_marks will be
   *  ignored as they are both output only fields on this resource.
   */
  // const finding = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callCreateFinding() {
    // Construct request
    const request = {
      parent,
      findingId,
      finding,
    };

    // Run request
    const response = await securitycenterClient.createFinding(request);
    console.log(response);
  }

  callCreateFinding();

createFinding(request, options, callback)

createFinding(request: protos.google.cloud.securitycenter.v1.ICreateFindingRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ICreateFindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFindingRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ICreateFindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFinding(request, callback)

createFinding(request: protos.google.cloud.securitycenter.v1.ICreateFindingRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ICreateFindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFindingRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ICreateFindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createMuteConfig(request, options)

createMuteConfig(request?: protos.google.cloud.securitycenter.v1.ICreateMuteConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IMuteConfig,
        (protos.google.cloud.securitycenter.v1.ICreateMuteConfigRequest | undefined),
        {} | undefined
    ]>;

Creates a mute config.

Parameters
Name	Description
request	ICreateMuteConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IMuteConfig, (protos.google.cloud.securitycenter.v1.ICreateMuteConfigRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Resource name of the new mute configs's parent. Its format is
   *  `organizations/[organization_id]`, `folders/[folder_id]`, or
   *  `projects/[project_id]`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The mute config being created.
   */
  // const muteConfig = {}
  /**
   *  Required. Unique identifier provided by the client within the parent scope.
   *  It must consist of only lowercase letters, numbers, and hyphens, must start
   *  with a letter, must end with either a letter or a number, and must be 63
   *  characters or less.
   */
  // const muteConfigId = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callCreateMuteConfig() {
    // Construct request
    const request = {
      parent,
      muteConfig,
      muteConfigId,
    };

    // Run request
    const response = await securitycenterClient.createMuteConfig(request);
    console.log(response);
  }

  callCreateMuteConfig();

createMuteConfig(request, options, callback)

createMuteConfig(request: protos.google.cloud.securitycenter.v1.ICreateMuteConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.ICreateMuteConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateMuteConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.ICreateMuteConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createMuteConfig(request, callback)

createMuteConfig(request: protos.google.cloud.securitycenter.v1.ICreateMuteConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.ICreateMuteConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateMuteConfigRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.ICreateMuteConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createNotificationConfig(request, options)

createNotificationConfig(request?: protos.google.cloud.securitycenter.v1.ICreateNotificationConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.INotificationConfig,
        (protos.google.cloud.securitycenter.v1.ICreateNotificationConfigRequest | undefined),
        {} | undefined
    ]>;

Creates a notification config.

Parameters
Name	Description
request	ICreateNotificationConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.INotificationConfig, (protos.google.cloud.securitycenter.v1.ICreateNotificationConfigRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Resource name of the new notification config's parent. Its format
   *  is `organizations/[organization_id]`, `folders/[folder_id]`, or
   *  `projects/[project_id]`.
   */
  // const parent = 'abc123'
  /**
   *  Required.
   *  Unique identifier provided by the client within the parent scope.
   *  It must be between 1 and 128 characters and contain alphanumeric
   *  characters, underscores, or hyphens only.
   */
  // const configId = 'abc123'
  /**
   *  Required. The notification config being created. The name and the service
   *  account will be ignored as they are both output only fields on this
   *  resource.
   */
  // const notificationConfig = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callCreateNotificationConfig() {
    // Construct request
    const request = {
      parent,
      configId,
      notificationConfig,
    };

    // Run request
    const response = await securitycenterClient.createNotificationConfig(request);
    console.log(response);
  }

  callCreateNotificationConfig();

createNotificationConfig(request, options, callback)

createNotificationConfig(request: protos.google.cloud.securitycenter.v1.ICreateNotificationConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.ICreateNotificationConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateNotificationConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.ICreateNotificationConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createNotificationConfig(request, callback)

createNotificationConfig(request: protos.google.cloud.securitycenter.v1.ICreateNotificationConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.ICreateNotificationConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateNotificationConfigRequest
callback	Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.ICreateNotificationConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createSecurityHealthAnalyticsCustomModule(request, options)

createSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycenter.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule,
        (protos.google.cloud.securitycenter.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.

Parameters
Name	Description
request	ICreateSecurityHealthAnalyticsCustomModuleRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, (protos.google.cloud.securitycenter.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Resource name of the new custom module's parent. Its format is
   *  `organizations/{organization}/securityHealthAnalyticsSettings`,
   *  `folders/{folder}/securityHealthAnalyticsSettings`, or
   *  `projects/{project}/securityHealthAnalyticsSettings`
   */
  // const parent = 'abc123'
  /**
   *  Required. SecurityHealthAnalytics custom module to create. The provided
   *  name is ignored and reset with provided parent information and
   *  server-generated ID.
   */
  // const securityHealthAnalyticsCustomModule = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.createSecurityHealthAnalyticsCustomModule(request);
    console.log(response);
  }

  callCreateSecurityHealthAnalyticsCustomModule();

createSecurityHealthAnalyticsCustomModule(request, options, callback)

createSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateSecurityHealthAnalyticsCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createSecurityHealthAnalyticsCustomModule(request, callback)

createSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateSecurityHealthAnalyticsCustomModuleRequest
callback	Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createSource(request, options)

createSource(request?: protos.google.cloud.securitycenter.v1.ICreateSourceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISource,
        protos.google.cloud.securitycenter.v1.ICreateSourceRequest | undefined,
        {} | undefined
    ]>;

Creates a source.

Parameters
Name	Description
request	ICreateSourceRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.ICreateSourceRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Source. 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. Resource name of the new source's parent. Its format should be
   *  `organizations/[organization_id]`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Source being created, only the display_name and description
   *  will be used. All other fields will be ignored.
   */
  // const source = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.createSource(request);
    console.log(response);
  }

  callCreateSource();

createSource(request, options, callback)

createSource(request: protos.google.cloud.securitycenter.v1.ICreateSourceRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.ICreateSourceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateSourceRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.ICreateSourceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createSource(request, callback)

createSource(request: protos.google.cloud.securitycenter.v1.ICreateSourceRequest, callback: Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.ICreateSourceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateSourceRequest
callback	Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.ICreateSourceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteBigQueryExport(request, options)

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

Deletes an existing BigQuery export.

Parameters
Name	Description
request	IDeleteBigQueryExportRequest 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.securitycenter.v1.IDeleteBigQueryExportRequest | 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 name of the BigQuery export to delete. Its format is
   *  `organizations/{organization}/bigQueryExports/{export_id}`,
   *  `folders/{folder}/bigQueryExports/{export_id}`, or
   *  `projects/{project}/bigQueryExports/{export_id}`
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.deleteBigQueryExport(request);
    console.log(response);
  }

  callDeleteBigQueryExport();

deleteBigQueryExport(request, options, callback)

deleteBigQueryExport(request: protos.google.cloud.securitycenter.v1.IDeleteBigQueryExportRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteBigQueryExportRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteBigQueryExportRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteBigQueryExportRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteBigQueryExport(request, callback)

deleteBigQueryExport(request: protos.google.cloud.securitycenter.v1.IDeleteBigQueryExportRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteBigQueryExportRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteBigQueryExportRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteBigQueryExportRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteEventThreatDetectionCustomModule(request, options)

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

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

Parameters
Name	Description
request	IDeleteEventThreatDetectionCustomModuleRequest 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.securitycenter.v1.IDeleteEventThreatDetectionCustomModuleRequest | 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. Name of the custom module to delete.
   *  Its format is:
   *  * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`.
   *  * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`.
   *  * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.deleteEventThreatDetectionCustomModule(request);
    console.log(response);
  }

  callDeleteEventThreatDetectionCustomModule();

deleteEventThreatDetectionCustomModule(request, options, callback)

deleteEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.IDeleteEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteEventThreatDetectionCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteEventThreatDetectionCustomModule(request, callback)

deleteEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.IDeleteEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteEventThreatDetectionCustomModuleRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteMuteConfig(request, options)

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

Deletes an existing mute config.

Parameters
Name	Description
request	IDeleteMuteConfigRequest 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.securitycenter.v1.IDeleteMuteConfigRequest | 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. Name of the mute config to delete. Its format is
   *  `organizations/{organization}/muteConfigs/{config_id}`,
   *  `folders/{folder}/muteConfigs/{config_id}`,
   *  `projects/{project}/muteConfigs/{config_id}`,
   *  `organizations/{organization}/locations/global/muteConfigs/{config_id}`,
   *  `folders/{folder}/locations/global/muteConfigs/{config_id}`, or
   *  `projects/{project}/locations/global/muteConfigs/{config_id}`.
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.deleteMuteConfig(request);
    console.log(response);
  }

  callDeleteMuteConfig();

deleteMuteConfig(request, options, callback)

deleteMuteConfig(request: protos.google.cloud.securitycenter.v1.IDeleteMuteConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteMuteConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteMuteConfigRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteMuteConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteMuteConfig(request, callback)

deleteMuteConfig(request: protos.google.cloud.securitycenter.v1.IDeleteMuteConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteMuteConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteMuteConfigRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteMuteConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteNotificationConfig(request, options)

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

Deletes a notification config.

Parameters
Name	Description
request	IDeleteNotificationConfigRequest 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.securitycenter.v1.IDeleteNotificationConfigRequest | 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. Name of the notification config to delete. Its format is
   *  `organizations/[organization_id]/notificationConfigs/[config_id]`,
   *  `folders/[folder_id]/notificationConfigs/[config_id]`,
   *  or `projects/[project_id]/notificationConfigs/[config_id]`.
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.deleteNotificationConfig(request);
    console.log(response);
  }

  callDeleteNotificationConfig();

deleteNotificationConfig(request, options, callback)

deleteNotificationConfig(request: protos.google.cloud.securitycenter.v1.IDeleteNotificationConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteNotificationConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteNotificationConfigRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteNotificationConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteNotificationConfig(request, callback)

deleteNotificationConfig(request: protos.google.cloud.securitycenter.v1.IDeleteNotificationConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteNotificationConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteNotificationConfigRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteNotificationConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	DeleteOperationRequest The request object that will be sent.
options	CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deleteResourceValueConfig(request, options)

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

Deletes a ResourceValueConfig.

Parameters
Name	Description
request	IDeleteResourceValueConfigRequest 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.securitycenter.v1.IDeleteResourceValueConfigRequest | 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. Name of the ResourceValueConfig to delete
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.deleteResourceValueConfig(request);
    console.log(response);
  }

  callDeleteResourceValueConfig();

deleteResourceValueConfig(request, options, callback)

deleteResourceValueConfig(request: protos.google.cloud.securitycenter.v1.IDeleteResourceValueConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteResourceValueConfigRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteResourceValueConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteResourceValueConfig(request, callback)

deleteResourceValueConfig(request: protos.google.cloud.securitycenter.v1.IDeleteResourceValueConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteResourceValueConfigRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteResourceValueConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteSecurityHealthAnalyticsCustomModule(request, options)

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

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

Parameters
Name	Description
request	IDeleteSecurityHealthAnalyticsCustomModuleRequest 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.securitycenter.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | 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. Name of the custom module to delete. Its format is
   *  `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`,
   *  `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`,
   *  or
   *  `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.deleteSecurityHealthAnalyticsCustomModule(request);
    console.log(response);
  }

  callDeleteSecurityHealthAnalyticsCustomModule();

deleteSecurityHealthAnalyticsCustomModule(request, options, callback)

deleteSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteSecurityHealthAnalyticsCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteSecurityHealthAnalyticsCustomModule(request, callback)

deleteSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteSecurityHealthAnalyticsCustomModuleRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

folderAssetPath(folder, asset)

folderAssetPath(folder: string, asset: string): string;

Return a fully-qualified folderAsset resource name string.

Parameters
Name	Description
folder	string
asset	string

Returns
Type	Description
string	{string} Resource name string.

folderAssetSecurityMarksPath(folder, asset)

folderAssetSecurityMarksPath(folder: string, asset: string): string;

Return a fully-qualified folderAssetSecurityMarks resource name string.

Parameters
Name	Description
folder	string
asset	string

Returns
Type	Description
string	{string} Resource name string.

folderConstraintNamePath(folder, constraintName)

folderConstraintNamePath(folder: string, constraintName: string): string;

Return a fully-qualified folderConstraintName resource name string.

Parameters
Name	Description
folder	string
constraintName	string

Returns
Type	Description
string	{string} Resource name string.

folderEventThreatDetectionSettingsModulePath(folder, module)

folderEventThreatDetectionSettingsModulePath(folder: string, module: string): string;

Return a fully-qualified folderEventThreatDetectionSettingsModule resource name string.

Parameters
Name	Description
folder	string
module	string

Returns
Type	Description
string	{string} Resource name string.

folderExportPath(folder, exportParam)

folderExportPath(folder: string, exportParam: string): string;

Return a fully-qualified folderExport resource name string.

Parameters
Name	Description
folder	string
exportParam	string

Returns
Type	Description
string	{string} Resource name string.

folderLocationMuteConfigPath(folder, location, muteConfig)

folderLocationMuteConfigPath(folder: string, location: string, muteConfig: string): string;

Return a fully-qualified folderLocationMuteConfig resource name string.

Parameters
Name	Description
folder	string
location	string
muteConfig	string

Returns
Type	Description
string	{string} Resource name string.

folderMuteConfigPath(folder, muteConfig)

folderMuteConfigPath(folder: string, muteConfig: string): string;

Return a fully-qualified folderMuteConfig resource name string.

Parameters
Name	Description
folder	string
muteConfig	string

Returns
Type	Description
string	{string} Resource name string.

folderNotificationConfigPath(folder, notificationConfig)

folderNotificationConfigPath(folder: string, notificationConfig: string): string;

Return a fully-qualified folderNotificationConfig resource name string.

Parameters
Name	Description
folder	string
notificationConfig	string

Returns
Type	Description
string	{string} Resource name string.

folderSecurityHealthAnalyticsSettingsCustomModulePath(folder, customModule)

folderSecurityHealthAnalyticsSettingsCustomModulePath(folder: string, customModule: string): string;

Return a fully-qualified folderSecurityHealthAnalyticsSettingsCustomModule resource name string.

Parameters
Name	Description
folder	string
customModule	string

Returns
Type	Description
string	{string} Resource name string.

folderSecurityHealthAnalyticsSettingsEffectiveCustomModulePath(folder, effectiveCustomModule)

folderSecurityHealthAnalyticsSettingsEffectiveCustomModulePath(folder: string, effectiveCustomModule: string): string;

Return a fully-qualified folderSecurityHealthAnalyticsSettingsEffectiveCustomModule resource name string.

Parameters
Name	Description
folder	string
effectiveCustomModule	string

Returns
Type	Description
string	{string} Resource name string.

folderSourceFindingExternalsystemPath(folder, source, finding, externalsystem)

folderSourceFindingExternalsystemPath(folder: string, source: string, finding: string, externalsystem: string): string;

Return a fully-qualified folderSourceFindingExternalsystem resource name string.

Parameters
Name	Description
folder	string
source	string
finding	string
externalsystem	string

Returns
Type	Description
string	{string} Resource name string.

folderSourceFindingPath(folder, source, finding)

folderSourceFindingPath(folder: string, source: string, finding: string): string;

Return a fully-qualified folderSourceFinding resource name string.

Parameters
Name	Description
folder	string
source	string
finding	string

Returns
Type	Description
string	{string} Resource name string.

folderSourceFindingSecurityMarksPath(folder, source, finding)

folderSourceFindingSecurityMarksPath(folder: string, source: string, finding: string): string;

Return a fully-qualified folderSourceFindingSecurityMarks resource name string.

Parameters
Name	Description
folder	string
source	string
finding	string

Returns
Type	Description
string	{string} Resource name string.

folderSourcePath(folder, source)

folderSourcePath(folder: string, source: string): string;

Return a fully-qualified folderSource resource name string.

Parameters
Name	Description
folder	string
source	string

Returns
Type	Description
string	{string} Resource name string.

getBigQueryExport(request, options)

getBigQueryExport(request?: protos.google.cloud.securitycenter.v1.IGetBigQueryExportRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IBigQueryExport,
        (protos.google.cloud.securitycenter.v1.IGetBigQueryExportRequest | undefined),
        {} | undefined
    ]>;

Gets a BigQuery export.

Parameters
Name	Description
request	IGetBigQueryExportRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IBigQueryExport, (protos.google.cloud.securitycenter.v1.IGetBigQueryExportRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing BigQueryExport. 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. Name of the BigQuery export to retrieve. Its format is
   *  `organizations/{organization}/bigQueryExports/{export_id}`,
   *  `folders/{folder}/bigQueryExports/{export_id}`, or
   *  `projects/{project}/bigQueryExports/{export_id}`
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getBigQueryExport(request);
    console.log(response);
  }

  callGetBigQueryExport();

getBigQueryExport(request, options, callback)

getBigQueryExport(request: protos.google.cloud.securitycenter.v1.IGetBigQueryExportRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.IGetBigQueryExportRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetBigQueryExportRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.IGetBigQueryExportRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getBigQueryExport(request, callback)

getBigQueryExport(request: protos.google.cloud.securitycenter.v1.IGetBigQueryExportRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.IGetBigQueryExportRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetBigQueryExportRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.IGetBigQueryExportRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getEffectiveEventThreatDetectionCustomModule(request, options)

getEffectiveEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycenter.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule,
        (protos.google.cloud.securitycenter.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Gets an effective Event Threat Detection custom module at the given level.

Parameters
Name	Description
request	IGetEffectiveEventThreatDetectionCustomModuleRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule, (protos.google.cloud.securitycenter.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 resource name of the effective Event Threat Detection custom
   *  module.
   *  Its format is:
   *    * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.
   *    * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.
   *    * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getEffectiveEventThreatDetectionCustomModule(request);
    console.log(response);
  }

  callGetEffectiveEventThreatDetectionCustomModule();

getEffectiveEventThreatDetectionCustomModule(request, options, callback)

getEffectiveEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetEffectiveEventThreatDetectionCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getEffectiveEventThreatDetectionCustomModule(request, callback)

getEffectiveEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetEffectiveEventThreatDetectionCustomModuleRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getEffectiveSecurityHealthAnalyticsCustomModule(request, options)

getEffectiveSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycenter.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule,
        (protos.google.cloud.securitycenter.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.

Parameters
Name	Description
request	IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule, (protos.google.cloud.securitycenter.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Name of the effective custom module to get. Its format is
   *  `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`,
   *  `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`,
   *  or
   *  `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getEffectiveSecurityHealthAnalyticsCustomModule(request);
    console.log(response);
  }

  callGetEffectiveSecurityHealthAnalyticsCustomModule();

getEffectiveSecurityHealthAnalyticsCustomModule(request, options, callback)

getEffectiveSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getEffectiveSecurityHealthAnalyticsCustomModule(request, callback)

getEffectiveSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getEventThreatDetectionCustomModule(request, options)

getEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycenter.v1.IGetEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule,
        (protos.google.cloud.securitycenter.v1.IGetEventThreatDetectionCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Gets an Event Threat Detection custom module.

Parameters
Name	Description
request	IGetEventThreatDetectionCustomModuleRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, (protos.google.cloud.securitycenter.v1.IGetEventThreatDetectionCustomModuleRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Name of the custom module to get.
   *  Its format is:
   *  * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`.
   *  * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`.
   *  * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getEventThreatDetectionCustomModule(request);
    console.log(response);
  }

  callGetEventThreatDetectionCustomModule();

getEventThreatDetectionCustomModule(request, options, callback)

getEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.IGetEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IGetEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetEventThreatDetectionCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IGetEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getEventThreatDetectionCustomModule(request, callback)

getEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.IGetEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IGetEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetEventThreatDetectionCustomModuleRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IGetEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.IGetIamPolicyRequest | undefined,
        {} | undefined
    ]>;

Gets the access control policy on the specified Source.

Parameters
Name	Description
request	IGetIamPolicyRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. 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 resource for which the policy is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  OPTIONAL: A `GetPolicyOptions` object for specifying options to
   *  `GetIamPolicy`.
   */
  // const options = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callGetIamPolicy() {
    // Construct request
    const request = {
      resource,
    };

    // Run request
    const response = await securitycenterClient.getIamPolicy(request);
    console.log(response);
  }

  callGetIamPolicy();

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetIamPolicyRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetIamPolicyRequest
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getMuteConfig(request, options)

getMuteConfig(request?: protos.google.cloud.securitycenter.v1.IGetMuteConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IMuteConfig,
        protos.google.cloud.securitycenter.v1.IGetMuteConfigRequest | undefined,
        {} | undefined
    ]>;

Gets a mute config.

Parameters
Name	Description
request	IGetMuteConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.IGetMuteConfigRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Name of the mute config to retrieve. Its format is
   *  `organizations/{organization}/muteConfigs/{config_id}`,
   *  `folders/{folder}/muteConfigs/{config_id}`,
   *  `projects/{project}/muteConfigs/{config_id}`,
   *  `organizations/{organization}/locations/global/muteConfigs/{config_id}`,
   *  `folders/{folder}/locations/global/muteConfigs/{config_id}`, or
   *  `projects/{project}/locations/global/muteConfigs/{config_id}`.
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getMuteConfig(request);
    console.log(response);
  }

  callGetMuteConfig();

getMuteConfig(request, options, callback)

getMuteConfig(request: protos.google.cloud.securitycenter.v1.IGetMuteConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.IGetMuteConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetMuteConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.IGetMuteConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getMuteConfig(request, callback)

getMuteConfig(request: protos.google.cloud.securitycenter.v1.IGetMuteConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.IGetMuteConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetMuteConfigRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.IGetMuteConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getNotificationConfig(request, options)

getNotificationConfig(request?: protos.google.cloud.securitycenter.v1.IGetNotificationConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.INotificationConfig,
        (protos.google.cloud.securitycenter.v1.IGetNotificationConfigRequest | undefined),
        {} | undefined
    ]>;

Gets a notification config.

Parameters
Name	Description
request	IGetNotificationConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.INotificationConfig, (protos.google.cloud.securitycenter.v1.IGetNotificationConfigRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Name of the notification config to get. Its format is
   *  `organizations/[organization_id]/notificationConfigs/[config_id]`,
   *  `folders/[folder_id]/notificationConfigs/[config_id]`,
   *  or `projects/[project_id]/notificationConfigs/[config_id]`.
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getNotificationConfig(request);
    console.log(response);
  }

  callGetNotificationConfig();

getNotificationConfig(request, options, callback)

getNotificationConfig(request: protos.google.cloud.securitycenter.v1.IGetNotificationConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.IGetNotificationConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetNotificationConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.IGetNotificationConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getNotificationConfig(request, callback)

getNotificationConfig(request: protos.google.cloud.securitycenter.v1.IGetNotificationConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.IGetNotificationConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetNotificationConfigRequest
callback	Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.IGetNotificationConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
request	GetOperationRequest The request object that will be sent.
options	CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<[protos.google.longrunning.Operation]>

Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getOrganizationSettings(request, options)

getOrganizationSettings(request?: protos.google.cloud.securitycenter.v1.IGetOrganizationSettingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IOrganizationSettings,
        (protos.google.cloud.securitycenter.v1.IGetOrganizationSettingsRequest | undefined),
        {} | undefined
    ]>;

Gets the settings for an organization.

Parameters
Name	Description
request	IGetOrganizationSettingsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IOrganizationSettings, (protos.google.cloud.securitycenter.v1.IGetOrganizationSettingsRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Name of the organization to get organization settings for. Its
   *  format is `organizations/[organization_id]/organizationSettings`.
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getOrganizationSettings(request);
    console.log(response);
  }

  callGetOrganizationSettings();

getOrganizationSettings(request, options, callback)

getOrganizationSettings(request: protos.google.cloud.securitycenter.v1.IGetOrganizationSettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IOrganizationSettings, protos.google.cloud.securitycenter.v1.IGetOrganizationSettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetOrganizationSettingsRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IOrganizationSettings, protos.google.cloud.securitycenter.v1.IGetOrganizationSettingsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getOrganizationSettings(request, callback)

getOrganizationSettings(request: protos.google.cloud.securitycenter.v1.IGetOrganizationSettingsRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IOrganizationSettings, protos.google.cloud.securitycenter.v1.IGetOrganizationSettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetOrganizationSettingsRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IOrganizationSettings, protos.google.cloud.securitycenter.v1.IGetOrganizationSettingsRequest | 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

getResourceValueConfig(request, options)

getResourceValueConfig(request?: protos.google.cloud.securitycenter.v1.IGetResourceValueConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IResourceValueConfig,
        (protos.google.cloud.securitycenter.v1.IGetResourceValueConfigRequest | undefined),
        {} | undefined
    ]>;

Gets a ResourceValueConfig.

Parameters
Name	Description
request	IGetResourceValueConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IResourceValueConfig, (protos.google.cloud.securitycenter.v1.IGetResourceValueConfigRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Name of the resource value config to retrieve. Its format is
   *  `organizations/{organization}/resourceValueConfigs/{config_id}`.
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getResourceValueConfig(request);
    console.log(response);
  }

  callGetResourceValueConfig();

getResourceValueConfig(request, options, callback)

getResourceValueConfig(request: protos.google.cloud.securitycenter.v1.IGetResourceValueConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IResourceValueConfig, protos.google.cloud.securitycenter.v1.IGetResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetResourceValueConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IResourceValueConfig, protos.google.cloud.securitycenter.v1.IGetResourceValueConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getResourceValueConfig(request, callback)

getResourceValueConfig(request: protos.google.cloud.securitycenter.v1.IGetResourceValueConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IResourceValueConfig, protos.google.cloud.securitycenter.v1.IGetResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetResourceValueConfigRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IResourceValueConfig, protos.google.cloud.securitycenter.v1.IGetResourceValueConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getSecurityHealthAnalyticsCustomModule(request, options)

getSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycenter.v1.IGetSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule,
        (protos.google.cloud.securitycenter.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Retrieves a SecurityHealthAnalyticsCustomModule.

Parameters
Name	Description
request	IGetSecurityHealthAnalyticsCustomModuleRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, (protos.google.cloud.securitycenter.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Name of the custom module to get. Its format is
   *  `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`,
   *  `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`,
   *  or
   *  `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getSecurityHealthAnalyticsCustomModule(request);
    console.log(response);
  }

  callGetSecurityHealthAnalyticsCustomModule();

getSecurityHealthAnalyticsCustomModule(request, options, callback)

getSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.IGetSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetSecurityHealthAnalyticsCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getSecurityHealthAnalyticsCustomModule(request, callback)

getSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.IGetSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetSecurityHealthAnalyticsCustomModuleRequest
callback	Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getSimulation(request, options)

getSimulation(request?: protos.google.cloud.securitycenter.v1.IGetSimulationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISimulation,
        protos.google.cloud.securitycenter.v1.IGetSimulationRequest | undefined,
        {} | undefined
    ]>;

Get the simulation by name or the latest simulation for the given organization.

Parameters
Name	Description
request	IGetSimulationRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISimulation, protos.google.cloud.securitycenter.v1.IGetSimulationRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Simulation. 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 organization name or simulation name of this simulation
   *  Valid format:
   *  `organizations/{organization}/simulations/latest`
   *  `organizations/{organization}/simulations/{simulation}`
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getSimulation(request);
    console.log(response);
  }

  callGetSimulation();

getSimulation(request, options, callback)

getSimulation(request: protos.google.cloud.securitycenter.v1.IGetSimulationRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.ISimulation, protos.google.cloud.securitycenter.v1.IGetSimulationRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetSimulationRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.ISimulation, protos.google.cloud.securitycenter.v1.IGetSimulationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getSimulation(request, callback)

getSimulation(request: protos.google.cloud.securitycenter.v1.IGetSimulationRequest, callback: Callback<protos.google.cloud.securitycenter.v1.ISimulation, protos.google.cloud.securitycenter.v1.IGetSimulationRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetSimulationRequest
callback	Callback<protos.google.cloud.securitycenter.v1.ISimulation, protos.google.cloud.securitycenter.v1.IGetSimulationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getSource(request, options)

getSource(request?: protos.google.cloud.securitycenter.v1.IGetSourceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISource,
        protos.google.cloud.securitycenter.v1.IGetSourceRequest | undefined,
        {} | undefined
    ]>;

Gets a source.

Parameters
Name	Description
request	IGetSourceRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.IGetSourceRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Source. 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. Relative resource name of the source. Its format is
   *  `organizations/[organization_id]/source/[source_id]`.
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getSource(request);
    console.log(response);
  }

  callGetSource();

getSource(request, options, callback)

getSource(request: protos.google.cloud.securitycenter.v1.IGetSourceRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.IGetSourceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetSourceRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.IGetSourceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getSource(request, callback)

getSource(request: protos.google.cloud.securitycenter.v1.IGetSourceRequest, callback: Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.IGetSourceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetSourceRequest
callback	Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.IGetSourceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getValuedResource(request, options)

getValuedResource(request?: protos.google.cloud.securitycenter.v1.IGetValuedResourceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IValuedResource,
        (protos.google.cloud.securitycenter.v1.IGetValuedResourceRequest | undefined),
        {} | undefined
    ]>;

Get the valued resource by name

Parameters
Name	Description
request	IGetValuedResourceRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IValuedResource, (protos.google.cloud.securitycenter.v1.IGetValuedResourceRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 name of this valued resource
   *  Valid format:
   *  `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`
   */
  // const name = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.getValuedResource(request);
    console.log(response);
  }

  callGetValuedResource();

getValuedResource(request, options, callback)

getValuedResource(request: protos.google.cloud.securitycenter.v1.IGetValuedResourceRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IValuedResource, protos.google.cloud.securitycenter.v1.IGetValuedResourceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetValuedResourceRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IValuedResource, protos.google.cloud.securitycenter.v1.IGetValuedResourceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getValuedResource(request, callback)

getValuedResource(request: protos.google.cloud.securitycenter.v1.IGetValuedResourceRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IValuedResource, protos.google.cloud.securitycenter.v1.IGetValuedResourceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetValuedResourceRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IValuedResource, protos.google.cloud.securitycenter.v1.IGetValuedResourceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

groupAssets(request, options)

groupAssets(request?: protos.google.cloud.securitycenter.v1.IGroupAssetsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IGroupResult[],
        protos.google.cloud.securitycenter.v1.IGroupAssetsRequest | null,
        protos.google.cloud.securitycenter.v1.IGroupAssetsResponse
    ]>;

Filters an organization's assets and groups them by their specified properties.

Parameters
Name	Description
request	IGroupAssetsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IGroupResult[], protos.google.cloud.securitycenter.v1.IGroupAssetsRequest | null, protos.google.cloud.securitycenter.v1.IGroupAssetsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of GroupResult. 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 groupAssetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

groupAssets(request, options, callback)

groupAssets(request: protos.google.cloud.securitycenter.v1.IGroupAssetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IGroupAssetsRequest, protos.google.cloud.securitycenter.v1.IGroupAssetsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IGroupResult>): void;

Parameters
Name	Description
request	IGroupAssetsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IGroupAssetsRequest, protos.google.cloud.securitycenter.v1.IGroupAssetsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IGroupResult>

Returns
Type	Description
void

groupAssets(request, callback)

groupAssets(request: protos.google.cloud.securitycenter.v1.IGroupAssetsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IGroupAssetsRequest, protos.google.cloud.securitycenter.v1.IGroupAssetsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IGroupResult>): void;

Parameters
Name	Description
request	IGroupAssetsRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IGroupAssetsRequest, protos.google.cloud.securitycenter.v1.IGroupAssetsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IGroupResult>

Returns
Type	Description
void

groupAssetsAsync(request, options)

groupAssetsAsync(request?: protos.google.cloud.securitycenter.v1.IGroupAssetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IGroupResult>;

Equivalent to groupAssets, but returns an iterable object.

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

Parameters
Name	Description
request	IGroupAssetsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IGroupResult>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing GroupResult. 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 name of the parent to group the assets by. Its format is
   *  `organizations/[organization_id]`, `folders/[folder_id]`, or
   *  `projects/[project_id]`.
   */
  // const parent = 'abc123'
  /**
   *  Expression that defines the filter to apply across assets.
   *  The expression is a list of zero or more restrictions combined via logical
   *  operators `AND` and `OR`.
   *  Parentheses are supported, and `OR` has higher precedence than `AND`.
   *  Restrictions have the form `

groupAssetsStream(request, options)

groupAssetsStream(request?: protos.google.cloud.securitycenter.v1.IGroupAssetsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IGroupAssetsRequest 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 GroupResult 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 groupAssetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

groupFindings(request, options)

groupFindings(request?: protos.google.cloud.securitycenter.v1.IGroupFindingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IGroupResult[],
        protos.google.cloud.securitycenter.v1.IGroupFindingsRequest | null,
        protos.google.cloud.securitycenter.v1.IGroupFindingsResponse
    ]>;

Filters an organization or source's findings and groups them by their specified properties.

To group across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings

Parameters
Name	Description
request	IGroupFindingsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IGroupResult[], protos.google.cloud.securitycenter.v1.IGroupFindingsRequest | null, protos.google.cloud.securitycenter.v1.IGroupFindingsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of GroupResult. 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 groupFindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

groupFindings(request, options, callback)

groupFindings(request: protos.google.cloud.securitycenter.v1.IGroupFindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IGroupFindingsRequest, protos.google.cloud.securitycenter.v1.IGroupFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IGroupResult>): void;

Parameters
Name	Description
request	IGroupFindingsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IGroupFindingsRequest, protos.google.cloud.securitycenter.v1.IGroupFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IGroupResult>

Returns
Type	Description
void

groupFindings(request, callback)

groupFindings(request: protos.google.cloud.securitycenter.v1.IGroupFindingsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IGroupFindingsRequest, protos.google.cloud.securitycenter.v1.IGroupFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IGroupResult>): void;

Parameters
Name	Description
request	IGroupFindingsRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IGroupFindingsRequest, protos.google.cloud.securitycenter.v1.IGroupFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IGroupResult>

Returns
Type	Description
void

groupFindingsAsync(request, options)

groupFindingsAsync(request?: protos.google.cloud.securitycenter.v1.IGroupFindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IGroupResult>;

Equivalent to groupFindings, but returns an iterable object.

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

Parameters
Name	Description
request	IGroupFindingsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IGroupResult>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing GroupResult. 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. Name of the source to groupBy. Its format is
   *  `organizations/[organization_id]/sources/[source_id]`,
   *  `folders/[folder_id]/sources/[source_id]`, or
   *  `projects/[project_id]/sources/[source_id]`. To groupBy across all sources
   *  provide a source_id of `-`. For example:
   *  `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`,
   *  or `projects/{project_id}/sources/-`
   */
  // const parent = 'abc123'
  /**
   *  Expression that defines the filter to apply across findings.
   *  The expression is a list of one or more restrictions combined via logical
   *  operators `AND` and `OR`.
   *  Parentheses are supported, and `OR` has higher precedence than `AND`.
   *  Restrictions have the form `

groupFindingsStream(request, options)

groupFindingsStream(request?: protos.google.cloud.securitycenter.v1.IGroupFindingsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IGroupFindingsRequest 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 GroupResult 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 groupFindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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.

listAssets(request, options)

listAssets(request?: protos.google.cloud.securitycenter.v1.IListAssetsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ListAssetsResponse.IListAssetsResult[],
        protos.google.cloud.securitycenter.v1.IListAssetsRequest | null,
        protos.google.cloud.securitycenter.v1.IListAssetsResponse
    ]>;

Lists an organization's assets.

Parameters
Name	Description
request	IListAssetsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ListAssetsResponse.IListAssetsResult[], protos.google.cloud.securitycenter.v1.IListAssetsRequest | null, protos.google.cloud.securitycenter.v1.IListAssetsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listAssetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAssets(request, options, callback)

listAssets(request: protos.google.cloud.securitycenter.v1.IListAssetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListAssetsRequest, protos.google.cloud.securitycenter.v1.IListAssetsResponse | null | undefined, protos.google.cloud.securitycenter.v1.ListAssetsResponse.IListAssetsResult>): void;

Parameters
Name	Description
request	IListAssetsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListAssetsRequest, protos.google.cloud.securitycenter.v1.IListAssetsResponse | null | undefined, protos.google.cloud.securitycenter.v1.ListAssetsResponse.IListAssetsResult>

Returns
Type	Description
void

listAssets(request, callback)

listAssets(request: protos.google.cloud.securitycenter.v1.IListAssetsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListAssetsRequest, protos.google.cloud.securitycenter.v1.IListAssetsResponse | null | undefined, protos.google.cloud.securitycenter.v1.ListAssetsResponse.IListAssetsResult>): void;

Parameters
Name	Description
request	IListAssetsRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListAssetsRequest, protos.google.cloud.securitycenter.v1.IListAssetsResponse | null | undefined, protos.google.cloud.securitycenter.v1.ListAssetsResponse.IListAssetsResult>

Returns
Type	Description
void

listAssetsAsync(request, options)

listAssetsAsync(request?: protos.google.cloud.securitycenter.v1.IListAssetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.ListAssetsResponse.IListAssetsResult>;

Equivalent to listAssets, but returns an iterable object.

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

Parameters
Name	Description
request	IListAssetsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.ListAssetsResponse.IListAssetsResult>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 name of the parent resource that contains the assets. The
   *  value that you can specify on parent depends on the method in which you
   *  specify parent. You can specify one of the following values:
   *  `organizations/[organization_id]`, `folders/[folder_id]`, or
   *  `projects/[project_id]`.
   */
  // const parent = 'abc123'
  /**
   *  Expression that defines the filter to apply across assets.
   *  The expression is a list of zero or more restrictions combined via logical
   *  operators `AND` and `OR`.
   *  Parentheses are supported, and `OR` has higher precedence than `AND`.
   *  Restrictions have the form `

listAssetsStream(request, options)

listAssetsStream(request?: protos.google.cloud.securitycenter.v1.IListAssetsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListAssetsRequest 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 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 listAssetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAttackPaths(request, options)

listAttackPaths(request?: protos.google.cloud.securitycenter.v1.IListAttackPathsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IAttackPath[],
        protos.google.cloud.securitycenter.v1.IListAttackPathsRequest | null,
        protos.google.cloud.securitycenter.v1.IListAttackPathsResponse
    ]>;

Lists the attack paths for a set of simulation results or valued resources and filter.

Parameters
Name	Description
request	IListAttackPathsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IAttackPath[], protos.google.cloud.securitycenter.v1.IListAttackPathsRequest | null, protos.google.cloud.securitycenter.v1.IListAttackPathsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listAttackPathsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAttackPaths(request, options, callback)

listAttackPaths(request: protos.google.cloud.securitycenter.v1.IListAttackPathsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListAttackPathsRequest, protos.google.cloud.securitycenter.v1.IListAttackPathsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IAttackPath>): void;

Parameters
Name	Description
request	IListAttackPathsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListAttackPathsRequest, protos.google.cloud.securitycenter.v1.IListAttackPathsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IAttackPath>

Returns
Type	Description
void

listAttackPaths(request, callback)

listAttackPaths(request: protos.google.cloud.securitycenter.v1.IListAttackPathsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListAttackPathsRequest, protos.google.cloud.securitycenter.v1.IListAttackPathsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IAttackPath>): void;

Parameters
Name	Description
request	IListAttackPathsRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListAttackPathsRequest, protos.google.cloud.securitycenter.v1.IListAttackPathsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IAttackPath>

Returns
Type	Description
void

listAttackPathsAsync(request, options)

listAttackPathsAsync(request?: protos.google.cloud.securitycenter.v1.IListAttackPathsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IAttackPath>;

Equivalent to listAttackPaths, but returns an iterable object.

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

Parameters
Name	Description
request	IListAttackPathsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IAttackPath>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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. Name of parent to list attack paths.
   *  Valid formats:
   *  `organizations/{organization}`,
   *  `organizations/{organization}/simulations/{simulation}`
   *  `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}`
   *  `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`
   */
  // const parent = 'abc123'
  /**
   *  The filter expression that filters the attack path in the response.
   *  Supported fields:
   *    * `valued_resources` supports =
   */
  // const filter = 'abc123'
  /**
   *  The value returned by the last `ListAttackPathsResponse`; indicates
   *  that this is a continuation of a prior `ListAttackPaths` call, and
   *  that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListAttackPaths();

listAttackPathsStream(request, options)

listAttackPathsStream(request?: protos.google.cloud.securitycenter.v1.IListAttackPathsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListAttackPathsRequest 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 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 listAttackPathsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBigQueryExports(request, options)

listBigQueryExports(request?: protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IBigQueryExport[],
        protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest | null,
        protos.google.cloud.securitycenter.v1.IListBigQueryExportsResponse
    ]>;

Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.

Parameters
Name	Description
request	IListBigQueryExportsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IBigQueryExport[], protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest | null, protos.google.cloud.securitycenter.v1.IListBigQueryExportsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of BigQueryExport. 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 listBigQueryExportsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBigQueryExports(request, options, callback)

listBigQueryExports(request: protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest, protos.google.cloud.securitycenter.v1.IListBigQueryExportsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IBigQueryExport>): void;

Parameters
Name	Description
request	IListBigQueryExportsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest, protos.google.cloud.securitycenter.v1.IListBigQueryExportsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IBigQueryExport>

Returns
Type	Description
void

listBigQueryExports(request, callback)

listBigQueryExports(request: protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest, protos.google.cloud.securitycenter.v1.IListBigQueryExportsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IBigQueryExport>): void;

Parameters
Name	Description
request	IListBigQueryExportsRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest, protos.google.cloud.securitycenter.v1.IListBigQueryExportsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IBigQueryExport>

Returns
Type	Description
void

listBigQueryExportsAsync(request, options)

listBigQueryExportsAsync(request?: protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IBigQueryExport>;

Equivalent to listBigQueryExports, but returns an iterable object.

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

Parameters
Name	Description
request	IListBigQueryExportsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IBigQueryExport>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing BigQueryExport. 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, which owns the collection of BigQuery exports. Its
   *  format is `organizations/[organization_id]`, `folders/[folder_id]`,
   *  `projects/[project_id]`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of configs to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 10 configs 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 `ListBigQueryExports` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListBigQueryExports`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListBigQueryExports();

listBigQueryExportsStream(request, options)

listBigQueryExportsStream(request?: protos.google.cloud.securitycenter.v1.IListBigQueryExportsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListBigQueryExportsRequest 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 BigQueryExport 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 listBigQueryExportsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDescendantEventThreatDetectionCustomModules(request, options)

listDescendantEventThreatDetectionCustomModules(request?: protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule[],
        protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest | null,
        protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesResponse
    ]>;

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

Parameters
Name	Description
request	IListDescendantEventThreatDetectionCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule[], protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest | null, protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listDescendantEventThreatDetectionCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDescendantEventThreatDetectionCustomModules(request, options, callback)

listDescendantEventThreatDetectionCustomModules(request: protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>): void;

Parameters
Name	Description
request	IListDescendantEventThreatDetectionCustomModulesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>

Returns
Type	Description
void

listDescendantEventThreatDetectionCustomModules(request, callback)

listDescendantEventThreatDetectionCustomModules(request: protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>): void;

Parameters
Name	Description
request	IListDescendantEventThreatDetectionCustomModulesRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>

Returns
Type	Description
void

listDescendantEventThreatDetectionCustomModulesAsync(request, options)

listDescendantEventThreatDetectionCustomModulesAsync(request?: protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>;

Equivalent to listDescendantEventThreatDetectionCustomModules, but returns an iterable object.

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

Parameters
Name	Description
request	IListDescendantEventThreatDetectionCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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. Name of the parent to list custom modules under.
   *  Its format is:
   *    * `organizations/{organization}/eventThreatDetectionSettings`.
   *    * `folders/{folder}/eventThreatDetectionSettings`.
   *    * `projects/{project}/eventThreatDetectionSettings`.
   */
  // const parent = 'abc123'
  /**
   *  A page token, received from a previous
   *  `ListDescendantEventThreatDetectionCustomModules` call. Provide this to
   *  retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListDescendantEventThreatDetectionCustomModules` must match the call that
   *  provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of modules to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 10 configs will be returned.
   *  The maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListDescendantEventThreatDetectionCustomModules();

listDescendantEventThreatDetectionCustomModulesStream(request, options)

listDescendantEventThreatDetectionCustomModulesStream(request?: protos.google.cloud.securitycenter.v1.IListDescendantEventThreatDetectionCustomModulesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListDescendantEventThreatDetectionCustomModulesRequest 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 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 listDescendantEventThreatDetectionCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDescendantSecurityHealthAnalyticsCustomModules(request, options)

listDescendantSecurityHealthAnalyticsCustomModules(request?: protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule[],
        protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest | null,
        protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse
    ]>;

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

Parameters
Name	Description
request	IListDescendantSecurityHealthAnalyticsCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule[], protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest | null, protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listDescendantSecurityHealthAnalyticsCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDescendantSecurityHealthAnalyticsCustomModules(request, options, callback)

listDescendantSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>): void;

Parameters
Name	Description
request	IListDescendantSecurityHealthAnalyticsCustomModulesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>

Returns
Type	Description
void

listDescendantSecurityHealthAnalyticsCustomModules(request, callback)

listDescendantSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>): void;

Parameters
Name	Description
request	IListDescendantSecurityHealthAnalyticsCustomModulesRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>

Returns
Type	Description
void

listDescendantSecurityHealthAnalyticsCustomModulesAsync(request, options)

listDescendantSecurityHealthAnalyticsCustomModulesAsync(request?: protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>;

Equivalent to listDescendantSecurityHealthAnalyticsCustomModules, but returns an iterable object.

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

Parameters
Name	Description
request	IListDescendantSecurityHealthAnalyticsCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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. Name of parent to list descendant custom modules. Its format is
   *  `organizations/{organization}/securityHealthAnalyticsSettings`,
   *  `folders/{folder}/securityHealthAnalyticsSettings`, or
   *  `projects/{project}/securityHealthAnalyticsSettings`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last call indicating a continuation
   */
  // const pageToken = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListDescendantSecurityHealthAnalyticsCustomModules();

listDescendantSecurityHealthAnalyticsCustomModulesStream(request, options)

listDescendantSecurityHealthAnalyticsCustomModulesStream(request?: protos.google.cloud.securitycenter.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListDescendantSecurityHealthAnalyticsCustomModulesRequest 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 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 listDescendantSecurityHealthAnalyticsCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEffectiveEventThreatDetectionCustomModules(request, options)

listEffectiveEventThreatDetectionCustomModules(request?: protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule[],
        protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest | null,
        protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesResponse
    ]>;

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

Parameters
Name	Description
request	IListEffectiveEventThreatDetectionCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule[], protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest | null, protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listEffectiveEventThreatDetectionCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEffectiveEventThreatDetectionCustomModules(request, options, callback)

listEffectiveEventThreatDetectionCustomModules(request: protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule>): void;

Parameters
Name	Description
request	IListEffectiveEventThreatDetectionCustomModulesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule>

Returns
Type	Description
void

listEffectiveEventThreatDetectionCustomModules(request, callback)

listEffectiveEventThreatDetectionCustomModules(request: protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule>): void;

Parameters
Name	Description
request	IListEffectiveEventThreatDetectionCustomModulesRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule>

Returns
Type	Description
void

listEffectiveEventThreatDetectionCustomModulesAsync(request, options)

listEffectiveEventThreatDetectionCustomModulesAsync(request?: protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule>;

Equivalent to listEffectiveEventThreatDetectionCustomModules, but returns an iterable object.

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

Parameters
Name	Description
request	IListEffectiveEventThreatDetectionCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IEffectiveEventThreatDetectionCustomModule>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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. Name of the parent to list custom modules for.
   *  Its format is:
   *    * `organizations/{organization}/eventThreatDetectionSettings`.
   *    * `folders/{folder}/eventThreatDetectionSettings`.
   *    * `projects/{project}/eventThreatDetectionSettings`.
   */
  // const parent = 'abc123'
  /**
   *  A page token, received from a previous
   *  `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to
   *  retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListEffectiveEventThreatDetectionCustomModules` must match the call that
   *  provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of modules to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 10 configs will be returned.
   *  The maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListEffectiveEventThreatDetectionCustomModules();

listEffectiveEventThreatDetectionCustomModulesStream(request, options)

listEffectiveEventThreatDetectionCustomModulesStream(request?: protos.google.cloud.securitycenter.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListEffectiveEventThreatDetectionCustomModulesRequest 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 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 listEffectiveEventThreatDetectionCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEffectiveSecurityHealthAnalyticsCustomModules(request, options)

listEffectiveSecurityHealthAnalyticsCustomModules(request?: protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule[],
        protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest | null,
        protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse
    ]>;

Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

Parameters
Name	Description
request	IListEffectiveSecurityHealthAnalyticsCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule[], protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest | null, protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listEffectiveSecurityHealthAnalyticsCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEffectiveSecurityHealthAnalyticsCustomModules(request, options, callback)

listEffectiveSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule>): void;

Parameters
Name	Description
request	IListEffectiveSecurityHealthAnalyticsCustomModulesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule>

Returns
Type	Description
void

listEffectiveSecurityHealthAnalyticsCustomModules(request, callback)

listEffectiveSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule>): void;

Parameters
Name	Description
request	IListEffectiveSecurityHealthAnalyticsCustomModulesRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule>

Returns
Type	Description
void

listEffectiveSecurityHealthAnalyticsCustomModulesAsync(request, options)

listEffectiveSecurityHealthAnalyticsCustomModulesAsync(request?: protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule>;

Equivalent to listEffectiveSecurityHealthAnalyticsCustomModules, but returns an iterable object.

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

Parameters
Name	Description
request	IListEffectiveSecurityHealthAnalyticsCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IEffectiveSecurityHealthAnalyticsCustomModule>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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. Name of parent to list effective custom modules. Its format is
   *  `organizations/{organization}/securityHealthAnalyticsSettings`,
   *  `folders/{folder}/securityHealthAnalyticsSettings`, or
   *  `projects/{project}/securityHealthAnalyticsSettings`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last call indicating a continuation
   */
  // const pageToken = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListEffectiveSecurityHealthAnalyticsCustomModules();

listEffectiveSecurityHealthAnalyticsCustomModulesStream(request, options)

listEffectiveSecurityHealthAnalyticsCustomModulesStream(request?: protos.google.cloud.securitycenter.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListEffectiveSecurityHealthAnalyticsCustomModulesRequest 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 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 listEffectiveSecurityHealthAnalyticsCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEventThreatDetectionCustomModules(request, options)

listEventThreatDetectionCustomModules(request?: protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule[],
        protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest | null,
        protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesResponse
    ]>;

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

Parameters
Name	Description
request	IListEventThreatDetectionCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule[], protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest | null, protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listEventThreatDetectionCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEventThreatDetectionCustomModules(request, options, callback)

listEventThreatDetectionCustomModules(request: protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>): void;

Parameters
Name	Description
request	IListEventThreatDetectionCustomModulesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>

Returns
Type	Description
void

listEventThreatDetectionCustomModules(request, callback)

listEventThreatDetectionCustomModules(request: protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>): void;

Parameters
Name	Description
request	IListEventThreatDetectionCustomModulesRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>

Returns
Type	Description
void

listEventThreatDetectionCustomModulesAsync(request, options)

listEventThreatDetectionCustomModulesAsync(request?: protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>;

Equivalent to listEventThreatDetectionCustomModules, but returns an iterable object.

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

Parameters
Name	Description
request	IListEventThreatDetectionCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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. Name of the parent to list custom modules under.
   *  Its format is:
   *    * `organizations/{organization}/eventThreatDetectionSettings`.
   *    * `folders/{folder}/eventThreatDetectionSettings`.
   *    * `projects/{project}/eventThreatDetectionSettings`.
   */
  // const parent = 'abc123'
  /**
   *  A page token, received from a previous
   *  `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the
   *  subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListEventThreatDetectionCustomModules` must match the call that provided
   *  the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of modules to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 10 configs will be returned.
   *  The maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListEventThreatDetectionCustomModules();

listEventThreatDetectionCustomModulesStream(request, options)

listEventThreatDetectionCustomModulesStream(request?: protos.google.cloud.securitycenter.v1.IListEventThreatDetectionCustomModulesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListEventThreatDetectionCustomModulesRequest 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 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 listEventThreatDetectionCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFindings(request, options)

listFindings(request?: protos.google.cloud.securitycenter.v1.IListFindingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ListFindingsResponse.IListFindingsResult[],
        protos.google.cloud.securitycenter.v1.IListFindingsRequest | null,
        protos.google.cloud.securitycenter.v1.IListFindingsResponse
    ]>;

Lists an organization or source's findings.

To list across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings

Parameters
Name	Description
request	IListFindingsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ListFindingsResponse.IListFindingsResult[], protos.google.cloud.securitycenter.v1.IListFindingsRequest | null, protos.google.cloud.securitycenter.v1.IListFindingsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listFindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFindings(request, options, callback)

listFindings(request: protos.google.cloud.securitycenter.v1.IListFindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListFindingsRequest, protos.google.cloud.securitycenter.v1.IListFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v1.ListFindingsResponse.IListFindingsResult>): void;

Parameters
Name	Description
request	IListFindingsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListFindingsRequest, protos.google.cloud.securitycenter.v1.IListFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v1.ListFindingsResponse.IListFindingsResult>

Returns
Type	Description
void

listFindings(request, callback)

listFindings(request: protos.google.cloud.securitycenter.v1.IListFindingsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListFindingsRequest, protos.google.cloud.securitycenter.v1.IListFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v1.ListFindingsResponse.IListFindingsResult>): void;

Parameters
Name	Description
request	IListFindingsRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListFindingsRequest, protos.google.cloud.securitycenter.v1.IListFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v1.ListFindingsResponse.IListFindingsResult>

Returns
Type	Description
void

listFindingsAsync(request, options)

listFindingsAsync(request?: protos.google.cloud.securitycenter.v1.IListFindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.ListFindingsResponse.IListFindingsResult>;

Equivalent to listFindings, but returns an iterable object.

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

Parameters
Name	Description
request	IListFindingsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.ListFindingsResponse.IListFindingsResult>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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. Name of the source the findings belong to. Its format is
   *  `organizations/[organization_id]/sources/[source_id]`,
   *  `folders/[folder_id]/sources/[source_id]`, or
   *  `projects/[project_id]/sources/[source_id]`. To list across all sources
   *  provide a source_id of `-`. For example:
   *  `organizations/{organization_id}/sources/-`,
   *  `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`
   */
  // const parent = 'abc123'
  /**
   *  Expression that defines the filter to apply across findings.
   *  The expression is a list of one or more restrictions combined via logical
   *  operators `AND` and `OR`.
   *  Parentheses are supported, and `OR` has higher precedence than `AND`.
   *  Restrictions have the form `

listFindingsStream(request, options)

listFindingsStream(request?: protos.google.cloud.securitycenter.v1.IListFindingsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListFindingsRequest 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 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 listFindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMuteConfigs(request, options)

listMuteConfigs(request?: protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IMuteConfig[],
        protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest | null,
        protos.google.cloud.securitycenter.v1.IListMuteConfigsResponse
    ]>;

Lists mute configs.

Parameters
Name	Description
request	IListMuteConfigsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IMuteConfig[], protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest | null, protos.google.cloud.securitycenter.v1.IListMuteConfigsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listMuteConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMuteConfigs(request, options, callback)

listMuteConfigs(request: protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest, protos.google.cloud.securitycenter.v1.IListMuteConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IMuteConfig>): void;

Parameters
Name	Description
request	IListMuteConfigsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest, protos.google.cloud.securitycenter.v1.IListMuteConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IMuteConfig>

Returns
Type	Description
void

listMuteConfigs(request, callback)

listMuteConfigs(request: protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest, protos.google.cloud.securitycenter.v1.IListMuteConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IMuteConfig>): void;

Parameters
Name	Description
request	IListMuteConfigsRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest, protos.google.cloud.securitycenter.v1.IListMuteConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IMuteConfig>

Returns
Type	Description
void

listMuteConfigsAsync(request, options)

listMuteConfigsAsync(request?: protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IMuteConfig>;

Equivalent to listMuteConfigs, but returns an iterable object.

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

Parameters
Name	Description
request	IListMuteConfigsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IMuteConfig>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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, which owns the collection of mute configs. Its format
   *  is `organizations/[organization_id]`, `folders/[folder_id]`,
   *  `projects/[project_id]`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of configs to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 10 configs 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 `ListMuteConfigs` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListMuteConfigs` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListMuteConfigs();

listMuteConfigsStream(request, options)

listMuteConfigsStream(request?: protos.google.cloud.securitycenter.v1.IListMuteConfigsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListMuteConfigsRequest 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 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 listMuteConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNotificationConfigs(request, options)

listNotificationConfigs(request?: protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.INotificationConfig[],
        protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest | null,
        protos.google.cloud.securitycenter.v1.IListNotificationConfigsResponse
    ]>;

Lists notification configs.

Parameters
Name	Description
request	IListNotificationConfigsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.INotificationConfig[], protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest | null, protos.google.cloud.securitycenter.v1.IListNotificationConfigsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listNotificationConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNotificationConfigs(request, options, callback)

listNotificationConfigs(request: protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest, protos.google.cloud.securitycenter.v1.IListNotificationConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.INotificationConfig>): void;

Parameters
Name	Description
request	IListNotificationConfigsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest, protos.google.cloud.securitycenter.v1.IListNotificationConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.INotificationConfig>

Returns
Type	Description
void

listNotificationConfigs(request, callback)

listNotificationConfigs(request: protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest, protos.google.cloud.securitycenter.v1.IListNotificationConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.INotificationConfig>): void;

Parameters
Name	Description
request	IListNotificationConfigsRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest, protos.google.cloud.securitycenter.v1.IListNotificationConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.INotificationConfig>

Returns
Type	Description
void

listNotificationConfigsAsync(request, options)

listNotificationConfigsAsync(request?: protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.INotificationConfig>;

Equivalent to listNotificationConfigs, but returns an iterable object.

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

Parameters
Name	Description
request	IListNotificationConfigsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.INotificationConfig>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 name of the parent in which to list the notification
   *  configurations. Its format is "organizations/[organization_id]",
   *  "folders/[folder_id]", or "projects/[project_id]".
   */
  // const parent = 'abc123'
  /**
   *  The value returned by the last `ListNotificationConfigsResponse`; indicates
   *  that this is a continuation of a prior `ListNotificationConfigs` call, and
   *  that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListNotificationConfigs();

listNotificationConfigsStream(request, options)

listNotificationConfigsStream(request?: protos.google.cloud.securitycenter.v1.IListNotificationConfigsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListNotificationConfigsRequest 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 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 listNotificationConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name	Description
request	ListOperationsRequest The request object that will be sent.
options	CallOptions Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
AsyncIterable<protos.google.longrunning.ListOperationsResponse>	{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listResourceValueConfigs(request, options)

listResourceValueConfigs(request?: protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IResourceValueConfig[],
        protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest | null,
        protos.google.cloud.securitycenter.v1.IListResourceValueConfigsResponse
    ]>;

Lists all ResourceValueConfigs.

Parameters
Name	Description
request	IListResourceValueConfigsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IResourceValueConfig[], protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest | null, protos.google.cloud.securitycenter.v1.IListResourceValueConfigsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listResourceValueConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listResourceValueConfigs(request, options, callback)

listResourceValueConfigs(request: protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest, protos.google.cloud.securitycenter.v1.IListResourceValueConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IResourceValueConfig>): void;

Parameters
Name	Description
request	IListResourceValueConfigsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest, protos.google.cloud.securitycenter.v1.IListResourceValueConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IResourceValueConfig>

Returns
Type	Description
void

listResourceValueConfigs(request, callback)

listResourceValueConfigs(request: protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest, protos.google.cloud.securitycenter.v1.IListResourceValueConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IResourceValueConfig>): void;

Parameters
Name	Description
request	IListResourceValueConfigsRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest, protos.google.cloud.securitycenter.v1.IListResourceValueConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v1.IResourceValueConfig>

Returns
Type	Description
void

listResourceValueConfigsAsync(request, options)

listResourceValueConfigsAsync(request?: protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IResourceValueConfig>;

Equivalent to listResourceValueConfigs, but returns an iterable object.

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

Parameters
Name	Description
request	IListResourceValueConfigsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IResourceValueConfig>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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, which owns the collection of resource value configs.
   *  Its format is
   *  `organizations/[organization_id]`
   */
  // const parent = 'abc123'
  /**
   *  The number of results to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 10 configs 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 `ListResourceValueConfigs` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListResourceValueConfigs` must match the call that provided the
   *  page token.
   *  page_size can be specified, and the new page_size will be used.
   */
  // const pageToken = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListResourceValueConfigs();

listResourceValueConfigsStream(request, options)

listResourceValueConfigsStream(request?: protos.google.cloud.securitycenter.v1.IListResourceValueConfigsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListResourceValueConfigsRequest 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 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 listResourceValueConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSecurityHealthAnalyticsCustomModules(request, options)

listSecurityHealthAnalyticsCustomModules(request?: protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule[],
        protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest | null,
        protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesResponse
    ]>;

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

Parameters
Name	Description
request	IListSecurityHealthAnalyticsCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule[], protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest | null, protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listSecurityHealthAnalyticsCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSecurityHealthAnalyticsCustomModules(request, options, callback)

listSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>): void;

Parameters
Name	Description
request	IListSecurityHealthAnalyticsCustomModulesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>

Returns
Type	Description
void

listSecurityHealthAnalyticsCustomModules(request, callback)

listSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>): void;

Parameters
Name	Description
request	IListSecurityHealthAnalyticsCustomModulesRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>

Returns
Type	Description
void

listSecurityHealthAnalyticsCustomModulesAsync(request, options)

listSecurityHealthAnalyticsCustomModulesAsync(request?: protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>;

Equivalent to listSecurityHealthAnalyticsCustomModules, but returns an iterable object.

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

Parameters
Name	Description
request	IListSecurityHealthAnalyticsCustomModulesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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. Name of parent to list custom modules. Its format is
   *  `organizations/{organization}/securityHealthAnalyticsSettings`,
   *  `folders/{folder}/securityHealthAnalyticsSettings`, or
   *  `projects/{project}/securityHealthAnalyticsSettings`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last call indicating a continuation
   */
  // const pageToken = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListSecurityHealthAnalyticsCustomModules();

listSecurityHealthAnalyticsCustomModulesStream(request, options)

listSecurityHealthAnalyticsCustomModulesStream(request?: protos.google.cloud.securitycenter.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListSecurityHealthAnalyticsCustomModulesRequest 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 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 listSecurityHealthAnalyticsCustomModulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSources(request, options)

listSources(request?: protos.google.cloud.securitycenter.v1.IListSourcesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISource[],
        protos.google.cloud.securitycenter.v1.IListSourcesRequest | null,
        protos.google.cloud.securitycenter.v1.IListSourcesResponse
    ]>;

Lists all sources belonging to an organization.

Parameters
Name	Description
request	IListSourcesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISource[], protos.google.cloud.securitycenter.v1.IListSourcesRequest | null, protos.google.cloud.securitycenter.v1.IListSourcesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of Source. 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 listSourcesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSources(request, options, callback)

listSources(request: protos.google.cloud.securitycenter.v1.IListSourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListSourcesRequest, protos.google.cloud.securitycenter.v1.IListSourcesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISource>): void;

Parameters
Name	Description
request	IListSourcesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListSourcesRequest, protos.google.cloud.securitycenter.v1.IListSourcesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISource>

Returns
Type	Description
void

listSources(request, callback)

listSources(request: protos.google.cloud.securitycenter.v1.IListSourcesRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListSourcesRequest, protos.google.cloud.securitycenter.v1.IListSourcesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISource>): void;

Parameters
Name	Description
request	IListSourcesRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListSourcesRequest, protos.google.cloud.securitycenter.v1.IListSourcesResponse | null | undefined, protos.google.cloud.securitycenter.v1.ISource>

Returns
Type	Description
void

listSourcesAsync(request, options)

listSourcesAsync(request?: protos.google.cloud.securitycenter.v1.IListSourcesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.ISource>;

Equivalent to listSources, but returns an iterable object.

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

Parameters
Name	Description
request	IListSourcesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.ISource>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Source. 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. Resource name of the parent of sources to list. Its format should
   *  be `organizations/[organization_id]`, `folders/[folder_id]`, or
   *  `projects/[project_id]`.
   */
  // const parent = 'abc123'
  /**
   *  The value returned by the last `ListSourcesResponse`; indicates
   *  that this is a continuation of a prior `ListSources` call, and
   *  that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListSources();

listSourcesStream(request, options)

listSourcesStream(request?: protos.google.cloud.securitycenter.v1.IListSourcesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListSourcesRequest 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 Source 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 listSourcesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listValuedResources(request, options)

listValuedResources(request?: protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IValuedResource[],
        protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest | null,
        protos.google.cloud.securitycenter.v1.IListValuedResourcesResponse
    ]>;

Lists the valued resources for a set of simulation results and filter.

Parameters
Name	Description
request	IListValuedResourcesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IValuedResource[], protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest | null, protos.google.cloud.securitycenter.v1.IListValuedResourcesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listValuedResourcesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listValuedResources(request, options, callback)

listValuedResources(request: protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest, protos.google.cloud.securitycenter.v1.IListValuedResourcesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IValuedResource>): void;

Parameters
Name	Description
request	IListValuedResourcesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest, protos.google.cloud.securitycenter.v1.IListValuedResourcesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IValuedResource>

Returns
Type	Description
void

listValuedResources(request, callback)

listValuedResources(request: protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest, protos.google.cloud.securitycenter.v1.IListValuedResourcesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IValuedResource>): void;

Parameters
Name	Description
request	IListValuedResourcesRequest
callback	PaginationCallback<protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest, protos.google.cloud.securitycenter.v1.IListValuedResourcesResponse | null | undefined, protos.google.cloud.securitycenter.v1.IValuedResource>

Returns
Type	Description
void

listValuedResourcesAsync(request, options)

listValuedResourcesAsync(request?: protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v1.IValuedResource>;

Equivalent to listValuedResources, but returns an iterable object.

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

Parameters
Name	Description
request	IListValuedResourcesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.securitycenter.v1.IValuedResource>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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. Name of parent to list valued resources.
   *  Valid formats:
   *  `organizations/{organization}`,
   *  `organizations/{organization}/simulations/{simulation}`
   *  `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}`
   */
  // const parent = 'abc123'
  /**
   *  The filter expression that filters the valued resources in the response.
   *  Supported fields:
   *    * `resource_value` supports =
   *    * `resource_type` supports =
   */
  // const filter = 'abc123'
  /**
   *  The value returned by the last `ListValuedResourcesResponse`; indicates
   *  that this is a continuation of a prior `ListValuedResources` call, and
   *  that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. The fields by which to order the valued resources response.
   *  Supported fields:
   *    * `exposed_score`
   *    * `resource_value`
   *    * `resource_type`
   *    * `resource`
   *    * `display_name`
   *  Values should be a comma separated list of fields. For example:
   *  `exposed_score,resource_value`.
   *  The default sorting order is descending. To specify ascending or descending
   *  order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for
   *  example: `exposed_score DESC`.
   */
  // const orderBy = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

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

  callListValuedResources();

listValuedResourcesStream(request, options)

listValuedResourcesStream(request?: protos.google.cloud.securitycenter.v1.IListValuedResourcesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListValuedResourcesRequest 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 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 listValuedResourcesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAssetFromFolderAssetName(folderAssetName)

matchAssetFromFolderAssetName(folderAssetName: string): string | number;

Parse the asset from FolderAsset resource.

Parameter
Name	Description
folderAssetName	string A fully-qualified path representing folder_asset resource.

Returns
Type	Description
string | number	{string} A string representing the asset.

matchAssetFromFolderAssetSecurityMarksName(folderAssetSecurityMarksName)

matchAssetFromFolderAssetSecurityMarksName(folderAssetSecurityMarksName: string): string | number;

Parse the asset from FolderAssetSecurityMarks resource.

Parameter
Name	Description
folderAssetSecurityMarksName	string A fully-qualified path representing folder_asset_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the asset.

matchAssetFromOrganizationAssetName(organizationAssetName)

matchAssetFromOrganizationAssetName(organizationAssetName: string): string | number;

Parse the asset from OrganizationAsset resource.

Parameter
Name	Description
organizationAssetName	string A fully-qualified path representing organization_asset resource.

Returns
Type	Description
string | number	{string} A string representing the asset.

matchAssetFromOrganizationAssetSecurityMarksName(organizationAssetSecurityMarksName)

matchAssetFromOrganizationAssetSecurityMarksName(organizationAssetSecurityMarksName: string): string | number;

Parse the asset from OrganizationAssetSecurityMarks resource.

Parameter
Name	Description
organizationAssetSecurityMarksName	string A fully-qualified path representing organization_asset_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the asset.

matchAssetFromProjectAssetName(projectAssetName)

matchAssetFromProjectAssetName(projectAssetName: string): string | number;

Parse the asset from ProjectAsset resource.

Parameter
Name	Description
projectAssetName	string A fully-qualified path representing project_asset resource.

Returns
Type	Description
string | number	{string} A string representing the asset.

matchAssetFromProjectAssetSecurityMarksName(projectAssetSecurityMarksName)

matchAssetFromProjectAssetSecurityMarksName(projectAssetSecurityMarksName: string): string | number;

Parse the asset from ProjectAssetSecurityMarks resource.

Parameter
Name	Description
projectAssetSecurityMarksName	string A fully-qualified path representing project_asset_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the asset.

matchAttackPathFromAttackPathName(attackPathName)

matchAttackPathFromAttackPathName(attackPathName: string): string | number;

Parse the attack_path from AttackPath resource.

Parameter
Name	Description
attackPathName	string A fully-qualified path representing AttackPath resource.

Returns
Type	Description
string | number	{string} A string representing the attack_path.

matchConstraintNameFromFolderConstraintNameName(folderConstraintNameName)

matchConstraintNameFromFolderConstraintNameName(folderConstraintNameName: string): string | number;

Parse the constraint_name from FolderConstraintName resource.

Parameter
Name	Description
folderConstraintNameName	string A fully-qualified path representing folder_constraint_name resource.

Returns
Type	Description
string | number	{string} A string representing the constraint_name.

matchConstraintNameFromOrganizationConstraintNameName(organizationConstraintNameName)

matchConstraintNameFromOrganizationConstraintNameName(organizationConstraintNameName: string): string | number;

Parse the constraint_name from OrganizationConstraintName resource.

Parameter
Name	Description
organizationConstraintNameName	string A fully-qualified path representing organization_constraint_name resource.

Returns
Type	Description
string | number	{string} A string representing the constraint_name.

matchConstraintNameFromProjectConstraintNameName(projectConstraintNameName)

matchConstraintNameFromProjectConstraintNameName(projectConstraintNameName: string): string | number;

Parse the constraint_name from ProjectConstraintName resource.

Parameter
Name	Description
projectConstraintNameName	string A fully-qualified path representing project_constraint_name resource.

Returns
Type	Description
string | number	{string} A string representing the constraint_name.

matchCustomModuleFromFolderSecurityHealthAnalyticsSettingsCustomModuleName(folderSecurityHealthAnalyticsSettingsCustomModuleName)

matchCustomModuleFromFolderSecurityHealthAnalyticsSettingsCustomModuleName(folderSecurityHealthAnalyticsSettingsCustomModuleName: string): string | number;

Parse the custom_module from FolderSecurityHealthAnalyticsSettingsCustomModule resource.

Parameter
Name	Description
folderSecurityHealthAnalyticsSettingsCustomModuleName	string A fully-qualified path representing folder_securityHealthAnalyticsSettings_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the custom_module.

matchCustomModuleFromOrganizationSecurityHealthAnalyticsSettingsCustomModuleName(organizationSecurityHealthAnalyticsSettingsCustomModuleName)

matchCustomModuleFromOrganizationSecurityHealthAnalyticsSettingsCustomModuleName(organizationSecurityHealthAnalyticsSettingsCustomModuleName: string): string | number;

Parse the custom_module from OrganizationSecurityHealthAnalyticsSettingsCustomModule resource.

Parameter
Name	Description
organizationSecurityHealthAnalyticsSettingsCustomModuleName	string A fully-qualified path representing organization_securityHealthAnalyticsSettings_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the custom_module.

matchCustomModuleFromProjectSecurityHealthAnalyticsSettingsCustomModuleName(projectSecurityHealthAnalyticsSettingsCustomModuleName)

matchCustomModuleFromProjectSecurityHealthAnalyticsSettingsCustomModuleName(projectSecurityHealthAnalyticsSettingsCustomModuleName: string): string | number;

Parse the custom_module from ProjectSecurityHealthAnalyticsSettingsCustomModule resource.

Parameter
Name	Description
projectSecurityHealthAnalyticsSettingsCustomModuleName	string A fully-qualified path representing project_securityHealthAnalyticsSettings_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the custom_module.

matchEffectiveCustomModuleFromFolderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(folderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName)

matchEffectiveCustomModuleFromFolderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(folderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName: string): string | number;

Parse the effective_custom_module from FolderSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.

Parameter
Name	Description
folderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName	string A fully-qualified path representing folder_securityHealthAnalyticsSettings_effective_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the effective_custom_module.

matchEffectiveCustomModuleFromOrganizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(organizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName)

matchEffectiveCustomModuleFromOrganizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(organizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName: string): string | number;

Parse the effective_custom_module from OrganizationSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.

Parameter
Name	Description
organizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName	string A fully-qualified path representing organization_securityHealthAnalyticsSettings_effective_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the effective_custom_module.

matchEffectiveCustomModuleFromProjectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(projectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName)

matchEffectiveCustomModuleFromProjectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(projectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName: string): string | number;

Parse the effective_custom_module from ProjectSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.

Parameter
Name	Description
projectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName	string A fully-qualified path representing project_securityHealthAnalyticsSettings_effective_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the effective_custom_module.

matchExportFromFolderExportName(folderExportName)

matchExportFromFolderExportName(folderExportName: string): string | number;

Parse the export from FolderExport resource.

Parameter
Name	Description
folderExportName	string A fully-qualified path representing folder_export resource.

Returns
Type	Description
string | number	{string} A string representing the export.

matchExportFromOrganizationExportName(organizationExportName)

matchExportFromOrganizationExportName(organizationExportName: string): string | number;

Parse the export from OrganizationExport resource.

Parameter
Name	Description
organizationExportName	string A fully-qualified path representing organization_export resource.

Returns
Type	Description
string | number	{string} A string representing the export.

matchExportFromProjectExportName(projectExportName)

matchExportFromProjectExportName(projectExportName: string): string | number;

Parse the export from ProjectExport resource.

Parameter
Name	Description
projectExportName	string A fully-qualified path representing project_export resource.

Returns
Type	Description
string | number	{string} A string representing the export.

matchExternalsystemFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName)

matchExternalsystemFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName: string): string | number;

Parse the externalsystem from FolderSourceFindingExternalsystem resource.

Parameter
Name	Description
folderSourceFindingExternalsystemName	string A fully-qualified path representing folder_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the externalsystem.

matchExternalsystemFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName)

matchExternalsystemFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName: string): string | number;

Parse the externalsystem from OrganizationSourceFindingExternalsystem resource.

Parameter
Name	Description
organizationSourceFindingExternalsystemName	string A fully-qualified path representing organization_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the externalsystem.

matchExternalsystemFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName)

matchExternalsystemFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName: string): string | number;

Parse the externalsystem from ProjectSourceFindingExternalsystem resource.

Parameter
Name	Description
projectSourceFindingExternalsystemName	string A fully-qualified path representing project_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the externalsystem.

matchFindingFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName)

matchFindingFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName: string): string | number;

Parse the finding from FolderSourceFindingExternalsystem resource.

Parameter
Name	Description
folderSourceFindingExternalsystemName	string A fully-qualified path representing folder_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the finding.

matchFindingFromFolderSourceFindingName(folderSourceFindingName)

matchFindingFromFolderSourceFindingName(folderSourceFindingName: string): string | number;

Parse the finding from FolderSourceFinding resource.

Parameter
Name	Description
folderSourceFindingName	string A fully-qualified path representing folder_source_finding resource.

Returns
Type	Description
string | number	{string} A string representing the finding.

matchFindingFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName)

matchFindingFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName: string): string | number;

Parse the finding from FolderSourceFindingSecurityMarks resource.

Parameter
Name	Description
folderSourceFindingSecurityMarksName	string A fully-qualified path representing folder_source_finding_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the finding.

matchFindingFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName)

matchFindingFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName: string): string | number;

Parse the finding from OrganizationSourceFindingExternalsystem resource.

Parameter
Name	Description
organizationSourceFindingExternalsystemName	string A fully-qualified path representing organization_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the finding.

matchFindingFromOrganizationSourceFindingName(organizationSourceFindingName)

matchFindingFromOrganizationSourceFindingName(organizationSourceFindingName: string): string | number;

Parse the finding from OrganizationSourceFinding resource.

Parameter
Name	Description
organizationSourceFindingName	string A fully-qualified path representing organization_source_finding resource.

Returns
Type	Description
string | number	{string} A string representing the finding.

matchFindingFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName)

matchFindingFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName: string): string | number;

Parse the finding from OrganizationSourceFindingSecurityMarks resource.

Parameter
Name	Description
organizationSourceFindingSecurityMarksName	string A fully-qualified path representing organization_source_finding_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the finding.

matchFindingFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName)

matchFindingFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName: string): string | number;

Parse the finding from ProjectSourceFindingExternalsystem resource.

Parameter
Name	Description
projectSourceFindingExternalsystemName	string A fully-qualified path representing project_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the finding.

matchFindingFromProjectSourceFindingName(projectSourceFindingName)

matchFindingFromProjectSourceFindingName(projectSourceFindingName: string): string | number;

Parse the finding from ProjectSourceFinding resource.

Parameter
Name	Description
projectSourceFindingName	string A fully-qualified path representing project_source_finding resource.

Returns
Type	Description
string | number	{string} A string representing the finding.

matchFindingFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName)

matchFindingFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName: string): string | number;

Parse the finding from ProjectSourceFindingSecurityMarks resource.

Parameter
Name	Description
projectSourceFindingSecurityMarksName	string A fully-qualified path representing project_source_finding_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the finding.

matchFolderFromFolderAssetName(folderAssetName)

matchFolderFromFolderAssetName(folderAssetName: string): string | number;

Parse the folder from FolderAsset resource.

Parameter
Name	Description
folderAssetName	string A fully-qualified path representing folder_asset resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderAssetSecurityMarksName(folderAssetSecurityMarksName)

matchFolderFromFolderAssetSecurityMarksName(folderAssetSecurityMarksName: string): string | number;

Parse the folder from FolderAssetSecurityMarks resource.

Parameter
Name	Description
folderAssetSecurityMarksName	string A fully-qualified path representing folder_asset_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderConstraintNameName(folderConstraintNameName)

matchFolderFromFolderConstraintNameName(folderConstraintNameName: string): string | number;

Parse the folder from FolderConstraintName resource.

Parameter
Name	Description
folderConstraintNameName	string A fully-qualified path representing folder_constraint_name resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderEventThreatDetectionSettingsModuleName(folderEventThreatDetectionSettingsModuleName)

matchFolderFromFolderEventThreatDetectionSettingsModuleName(folderEventThreatDetectionSettingsModuleName: string): string | number;

Parse the folder from FolderEventThreatDetectionSettingsModule resource.

Parameter
Name	Description
folderEventThreatDetectionSettingsModuleName	string A fully-qualified path representing folder_eventThreatDetectionSettings_module resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderExportName(folderExportName)

matchFolderFromFolderExportName(folderExportName: string): string | number;

Parse the folder from FolderExport resource.

Parameter
Name	Description
folderExportName	string A fully-qualified path representing folder_export resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderLocationMuteConfigName(folderLocationMuteConfigName)

matchFolderFromFolderLocationMuteConfigName(folderLocationMuteConfigName: string): string | number;

Parse the folder from FolderLocationMuteConfig resource.

Parameter
Name	Description
folderLocationMuteConfigName	string A fully-qualified path representing folder_location_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderMuteConfigName(folderMuteConfigName)

matchFolderFromFolderMuteConfigName(folderMuteConfigName: string): string | number;

Parse the folder from FolderMuteConfig resource.

Parameter
Name	Description
folderMuteConfigName	string A fully-qualified path representing folder_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderNotificationConfigName(folderNotificationConfigName)

matchFolderFromFolderNotificationConfigName(folderNotificationConfigName: string): string | number;

Parse the folder from FolderNotificationConfig resource.

Parameter
Name	Description
folderNotificationConfigName	string A fully-qualified path representing folder_notification_config resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderSecurityHealthAnalyticsSettingsCustomModuleName(folderSecurityHealthAnalyticsSettingsCustomModuleName)

matchFolderFromFolderSecurityHealthAnalyticsSettingsCustomModuleName(folderSecurityHealthAnalyticsSettingsCustomModuleName: string): string | number;

Parse the folder from FolderSecurityHealthAnalyticsSettingsCustomModule resource.

Parameter
Name	Description
folderSecurityHealthAnalyticsSettingsCustomModuleName	string A fully-qualified path representing folder_securityHealthAnalyticsSettings_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(folderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName)

matchFolderFromFolderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(folderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName: string): string | number;

Parse the folder from FolderSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.

Parameter
Name	Description
folderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName	string A fully-qualified path representing folder_securityHealthAnalyticsSettings_effective_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName)

matchFolderFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName: string): string | number;

Parse the folder from FolderSourceFindingExternalsystem resource.

Parameter
Name	Description
folderSourceFindingExternalsystemName	string A fully-qualified path representing folder_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderSourceFindingName(folderSourceFindingName)

matchFolderFromFolderSourceFindingName(folderSourceFindingName: string): string | number;

Parse the folder from FolderSourceFinding resource.

Parameter
Name	Description
folderSourceFindingName	string A fully-qualified path representing folder_source_finding resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName)

matchFolderFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName: string): string | number;

Parse the folder from FolderSourceFindingSecurityMarks resource.

Parameter
Name	Description
folderSourceFindingSecurityMarksName	string A fully-qualified path representing folder_source_finding_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderSourceName(folderSourceName)

matchFolderFromFolderSourceName(folderSourceName: string): string | number;

Parse the folder from FolderSource resource.

Parameter
Name	Description
folderSourceName	string A fully-qualified path representing folder_source resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchLocationFromFolderLocationMuteConfigName(folderLocationMuteConfigName)

matchLocationFromFolderLocationMuteConfigName(folderLocationMuteConfigName: string): string | number;

Parse the location from FolderLocationMuteConfig resource.

Parameter
Name	Description
folderLocationMuteConfigName	string A fully-qualified path representing folder_location_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName)

matchLocationFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName: string): string | number;

Parse the location from OrganizationLocationMuteConfig resource.

Parameter
Name	Description
organizationLocationMuteConfigName	string A fully-qualified path representing organization_location_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromProjectLocationMuteConfigName(projectLocationMuteConfigName)

matchLocationFromProjectLocationMuteConfigName(projectLocationMuteConfigName: string): string | number;

Parse the location from ProjectLocationMuteConfig resource.

Parameter
Name	Description
projectLocationMuteConfigName	string A fully-qualified path representing project_location_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchModuleFromFolderEventThreatDetectionSettingsModuleName(folderEventThreatDetectionSettingsModuleName)

matchModuleFromFolderEventThreatDetectionSettingsModuleName(folderEventThreatDetectionSettingsModuleName: string): string | number;

Parse the module from FolderEventThreatDetectionSettingsModule resource.

Parameter
Name	Description
folderEventThreatDetectionSettingsModuleName	string A fully-qualified path representing folder_eventThreatDetectionSettings_module resource.

Returns
Type	Description
string | number	{string} A string representing the module.

matchModuleFromOrganizationEventThreatDetectionSettingsModuleName(organizationEventThreatDetectionSettingsModuleName)

matchModuleFromOrganizationEventThreatDetectionSettingsModuleName(organizationEventThreatDetectionSettingsModuleName: string): string | number;

Parse the module from OrganizationEventThreatDetectionSettingsModule resource.

Parameter
Name	Description
organizationEventThreatDetectionSettingsModuleName	string A fully-qualified path representing organization_eventThreatDetectionSettings_module resource.

Returns
Type	Description
string | number	{string} A string representing the module.

matchModuleFromProjectEventThreatDetectionSettingsModuleName(projectEventThreatDetectionSettingsModuleName)

matchModuleFromProjectEventThreatDetectionSettingsModuleName(projectEventThreatDetectionSettingsModuleName: string): string | number;

Parse the module from ProjectEventThreatDetectionSettingsModule resource.

Parameter
Name	Description
projectEventThreatDetectionSettingsModuleName	string A fully-qualified path representing project_eventThreatDetectionSettings_module resource.

Returns
Type	Description
string | number	{string} A string representing the module.

matchMuteConfigFromFolderLocationMuteConfigName(folderLocationMuteConfigName)

matchMuteConfigFromFolderLocationMuteConfigName(folderLocationMuteConfigName: string): string | number;

Parse the mute_config from FolderLocationMuteConfig resource.

Parameter
Name	Description
folderLocationMuteConfigName	string A fully-qualified path representing folder_location_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the mute_config.

matchMuteConfigFromFolderMuteConfigName(folderMuteConfigName)

matchMuteConfigFromFolderMuteConfigName(folderMuteConfigName: string): string | number;

Parse the mute_config from FolderMuteConfig resource.

Parameter
Name	Description
folderMuteConfigName	string A fully-qualified path representing folder_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the mute_config.

matchMuteConfigFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName)

matchMuteConfigFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName: string): string | number;

Parse the mute_config from OrganizationLocationMuteConfig resource.

Parameter
Name	Description
organizationLocationMuteConfigName	string A fully-qualified path representing organization_location_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the mute_config.

matchMuteConfigFromOrganizationMuteConfigName(organizationMuteConfigName)

matchMuteConfigFromOrganizationMuteConfigName(organizationMuteConfigName: string): string | number;

Parse the mute_config from OrganizationMuteConfig resource.

Parameter
Name	Description
organizationMuteConfigName	string A fully-qualified path representing organization_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the mute_config.

matchMuteConfigFromProjectLocationMuteConfigName(projectLocationMuteConfigName)

matchMuteConfigFromProjectLocationMuteConfigName(projectLocationMuteConfigName: string): string | number;

Parse the mute_config from ProjectLocationMuteConfig resource.

Parameter
Name	Description
projectLocationMuteConfigName	string A fully-qualified path representing project_location_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the mute_config.

matchMuteConfigFromProjectMuteConfigName(projectMuteConfigName)

matchMuteConfigFromProjectMuteConfigName(projectMuteConfigName: string): string | number;

Parse the mute_config from ProjectMuteConfig resource.

Parameter
Name	Description
projectMuteConfigName	string A fully-qualified path representing project_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the mute_config.

matchNotificationConfigFromFolderNotificationConfigName(folderNotificationConfigName)

matchNotificationConfigFromFolderNotificationConfigName(folderNotificationConfigName: string): string | number;

Parse the notification_config from FolderNotificationConfig resource.

Parameter
Name	Description
folderNotificationConfigName	string A fully-qualified path representing folder_notification_config resource.

Returns
Type	Description
string | number	{string} A string representing the notification_config.

matchNotificationConfigFromOrganizationNotificationConfigName(organizationNotificationConfigName)

matchNotificationConfigFromOrganizationNotificationConfigName(organizationNotificationConfigName: string): string | number;

Parse the notification_config from OrganizationNotificationConfig resource.

Parameter
Name	Description
organizationNotificationConfigName	string A fully-qualified path representing organization_notification_config resource.

Returns
Type	Description
string | number	{string} A string representing the notification_config.

matchNotificationConfigFromProjectNotificationConfigName(projectNotificationConfigName)

matchNotificationConfigFromProjectNotificationConfigName(projectNotificationConfigName: string): string | number;

Parse the notification_config from ProjectNotificationConfig resource.

Parameter
Name	Description
projectNotificationConfigName	string A fully-qualified path representing project_notification_config resource.

Returns
Type	Description
string | number	{string} A string representing the notification_config.

matchOrganizationFromAttackPathName(attackPathName)

matchOrganizationFromAttackPathName(attackPathName: string): string | number;

Parse the organization from AttackPath resource.

Parameter
Name	Description
attackPathName	string A fully-qualified path representing AttackPath resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationAssetName(organizationAssetName)

matchOrganizationFromOrganizationAssetName(organizationAssetName: string): string | number;

Parse the organization from OrganizationAsset resource.

Parameter
Name	Description
organizationAssetName	string A fully-qualified path representing organization_asset resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationAssetSecurityMarksName(organizationAssetSecurityMarksName)

matchOrganizationFromOrganizationAssetSecurityMarksName(organizationAssetSecurityMarksName: string): string | number;

Parse the organization from OrganizationAssetSecurityMarks resource.

Parameter
Name	Description
organizationAssetSecurityMarksName	string A fully-qualified path representing organization_asset_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationConstraintNameName(organizationConstraintNameName)

matchOrganizationFromOrganizationConstraintNameName(organizationConstraintNameName: string): string | number;

Parse the organization from OrganizationConstraintName resource.

Parameter
Name	Description
organizationConstraintNameName	string A fully-qualified path representing organization_constraint_name resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationEventThreatDetectionSettingsModuleName(organizationEventThreatDetectionSettingsModuleName)

matchOrganizationFromOrganizationEventThreatDetectionSettingsModuleName(organizationEventThreatDetectionSettingsModuleName: string): string | number;

Parse the organization from OrganizationEventThreatDetectionSettingsModule resource.

Parameter
Name	Description
organizationEventThreatDetectionSettingsModuleName	string A fully-qualified path representing organization_eventThreatDetectionSettings_module resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationEventThreatDetectionSettingsName(organizationEventThreatDetectionSettingsName)

matchOrganizationFromOrganizationEventThreatDetectionSettingsName(organizationEventThreatDetectionSettingsName: string): string | number;

Parse the organization from OrganizationEventThreatDetectionSettings resource.

Parameter
Name	Description
organizationEventThreatDetectionSettingsName	string A fully-qualified path representing organization_eventThreatDetectionSettings resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationExportName(organizationExportName)

matchOrganizationFromOrganizationExportName(organizationExportName: string): string | number;

Parse the organization from OrganizationExport resource.

Parameter
Name	Description
organizationExportName	string A fully-qualified path representing organization_export resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName)

matchOrganizationFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName: string): string | number;

Parse the organization from OrganizationLocationMuteConfig resource.

Parameter
Name	Description
organizationLocationMuteConfigName	string A fully-qualified path representing organization_location_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationMuteConfigName(organizationMuteConfigName)

matchOrganizationFromOrganizationMuteConfigName(organizationMuteConfigName: string): string | number;

Parse the organization from OrganizationMuteConfig resource.

Parameter
Name	Description
organizationMuteConfigName	string A fully-qualified path representing organization_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationName(organizationName)

matchOrganizationFromOrganizationName(organizationName: string): string | number;

Parse the organization from Organization resource.

Parameter
Name	Description
organizationName	string A fully-qualified path representing Organization resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationNotificationConfigName(organizationNotificationConfigName)

matchOrganizationFromOrganizationNotificationConfigName(organizationNotificationConfigName: string): string | number;

Parse the organization from OrganizationNotificationConfig resource.

Parameter
Name	Description
organizationNotificationConfigName	string A fully-qualified path representing organization_notification_config resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationSecurityHealthAnalyticsSettingsCustomModuleName(organizationSecurityHealthAnalyticsSettingsCustomModuleName)

matchOrganizationFromOrganizationSecurityHealthAnalyticsSettingsCustomModuleName(organizationSecurityHealthAnalyticsSettingsCustomModuleName: string): string | number;

Parse the organization from OrganizationSecurityHealthAnalyticsSettingsCustomModule resource.

Parameter
Name	Description
organizationSecurityHealthAnalyticsSettingsCustomModuleName	string A fully-qualified path representing organization_securityHealthAnalyticsSettings_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(organizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName)

matchOrganizationFromOrganizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(organizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName: string): string | number;

Parse the organization from OrganizationSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.

Parameter
Name	Description
organizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName	string A fully-qualified path representing organization_securityHealthAnalyticsSettings_effective_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationSecurityHealthAnalyticsSettingsName(organizationSecurityHealthAnalyticsSettingsName)

matchOrganizationFromOrganizationSecurityHealthAnalyticsSettingsName(organizationSecurityHealthAnalyticsSettingsName: string): string | number;

Parse the organization from OrganizationSecurityHealthAnalyticsSettings resource.

Parameter
Name	Description
organizationSecurityHealthAnalyticsSettingsName	string A fully-qualified path representing organization_securityHealthAnalyticsSettings resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationSettingsName(organizationSettingsName)

matchOrganizationFromOrganizationSettingsName(organizationSettingsName: string): string | number;

Parse the organization from OrganizationSettings resource.

Parameter
Name	Description
organizationSettingsName	string A fully-qualified path representing OrganizationSettings resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationSimulationName(organizationSimulationName)

matchOrganizationFromOrganizationSimulationName(organizationSimulationName: string): string | number;

Parse the organization from OrganizationSimulation resource.

Parameter
Name	Description
organizationSimulationName	string A fully-qualified path representing OrganizationSimulation resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName)

matchOrganizationFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName: string): string | number;

Parse the organization from OrganizationSourceFindingExternalsystem resource.

Parameter
Name	Description
organizationSourceFindingExternalsystemName	string A fully-qualified path representing organization_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationSourceFindingName(organizationSourceFindingName)

matchOrganizationFromOrganizationSourceFindingName(organizationSourceFindingName: string): string | number;

Parse the organization from OrganizationSourceFinding resource.

Parameter
Name	Description
organizationSourceFindingName	string A fully-qualified path representing organization_source_finding resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName)

matchOrganizationFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName: string): string | number;

Parse the organization from OrganizationSourceFindingSecurityMarks resource.

Parameter
Name	Description
organizationSourceFindingSecurityMarksName	string A fully-qualified path representing organization_source_finding_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationSourceName(organizationSourceName)

matchOrganizationFromOrganizationSourceName(organizationSourceName: string): string | number;

Parse the organization from OrganizationSource resource.

Parameter
Name	Description
organizationSourceName	string A fully-qualified path representing organization_source resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromResourceValueConfigName(resourceValueConfigName)

matchOrganizationFromResourceValueConfigName(resourceValueConfigName: string): string | number;

Parse the organization from ResourceValueConfig resource.

Parameter
Name	Description
resourceValueConfigName	string A fully-qualified path representing ResourceValueConfig resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromSimulationName(simulationName)

matchOrganizationFromSimulationName(simulationName: string): string | number;

Parse the organization from Simulation resource.

Parameter
Name	Description
simulationName	string A fully-qualified path representing Simulation resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromValuedResourceName(valuedResourceName)

matchOrganizationFromValuedResourceName(valuedResourceName: string): string | number;

Parse the organization from ValuedResource resource.

Parameter
Name	Description
valuedResourceName	string A fully-qualified path representing ValuedResource resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchProjectFromProjectAssetName(projectAssetName)

matchProjectFromProjectAssetName(projectAssetName: string): string | number;

Parse the project from ProjectAsset resource.

Parameter
Name	Description
projectAssetName	string A fully-qualified path representing project_asset resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectAssetSecurityMarksName(projectAssetSecurityMarksName)

matchProjectFromProjectAssetSecurityMarksName(projectAssetSecurityMarksName: string): string | number;

Parse the project from ProjectAssetSecurityMarks resource.

Parameter
Name	Description
projectAssetSecurityMarksName	string A fully-qualified path representing project_asset_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectConstraintNameName(projectConstraintNameName)

matchProjectFromProjectConstraintNameName(projectConstraintNameName: string): string | number;

Parse the project from ProjectConstraintName resource.

Parameter
Name	Description
projectConstraintNameName	string A fully-qualified path representing project_constraint_name resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectEventThreatDetectionSettingsModuleName(projectEventThreatDetectionSettingsModuleName)

matchProjectFromProjectEventThreatDetectionSettingsModuleName(projectEventThreatDetectionSettingsModuleName: string): string | number;

Parse the project from ProjectEventThreatDetectionSettingsModule resource.

Parameter
Name	Description
projectEventThreatDetectionSettingsModuleName	string A fully-qualified path representing project_eventThreatDetectionSettings_module resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectExportName(projectExportName)

matchProjectFromProjectExportName(projectExportName: string): string | number;

Parse the project from ProjectExport resource.

Parameter
Name	Description
projectExportName	string A fully-qualified path representing project_export resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectLocationMuteConfigName(projectLocationMuteConfigName)

matchProjectFromProjectLocationMuteConfigName(projectLocationMuteConfigName: string): string | number;

Parse the project from ProjectLocationMuteConfig resource.

Parameter
Name	Description
projectLocationMuteConfigName	string A fully-qualified path representing project_location_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectMuteConfigName(projectMuteConfigName)

matchProjectFromProjectMuteConfigName(projectMuteConfigName: string): string | number;

Parse the project from ProjectMuteConfig resource.

Parameter
Name	Description
projectMuteConfigName	string A fully-qualified path representing project_mute_config resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectNotificationConfigName(projectNotificationConfigName)

matchProjectFromProjectNotificationConfigName(projectNotificationConfigName: string): string | number;

Parse the project from ProjectNotificationConfig resource.

Parameter
Name	Description
projectNotificationConfigName	string A fully-qualified path representing project_notification_config resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectSecurityHealthAnalyticsSettingsCustomModuleName(projectSecurityHealthAnalyticsSettingsCustomModuleName)

matchProjectFromProjectSecurityHealthAnalyticsSettingsCustomModuleName(projectSecurityHealthAnalyticsSettingsCustomModuleName: string): string | number;

Parse the project from ProjectSecurityHealthAnalyticsSettingsCustomModule resource.

Parameter
Name	Description
projectSecurityHealthAnalyticsSettingsCustomModuleName	string A fully-qualified path representing project_securityHealthAnalyticsSettings_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(projectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName)

matchProjectFromProjectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(projectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName: string): string | number;

Parse the project from ProjectSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.

Parameter
Name	Description
projectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName	string A fully-qualified path representing project_securityHealthAnalyticsSettings_effective_custom_module resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName)

matchProjectFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName: string): string | number;

Parse the project from ProjectSourceFindingExternalsystem resource.

Parameter
Name	Description
projectSourceFindingExternalsystemName	string A fully-qualified path representing project_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectSourceFindingName(projectSourceFindingName)

matchProjectFromProjectSourceFindingName(projectSourceFindingName: string): string | number;

Parse the project from ProjectSourceFinding resource.

Parameter
Name	Description
projectSourceFindingName	string A fully-qualified path representing project_source_finding resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName)

matchProjectFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName: string): string | number;

Parse the project from ProjectSourceFindingSecurityMarks resource.

Parameter
Name	Description
projectSourceFindingSecurityMarksName	string A fully-qualified path representing project_source_finding_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectSourceName(projectSourceName)

matchProjectFromProjectSourceName(projectSourceName: string): string | number;

Parse the project from ProjectSource resource.

Parameter
Name	Description
projectSourceName	string A fully-qualified path representing project_source resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchResourceValueConfigFromResourceValueConfigName(resourceValueConfigName)

matchResourceValueConfigFromResourceValueConfigName(resourceValueConfigName: string): string | number;

Parse the resource_value_config from ResourceValueConfig resource.

Parameter
Name	Description
resourceValueConfigName	string A fully-qualified path representing ResourceValueConfig resource.

Returns
Type	Description
string | number	{string} A string representing the resource_value_config.

matchSimulationFromAttackPathName(attackPathName)

matchSimulationFromAttackPathName(attackPathName: string): string | number;

Parse the simulation from AttackPath resource.

Parameter
Name	Description
attackPathName	string A fully-qualified path representing AttackPath resource.

Returns
Type	Description
string | number	{string} A string representing the simulation.

matchSimulationFromOrganizationSimulationName(organizationSimulationName)

matchSimulationFromOrganizationSimulationName(organizationSimulationName: string): string | number;

Parse the simulation from OrganizationSimulation resource.

Parameter
Name	Description
organizationSimulationName	string A fully-qualified path representing OrganizationSimulation resource.

Returns
Type	Description
string | number	{string} A string representing the simulation.

matchSimulationFromSimulationName(simulationName)

matchSimulationFromSimulationName(simulationName: string): string | number;

Parse the simulation from Simulation resource.

Parameter
Name	Description
simulationName	string A fully-qualified path representing Simulation resource.

Returns
Type	Description
string | number	{string} A string representing the simulation.

matchSimulationFromValuedResourceName(valuedResourceName)

matchSimulationFromValuedResourceName(valuedResourceName: string): string | number;

Parse the simulation from ValuedResource resource.

Parameter
Name	Description
valuedResourceName	string A fully-qualified path representing ValuedResource resource.

Returns
Type	Description
string | number	{string} A string representing the simulation.

matchSourceFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName)

matchSourceFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName: string): string | number;

Parse the source from FolderSourceFindingExternalsystem resource.

Parameter
Name	Description
folderSourceFindingExternalsystemName	string A fully-qualified path representing folder_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromFolderSourceFindingName(folderSourceFindingName)

matchSourceFromFolderSourceFindingName(folderSourceFindingName: string): string | number;

Parse the source from FolderSourceFinding resource.

Parameter
Name	Description
folderSourceFindingName	string A fully-qualified path representing folder_source_finding resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName)

matchSourceFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName: string): string | number;

Parse the source from FolderSourceFindingSecurityMarks resource.

Parameter
Name	Description
folderSourceFindingSecurityMarksName	string A fully-qualified path representing folder_source_finding_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromFolderSourceName(folderSourceName)

matchSourceFromFolderSourceName(folderSourceName: string): string | number;

Parse the source from FolderSource resource.

Parameter
Name	Description
folderSourceName	string A fully-qualified path representing folder_source resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName)

matchSourceFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName: string): string | number;

Parse the source from OrganizationSourceFindingExternalsystem resource.

Parameter
Name	Description
organizationSourceFindingExternalsystemName	string A fully-qualified path representing organization_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromOrganizationSourceFindingName(organizationSourceFindingName)

matchSourceFromOrganizationSourceFindingName(organizationSourceFindingName: string): string | number;

Parse the source from OrganizationSourceFinding resource.

Parameter
Name	Description
organizationSourceFindingName	string A fully-qualified path representing organization_source_finding resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName)

matchSourceFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName: string): string | number;

Parse the source from OrganizationSourceFindingSecurityMarks resource.

Parameter
Name	Description
organizationSourceFindingSecurityMarksName	string A fully-qualified path representing organization_source_finding_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromOrganizationSourceName(organizationSourceName)

matchSourceFromOrganizationSourceName(organizationSourceName: string): string | number;

Parse the source from OrganizationSource resource.

Parameter
Name	Description
organizationSourceName	string A fully-qualified path representing organization_source resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName)

matchSourceFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName: string): string | number;

Parse the source from ProjectSourceFindingExternalsystem resource.

Parameter
Name	Description
projectSourceFindingExternalsystemName	string A fully-qualified path representing project_source_finding_externalsystem resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromProjectSourceFindingName(projectSourceFindingName)

matchSourceFromProjectSourceFindingName(projectSourceFindingName: string): string | number;

Parse the source from ProjectSourceFinding resource.

Parameter
Name	Description
projectSourceFindingName	string A fully-qualified path representing project_source_finding resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName)

matchSourceFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName: string): string | number;

Parse the source from ProjectSourceFindingSecurityMarks resource.

Parameter
Name	Description
projectSourceFindingSecurityMarksName	string A fully-qualified path representing project_source_finding_securityMarks resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchSourceFromProjectSourceName(projectSourceName)

matchSourceFromProjectSourceName(projectSourceName: string): string | number;

Parse the source from ProjectSource resource.

Parameter
Name	Description
projectSourceName	string A fully-qualified path representing project_source resource.

Returns
Type	Description
string | number	{string} A string representing the source.

matchValuedResourceFromAttackPathName(attackPathName)

matchValuedResourceFromAttackPathName(attackPathName: string): string | number;

Parse the valued_resource from AttackPath resource.

Parameter
Name	Description
attackPathName	string A fully-qualified path representing AttackPath resource.

Returns
Type	Description
string | number	{string} A string representing the valued_resource.

matchValuedResourceFromValuedResourceName(valuedResourceName)

matchValuedResourceFromValuedResourceName(valuedResourceName: string): string | number;

Parse the valued_resource from ValuedResource resource.

Parameter
Name	Description
valuedResourceName	string A fully-qualified path representing ValuedResource resource.

Returns
Type	Description
string | number	{string} A string representing the valued_resource.

organizationAssetPath(organization, asset)

organizationAssetPath(organization: string, asset: string): string;

Return a fully-qualified organizationAsset resource name string.

Parameters
Name	Description
organization	string
asset	string

Returns
Type	Description
string	{string} Resource name string.

organizationAssetSecurityMarksPath(organization, asset)

organizationAssetSecurityMarksPath(organization: string, asset: string): string;

Return a fully-qualified organizationAssetSecurityMarks resource name string.

Parameters
Name	Description
organization	string
asset	string

Returns
Type	Description
string	{string} Resource name string.

organizationConstraintNamePath(organization, constraintName)

organizationConstraintNamePath(organization: string, constraintName: string): string;

Return a fully-qualified organizationConstraintName resource name string.

Parameters
Name	Description
organization	string
constraintName	string

Returns
Type	Description
string	{string} Resource name string.

organizationEventThreatDetectionSettingsModulePath(organization, module)

organizationEventThreatDetectionSettingsModulePath(organization: string, module: string): string;

Return a fully-qualified organizationEventThreatDetectionSettingsModule resource name string.

Parameters
Name	Description
organization	string
module	string

Returns
Type	Description
string	{string} Resource name string.

organizationEventThreatDetectionSettingsPath(organization)

organizationEventThreatDetectionSettingsPath(organization: string): string;

Return a fully-qualified organizationEventThreatDetectionSettings resource name string.

Parameter
Name	Description
organization	string

Returns
Type	Description
string	{string} Resource name string.

organizationExportPath(organization, exportParam)

organizationExportPath(organization: string, exportParam: string): string;

Return a fully-qualified organizationExport resource name string.

Parameters
Name	Description
organization	string
exportParam	string

Returns
Type	Description
string	{string} Resource name string.

organizationLocationMuteConfigPath(organization, location, muteConfig)

organizationLocationMuteConfigPath(organization: string, location: string, muteConfig: string): string;

Return a fully-qualified organizationLocationMuteConfig resource name string.

Parameters
Name	Description
organization	string
location	string
muteConfig	string

Returns
Type	Description
string	{string} Resource name string.

organizationMuteConfigPath(organization, muteConfig)

organizationMuteConfigPath(organization: string, muteConfig: string): string;

Return a fully-qualified organizationMuteConfig resource name string.

Parameters
Name	Description
organization	string
muteConfig	string

Returns
Type	Description
string	{string} Resource name string.

organizationNotificationConfigPath(organization, notificationConfig)

organizationNotificationConfigPath(organization: string, notificationConfig: string): string;

Return a fully-qualified organizationNotificationConfig resource name string.

Parameters
Name	Description
organization	string
notificationConfig	string

Returns
Type	Description
string	{string} Resource name string.

organizationPath(organization)

organizationPath(organization: string): string;

Return a fully-qualified organization resource name string.

Parameter
Name	Description
organization	string

Returns
Type	Description
string	{string} Resource name string.

organizationSecurityHealthAnalyticsSettingsCustomModulePath(organization, customModule)

organizationSecurityHealthAnalyticsSettingsCustomModulePath(organization: string, customModule: string): string;

Return a fully-qualified organizationSecurityHealthAnalyticsSettingsCustomModule resource name string.

Parameters
Name	Description
organization	string
customModule	string

Returns
Type	Description
string	{string} Resource name string.

organizationSecurityHealthAnalyticsSettingsEffectiveCustomModulePath(organization, effectiveCustomModule)

organizationSecurityHealthAnalyticsSettingsEffectiveCustomModulePath(organization: string, effectiveCustomModule: string): string;

Return a fully-qualified organizationSecurityHealthAnalyticsSettingsEffectiveCustomModule resource name string.

Parameters
Name	Description
organization	string
effectiveCustomModule	string

Returns
Type	Description
string	{string} Resource name string.

organizationSecurityHealthAnalyticsSettingsPath(organization)

organizationSecurityHealthAnalyticsSettingsPath(organization: string): string;

Return a fully-qualified organizationSecurityHealthAnalyticsSettings resource name string.

Parameter
Name	Description
organization	string

Returns
Type	Description
string	{string} Resource name string.

organizationSettingsPath(organization)

organizationSettingsPath(organization: string): string;

Return a fully-qualified organizationSettings resource name string.

Parameter
Name	Description
organization	string

Returns
Type	Description
string	{string} Resource name string.

organizationSimulationPath(organization, simulation)

organizationSimulationPath(organization: string, simulation: string): string;

Return a fully-qualified organizationSimulation resource name string.

Parameters
Name	Description
organization	string
simulation	string

Returns
Type	Description
string	{string} Resource name string.

organizationSourceFindingExternalsystemPath(organization, source, finding, externalsystem)

organizationSourceFindingExternalsystemPath(organization: string, source: string, finding: string, externalsystem: string): string;

Return a fully-qualified organizationSourceFindingExternalsystem resource name string.

Parameters
Name	Description
organization	string
source	string
finding	string
externalsystem	string

Returns
Type	Description
string	{string} Resource name string.

organizationSourceFindingPath(organization, source, finding)

organizationSourceFindingPath(organization: string, source: string, finding: string): string;

Return a fully-qualified organizationSourceFinding resource name string.

Parameters
Name	Description
organization	string
source	string
finding	string

Returns
Type	Description
string	{string} Resource name string.

organizationSourceFindingSecurityMarksPath(organization, source, finding)

organizationSourceFindingSecurityMarksPath(organization: string, source: string, finding: string): string;

Return a fully-qualified organizationSourceFindingSecurityMarks resource name string.

Parameters
Name	Description
organization	string
source	string
finding	string

Returns
Type	Description
string	{string} Resource name string.

organizationSourcePath(organization, source)

organizationSourcePath(organization: string, source: string): string;

Return a fully-qualified organizationSource resource name string.

Parameters
Name	Description
organization	string
source	string

Returns
Type	Description
string	{string} Resource name string.

projectAssetPath(project, asset)

projectAssetPath(project: string, asset: string): string;

Return a fully-qualified projectAsset resource name string.

Parameters
Name	Description
project	string
asset	string

Returns
Type	Description
string	{string} Resource name string.

projectAssetSecurityMarksPath(project, asset)

projectAssetSecurityMarksPath(project: string, asset: string): string;

Return a fully-qualified projectAssetSecurityMarks resource name string.

Parameters
Name	Description
project	string
asset	string

Returns
Type	Description
string	{string} Resource name string.

projectConstraintNamePath(project, constraintName)

projectConstraintNamePath(project: string, constraintName: string): string;

Return a fully-qualified projectConstraintName resource name string.

Parameters
Name	Description
project	string
constraintName	string

Returns
Type	Description
string	{string} Resource name string.

projectEventThreatDetectionSettingsModulePath(project, module)

projectEventThreatDetectionSettingsModulePath(project: string, module: string): string;

Return a fully-qualified projectEventThreatDetectionSettingsModule resource name string.

Parameters
Name	Description
project	string
module	string

Returns
Type	Description
string	{string} Resource name string.

projectExportPath(project, exportParam)

projectExportPath(project: string, exportParam: string): string;

Return a fully-qualified projectExport resource name string.

Parameters
Name	Description
project	string
exportParam	string

Returns
Type	Description
string	{string} Resource name string.

projectLocationMuteConfigPath(project, location, muteConfig)

projectLocationMuteConfigPath(project: string, location: string, muteConfig: string): string;

Return a fully-qualified projectLocationMuteConfig resource name string.

Parameters
Name	Description
project	string
location	string
muteConfig	string

Returns
Type	Description
string	{string} Resource name string.

projectMuteConfigPath(project, muteConfig)

projectMuteConfigPath(project: string, muteConfig: string): string;

Return a fully-qualified projectMuteConfig resource name string.

Parameters
Name	Description
project	string
muteConfig	string

Returns
Type	Description
string	{string} Resource name string.

projectNotificationConfigPath(project, notificationConfig)

projectNotificationConfigPath(project: string, notificationConfig: string): string;

Return a fully-qualified projectNotificationConfig resource name string.

Parameters
Name	Description
project	string
notificationConfig	string

Returns
Type	Description
string	{string} Resource name string.

projectSecurityHealthAnalyticsSettingsCustomModulePath(project, customModule)

projectSecurityHealthAnalyticsSettingsCustomModulePath(project: string, customModule: string): string;

Return a fully-qualified projectSecurityHealthAnalyticsSettingsCustomModule resource name string.

Parameters
Name	Description
project	string
customModule	string

Returns
Type	Description
string	{string} Resource name string.

projectSecurityHealthAnalyticsSettingsEffectiveCustomModulePath(project, effectiveCustomModule)

projectSecurityHealthAnalyticsSettingsEffectiveCustomModulePath(project: string, effectiveCustomModule: string): string;

Return a fully-qualified projectSecurityHealthAnalyticsSettingsEffectiveCustomModule resource name string.

Parameters
Name	Description
project	string
effectiveCustomModule	string

Returns
Type	Description
string	{string} Resource name string.

projectSourceFindingExternalsystemPath(project, source, finding, externalsystem)

projectSourceFindingExternalsystemPath(project: string, source: string, finding: string, externalsystem: string): string;

Return a fully-qualified projectSourceFindingExternalsystem resource name string.

Parameters
Name	Description
project	string
source	string
finding	string
externalsystem	string

Returns
Type	Description
string	{string} Resource name string.

projectSourceFindingPath(project, source, finding)

projectSourceFindingPath(project: string, source: string, finding: string): string;

Return a fully-qualified projectSourceFinding resource name string.

Parameters
Name	Description
project	string
source	string
finding	string

Returns
Type	Description
string	{string} Resource name string.

projectSourceFindingSecurityMarksPath(project, source, finding)

projectSourceFindingSecurityMarksPath(project: string, source: string, finding: string): string;

Return a fully-qualified projectSourceFindingSecurityMarks resource name string.

Parameters
Name	Description
project	string
source	string
finding	string

Returns
Type	Description
string	{string} Resource name string.

projectSourcePath(project, source)

projectSourcePath(project: string, source: string): string;

Return a fully-qualified projectSource resource name string.

Parameters
Name	Description
project	string
source	string

Returns
Type	Description
string	{string} Resource name string.

resourceValueConfigPath(organization, resourceValueConfig)

resourceValueConfigPath(organization: string, resourceValueConfig: string): string;

Return a fully-qualified resourceValueConfig resource name string.

Parameters
Name	Description
organization	string
resourceValueConfig	string

Returns
Type	Description
string	{string} Resource name string.

runAssetDiscovery(request, options)

runAssetDiscovery(request?: protos.google.cloud.securitycenter.v1.IRunAssetDiscoveryRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.securitycenter.v1.IRunAssetDiscoveryResponse, protos.google.protobuf.IEmpty>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Runs asset discovery. The discovery is tracked with a long-running operation.

This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.

Parameters
Name	Description
request	IRunAssetDiscoveryRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.securitycenter.v1.IRunAssetDiscoveryResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. 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. Name of the organization to run asset discovery for. Its format
   *  is `organizations/[organization_id]`.
   */
  // const parent = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const [operation] = await securitycenterClient.runAssetDiscovery(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRunAssetDiscovery();

runAssetDiscovery(request, options, callback)

runAssetDiscovery(request: protos.google.cloud.securitycenter.v1.IRunAssetDiscoveryRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.securitycenter.v1.IRunAssetDiscoveryResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IRunAssetDiscoveryRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.securitycenter.v1.IRunAssetDiscoveryResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

runAssetDiscovery(request, callback)

runAssetDiscovery(request: protos.google.cloud.securitycenter.v1.IRunAssetDiscoveryRequest, callback: Callback<LROperation<protos.google.cloud.securitycenter.v1.IRunAssetDiscoveryResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IRunAssetDiscoveryRequest
callback	Callback<LROperation<protos.google.cloud.securitycenter.v1.IRunAssetDiscoveryResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

setFindingState(request, options)

setFindingState(request?: protos.google.cloud.securitycenter.v1.ISetFindingStateRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IFinding,
        protos.google.cloud.securitycenter.v1.ISetFindingStateRequest | undefined,
        {} | undefined
    ]>;

Updates the state of a finding.

Parameters
Name	Description
request	ISetFindingStateRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ISetFindingStateRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 relative resource
   *  name (https://cloud.google.com/apis/design/resource_names#relative_resource_name)
   *  of the finding. Example:
   *  `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`,
   *  `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`,
   *  `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.
   */
  // const name = 'abc123'
  /**
   *  Required. The desired State of the finding.
   */
  // const state = {}
  /**
   *  Required. The time at which the updated state takes effect.
   */
  // const startTime = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callSetFindingState() {
    // Construct request
    const request = {
      name,
      state,
      startTime,
    };

    // Run request
    const response = await securitycenterClient.setFindingState(request);
    console.log(response);
  }

  callSetFindingState();

setFindingState(request, options, callback)

setFindingState(request: protos.google.cloud.securitycenter.v1.ISetFindingStateRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ISetFindingStateRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISetFindingStateRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ISetFindingStateRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

setFindingState(request, callback)

setFindingState(request: protos.google.cloud.securitycenter.v1.ISetFindingStateRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ISetFindingStateRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISetFindingStateRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ISetFindingStateRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.ISetIamPolicyRequest | undefined,
        {} | undefined
    ]>;

Sets the access control policy on the specified Source.

Parameters
Name	Description
request	ISetIamPolicyRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. 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 resource for which the policy is being specified.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  REQUIRED: The complete policy to be applied to the `resource`. The size of
   *  the policy is limited to a few 10s of KB. An empty policy is a
   *  valid policy but certain Cloud Platform services (such as Projects)
   *  might reject them.
   */
  // const policy = {}
  /**
   *  OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
   *  the fields in the mask will be modified. If no mask is provided, the
   *  following default mask is used:
   *  `paths: "bindings, etag"`
   */
  // const updateMask = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callSetIamPolicy() {
    // Construct request
    const request = {
      resource,
      policy,
    };

    // Run request
    const response = await securitycenterClient.setIamPolicy(request);
    console.log(response);
  }

  callSetIamPolicy();

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISetIamPolicyRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISetIamPolicyRequest
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

setMute(request, options)

setMute(request?: protos.google.cloud.securitycenter.v1.ISetMuteRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IFinding,
        protos.google.cloud.securitycenter.v1.ISetMuteRequest | undefined,
        {} | undefined
    ]>;

Updates the mute state of a finding.

Parameters
Name	Description
request	ISetMuteRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ISetMuteRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 relative resource
   *  name (https://cloud.google.com/apis/design/resource_names#relative_resource_name)
   *  of the finding. Example:
   *  `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`,
   *  `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`,
   *  `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.
   */
  // const name = 'abc123'
  /**
   *  Required. The desired state of the Mute.
   */
  // const mute = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.setMute(request);
    console.log(response);
  }

  callSetMute();

setMute(request, options, callback)

setMute(request: protos.google.cloud.securitycenter.v1.ISetMuteRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ISetMuteRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISetMuteRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ISetMuteRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

setMute(request, callback)

setMute(request: protos.google.cloud.securitycenter.v1.ISetMuteRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ISetMuteRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISetMuteRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.ISetMuteRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

simulateSecurityHealthAnalyticsCustomModule(request, options)

simulateSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse,
        (protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

Parameters
Name	Description
request	ISimulateSecurityHealthAnalyticsCustomModuleRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, (protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 relative resource name of the organization, project, or
   *  folder. For more information about relative resource names, see Relative
   *  Resource
   *  Name (https://cloud.google.com/apis/design/resource_names#relative_resource_name)
   *  Example: `organizations/{organization_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The custom configuration that you need to test.
   */
  // const customConfig = {}
  /**
   *  Required. Resource data to simulate custom module against.
   */
  // const resource = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callSimulateSecurityHealthAnalyticsCustomModule() {
    // Construct request
    const request = {
      parent,
      customConfig,
      resource,
    };

    // Run request
    const response = await securitycenterClient.simulateSecurityHealthAnalyticsCustomModule(request);
    console.log(response);
  }

  callSimulateSecurityHealthAnalyticsCustomModule();

simulateSecurityHealthAnalyticsCustomModule(request, options, callback)

simulateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISimulateSecurityHealthAnalyticsCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

simulateSecurityHealthAnalyticsCustomModule(request, callback)

simulateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISimulateSecurityHealthAnalyticsCustomModuleRequest
callback	Callback<protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycenter.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

simulationPath(organization, simulation)

simulationPath(organization: string, simulation: string): string;

Return a fully-qualified simulation resource name string.

Parameters
Name	Description
organization	string
simulation	string

Returns
Type	Description
string	{string} Resource name string.

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.ITestIamPermissionsResponse,
        protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
        {} | undefined
    ]>;

Returns the permissions that a caller has on the specified source.

Parameters
Name	Description
request	ITestIamPermissionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. 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 resource for which the policy detail is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  The set of permissions to check for the `resource`. Permissions with
   *  wildcards (such as '*' or 'storage.*') are not allowed. For more
   *  information see
   *  IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
   */
  // const permissions = ['abc','def']

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callTestIamPermissions() {
    // Construct request
    const request = {
      resource,
      permissions,
    };

    // Run request
    const response = await securitycenterClient.testIamPermissions(request);
    console.log(response);
  }

  callTestIamPermissions();

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ITestIamPermissionsRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ITestIamPermissionsRequest
callback	Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateBigQueryExport(request, options)

updateBigQueryExport(request?: protos.google.cloud.securitycenter.v1.IUpdateBigQueryExportRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IBigQueryExport,
        (protos.google.cloud.securitycenter.v1.IUpdateBigQueryExportRequest | undefined),
        {} | undefined
    ]>;

Updates a BigQuery export.

Parameters
Name	Description
request	IUpdateBigQueryExportRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IBigQueryExport, (protos.google.cloud.securitycenter.v1.IUpdateBigQueryExportRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing BigQueryExport. 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 BigQuery export being updated.
   */
  // const bigQueryExport = {}
  /**
   *  The list of fields to be updated.
   *  If empty all mutable fields will be updated.
   */
  // const updateMask = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callUpdateBigQueryExport() {
    // Construct request
    const request = {
      bigQueryExport,
    };

    // Run request
    const response = await securitycenterClient.updateBigQueryExport(request);
    console.log(response);
  }

  callUpdateBigQueryExport();

updateBigQueryExport(request, options, callback)

updateBigQueryExport(request: protos.google.cloud.securitycenter.v1.IUpdateBigQueryExportRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.IUpdateBigQueryExportRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateBigQueryExportRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.IUpdateBigQueryExportRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateBigQueryExport(request, callback)

updateBigQueryExport(request: protos.google.cloud.securitycenter.v1.IUpdateBigQueryExportRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.IUpdateBigQueryExportRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateBigQueryExportRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IBigQueryExport, protos.google.cloud.securitycenter.v1.IUpdateBigQueryExportRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateEventThreatDetectionCustomModule(request, options)

updateEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycenter.v1.IUpdateEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule,
        (protos.google.cloud.securitycenter.v1.IUpdateEventThreatDetectionCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

Parameters
Name	Description
request	IUpdateEventThreatDetectionCustomModuleRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, (protos.google.cloud.securitycenter.v1.IUpdateEventThreatDetectionCustomModuleRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 module being updated.
   */
  // const eventThreatDetectionCustomModule = {}
  /**
   *  The list of fields to be updated.
   *  If empty all mutable fields will be updated.
   */
  // const updateMask = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callUpdateEventThreatDetectionCustomModule() {
    // Construct request
    const request = {
      eventThreatDetectionCustomModule,
    };

    // Run request
    const response = await securitycenterClient.updateEventThreatDetectionCustomModule(request);
    console.log(response);
  }

  callUpdateEventThreatDetectionCustomModule();

updateEventThreatDetectionCustomModule(request, options, callback)

updateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.IUpdateEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IUpdateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateEventThreatDetectionCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IUpdateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateEventThreatDetectionCustomModule(request, callback)

updateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.IUpdateEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IUpdateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateEventThreatDetectionCustomModuleRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycenter.v1.IUpdateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateExternalSystem(request, options)

updateExternalSystem(request?: protos.google.cloud.securitycenter.v1.IUpdateExternalSystemRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IExternalSystem,
        (protos.google.cloud.securitycenter.v1.IUpdateExternalSystemRequest | undefined),
        {} | undefined
    ]>;

Updates external system. This is for a given finding.

Parameters
Name	Description
request	IUpdateExternalSystemRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IExternalSystem, (protos.google.cloud.securitycenter.v1.IUpdateExternalSystemRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 external system resource to update.
   */
  // const externalSystem = {}
  /**
   *  The FieldMask to use when updating the external system resource.
   *  If empty all mutable fields will be updated.
   */
  // const updateMask = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callUpdateExternalSystem() {
    // Construct request
    const request = {
      externalSystem,
    };

    // Run request
    const response = await securitycenterClient.updateExternalSystem(request);
    console.log(response);
  }

  callUpdateExternalSystem();

updateExternalSystem(request, options, callback)

updateExternalSystem(request: protos.google.cloud.securitycenter.v1.IUpdateExternalSystemRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IExternalSystem, protos.google.cloud.securitycenter.v1.IUpdateExternalSystemRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateExternalSystemRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IExternalSystem, protos.google.cloud.securitycenter.v1.IUpdateExternalSystemRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateExternalSystem(request, callback)

updateExternalSystem(request: protos.google.cloud.securitycenter.v1.IUpdateExternalSystemRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IExternalSystem, protos.google.cloud.securitycenter.v1.IUpdateExternalSystemRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateExternalSystemRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IExternalSystem, protos.google.cloud.securitycenter.v1.IUpdateExternalSystemRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateFinding(request, options)

updateFinding(request?: protos.google.cloud.securitycenter.v1.IUpdateFindingRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IFinding,
        protos.google.cloud.securitycenter.v1.IUpdateFindingRequest | undefined,
        {} | undefined
    ]>;

Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.

Parameters
Name	Description
request	IUpdateFindingRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.IUpdateFindingRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 finding resource to update or create if it does not already
   *  exist. parent, security_marks, and update_time will be ignored.
   *  In the case of creation, the finding id portion of the name must be
   *  alphanumeric and less than or equal to 32 characters and greater than 0
   *  characters in length.
   */
  // const finding = {}
  /**
   *  The FieldMask to use when updating the finding resource. This field should
   *  not be specified when creating a finding.
   *  When updating a finding, an empty mask is treated as updating all mutable
   *  fields and replacing source_properties.  Individual source_properties can
   *  be added/updated by using "source_properties.

updateFinding(request, options, callback)

updateFinding(request: protos.google.cloud.securitycenter.v1.IUpdateFindingRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.IUpdateFindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateFindingRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.IUpdateFindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateFinding(request, callback)

updateFinding(request: protos.google.cloud.securitycenter.v1.IUpdateFindingRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.IUpdateFindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateFindingRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IFinding, protos.google.cloud.securitycenter.v1.IUpdateFindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateMuteConfig(request, options)

updateMuteConfig(request?: protos.google.cloud.securitycenter.v1.IUpdateMuteConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IMuteConfig,
        (protos.google.cloud.securitycenter.v1.IUpdateMuteConfigRequest | undefined),
        {} | undefined
    ]>;

Updates a mute config.

Parameters
Name	Description
request	IUpdateMuteConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IMuteConfig, (protos.google.cloud.securitycenter.v1.IUpdateMuteConfigRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 mute config being updated.
   */
  // const muteConfig = {}
  /**
   *  The list of fields to be updated.
   *  If empty all mutable fields will be updated.
   */
  // const updateMask = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callUpdateMuteConfig() {
    // Construct request
    const request = {
      muteConfig,
    };

    // Run request
    const response = await securitycenterClient.updateMuteConfig(request);
    console.log(response);
  }

  callUpdateMuteConfig();

updateMuteConfig(request, options, callback)

updateMuteConfig(request: protos.google.cloud.securitycenter.v1.IUpdateMuteConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.IUpdateMuteConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateMuteConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.IUpdateMuteConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateMuteConfig(request, callback)

updateMuteConfig(request: protos.google.cloud.securitycenter.v1.IUpdateMuteConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.IUpdateMuteConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateMuteConfigRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IMuteConfig, protos.google.cloud.securitycenter.v1.IUpdateMuteConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateNotificationConfig(request, options)

updateNotificationConfig(request?: protos.google.cloud.securitycenter.v1.IUpdateNotificationConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.INotificationConfig,
        (protos.google.cloud.securitycenter.v1.IUpdateNotificationConfigRequest | undefined),
        {} | undefined
    ]>;

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

Parameters
Name	Description
request	IUpdateNotificationConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.INotificationConfig, (protos.google.cloud.securitycenter.v1.IUpdateNotificationConfigRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 notification config to update.
   */
  // const notificationConfig = {}
  /**
   *  The FieldMask to use when updating the notification config.
   *  If empty all mutable fields will be updated.
   */
  // const updateMask = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callUpdateNotificationConfig() {
    // Construct request
    const request = {
      notificationConfig,
    };

    // Run request
    const response = await securitycenterClient.updateNotificationConfig(request);
    console.log(response);
  }

  callUpdateNotificationConfig();

updateNotificationConfig(request, options, callback)

updateNotificationConfig(request: protos.google.cloud.securitycenter.v1.IUpdateNotificationConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.IUpdateNotificationConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateNotificationConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.IUpdateNotificationConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateNotificationConfig(request, callback)

updateNotificationConfig(request: protos.google.cloud.securitycenter.v1.IUpdateNotificationConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.IUpdateNotificationConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateNotificationConfigRequest
callback	Callback<protos.google.cloud.securitycenter.v1.INotificationConfig, protos.google.cloud.securitycenter.v1.IUpdateNotificationConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateOrganizationSettings(request, options)

updateOrganizationSettings(request?: protos.google.cloud.securitycenter.v1.IUpdateOrganizationSettingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IOrganizationSettings,
        (protos.google.cloud.securitycenter.v1.IUpdateOrganizationSettingsRequest | undefined),
        {} | undefined
    ]>;

Updates an organization's settings.

Parameters
Name	Description
request	IUpdateOrganizationSettingsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IOrganizationSettings, (protos.google.cloud.securitycenter.v1.IUpdateOrganizationSettingsRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 organization settings resource to update.
   */
  // const organizationSettings = {}
  /**
   *  The FieldMask to use when updating the settings resource.
   *  If empty all mutable fields will be updated.
   */
  // const updateMask = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callUpdateOrganizationSettings() {
    // Construct request
    const request = {
      organizationSettings,
    };

    // Run request
    const response = await securitycenterClient.updateOrganizationSettings(request);
    console.log(response);
  }

  callUpdateOrganizationSettings();

updateOrganizationSettings(request, options, callback)

updateOrganizationSettings(request: protos.google.cloud.securitycenter.v1.IUpdateOrganizationSettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IOrganizationSettings, protos.google.cloud.securitycenter.v1.IUpdateOrganizationSettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateOrganizationSettingsRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IOrganizationSettings, protos.google.cloud.securitycenter.v1.IUpdateOrganizationSettingsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateOrganizationSettings(request, callback)

updateOrganizationSettings(request: protos.google.cloud.securitycenter.v1.IUpdateOrganizationSettingsRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IOrganizationSettings, protos.google.cloud.securitycenter.v1.IUpdateOrganizationSettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateOrganizationSettingsRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IOrganizationSettings, protos.google.cloud.securitycenter.v1.IUpdateOrganizationSettingsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateResourceValueConfig(request, options)

updateResourceValueConfig(request?: protos.google.cloud.securitycenter.v1.IUpdateResourceValueConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IResourceValueConfig,
        (protos.google.cloud.securitycenter.v1.IUpdateResourceValueConfigRequest | undefined),
        {} | undefined
    ]>;

Updates an existing ResourceValueConfigs with new rules.

Parameters
Name	Description
request	IUpdateResourceValueConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IResourceValueConfig, (protos.google.cloud.securitycenter.v1.IUpdateResourceValueConfigRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 resource value config being updated.
   */
  // const resourceValueConfig = {}
  /**
   *  The list of fields to be updated.
   *  If empty all mutable fields will be updated.
   */
  // const updateMask = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callUpdateResourceValueConfig() {
    // Construct request
    const request = {
      resourceValueConfig,
    };

    // Run request
    const response = await securitycenterClient.updateResourceValueConfig(request);
    console.log(response);
  }

  callUpdateResourceValueConfig();

updateResourceValueConfig(request, options, callback)

updateResourceValueConfig(request: protos.google.cloud.securitycenter.v1.IUpdateResourceValueConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IResourceValueConfig, protos.google.cloud.securitycenter.v1.IUpdateResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateResourceValueConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IResourceValueConfig, protos.google.cloud.securitycenter.v1.IUpdateResourceValueConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateResourceValueConfig(request, callback)

updateResourceValueConfig(request: protos.google.cloud.securitycenter.v1.IUpdateResourceValueConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IResourceValueConfig, protos.google.cloud.securitycenter.v1.IUpdateResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateResourceValueConfigRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IResourceValueConfig, protos.google.cloud.securitycenter.v1.IUpdateResourceValueConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateSecurityHealthAnalyticsCustomModule(request, options)

updateSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycenter.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule,
        (protos.google.cloud.securitycenter.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.

Parameters
Name	Description
request	IUpdateSecurityHealthAnalyticsCustomModuleRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, (protos.google.cloud.securitycenter.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 SecurityHealthAnalytics custom module to update.
   */
  // const securityHealthAnalyticsCustomModule = {}
  /**
   *  The list of fields to be updated. The only fields that can be updated are
   *  `enablement_state` and `custom_config`. If empty or set to the wildcard
   *  value `*`, both `enablement_state` and `custom_config` are updated.
   */
  // const updateMask = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callUpdateSecurityHealthAnalyticsCustomModule() {
    // Construct request
    const request = {
      securityHealthAnalyticsCustomModule,
    };

    // Run request
    const response = await securitycenterClient.updateSecurityHealthAnalyticsCustomModule(request);
    console.log(response);
  }

  callUpdateSecurityHealthAnalyticsCustomModule();

updateSecurityHealthAnalyticsCustomModule(request, options, callback)

updateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateSecurityHealthAnalyticsCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateSecurityHealthAnalyticsCustomModule(request, callback)

updateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycenter.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateSecurityHealthAnalyticsCustomModuleRequest
callback	Callback<protos.google.cloud.securitycenter.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycenter.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateSecurityMarks(request, options)

updateSecurityMarks(request?: protos.google.cloud.securitycenter.v1.IUpdateSecurityMarksRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISecurityMarks,
        (protos.google.cloud.securitycenter.v1.IUpdateSecurityMarksRequest | undefined),
        {} | undefined
    ]>;

Updates security marks.

Parameters
Name	Description
request	IUpdateSecurityMarksRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISecurityMarks, (protos.google.cloud.securitycenter.v1.IUpdateSecurityMarksRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing SecurityMarks. 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 security marks resource to update.
   */
  // const securityMarks = {}
  /**
   *  The FieldMask to use when updating the security marks resource.
   *  The field mask must not contain duplicate fields.
   *  If empty or set to "marks", all marks will be replaced.  Individual
   *  marks can be updated using "marks.

updateSecurityMarks(request, options, callback)

updateSecurityMarks(request: protos.google.cloud.securitycenter.v1.IUpdateSecurityMarksRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.ISecurityMarks, protos.google.cloud.securitycenter.v1.IUpdateSecurityMarksRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateSecurityMarksRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.ISecurityMarks, protos.google.cloud.securitycenter.v1.IUpdateSecurityMarksRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateSecurityMarks(request, callback)

updateSecurityMarks(request: protos.google.cloud.securitycenter.v1.IUpdateSecurityMarksRequest, callback: Callback<protos.google.cloud.securitycenter.v1.ISecurityMarks, protos.google.cloud.securitycenter.v1.IUpdateSecurityMarksRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateSecurityMarksRequest
callback	Callback<protos.google.cloud.securitycenter.v1.ISecurityMarks, protos.google.cloud.securitycenter.v1.IUpdateSecurityMarksRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateSource(request, options)

updateSource(request?: protos.google.cloud.securitycenter.v1.IUpdateSourceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.ISource,
        protos.google.cloud.securitycenter.v1.IUpdateSourceRequest | undefined,
        {} | undefined
    ]>;

Updates a source.

Parameters
Name	Description
request	IUpdateSourceRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.IUpdateSourceRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Source. 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 source resource to update.
   */
  // const source = {}
  /**
   *  The FieldMask to use when updating the source resource.
   *  If empty all mutable fields will be updated.
   */
  // const updateMask = {}

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

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

    // Run request
    const response = await securitycenterClient.updateSource(request);
    console.log(response);
  }

  callUpdateSource();

updateSource(request, options, callback)

updateSource(request: protos.google.cloud.securitycenter.v1.IUpdateSourceRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.IUpdateSourceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateSourceRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.IUpdateSourceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateSource(request, callback)

updateSource(request: protos.google.cloud.securitycenter.v1.IUpdateSourceRequest, callback: Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.IUpdateSourceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateSourceRequest
callback	Callback<protos.google.cloud.securitycenter.v1.ISource, protos.google.cloud.securitycenter.v1.IUpdateSourceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

validateEventThreatDetectionCustomModule(request, options)

validateEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleResponse,
        (protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Validates the given Event Threat Detection custom module.

Parameters
Name	Description
request	IValidateEventThreatDetectionCustomModuleRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleResponse, (protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing ValidateEventThreatDetectionCustomModuleResponse. 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. Resource name of the parent to validate the Custom Module under.
   *  Its format is:
   *    * `organizations/{organization}/eventThreatDetectionSettings`.
   *    * `folders/{folder}/eventThreatDetectionSettings`.
   *    * `projects/{project}/eventThreatDetectionSettings`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The raw text of the module's contents. Used to generate error
   *  messages.
   */
  // const rawText = 'abc123'
  /**
   *  Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
   */
  // const type = 'abc123'

  // Imports the Securitycenter library
  const {SecurityCenterClient} = require('@google-cloud/security-center').v1;

  // Instantiates a client
  const securitycenterClient = new SecurityCenterClient();

  async function callValidateEventThreatDetectionCustomModule() {
    // Construct request
    const request = {
      parent,
      rawText,
      type,
    };

    // Run request
    const response = await securitycenterClient.validateEventThreatDetectionCustomModule(request);
    console.log(response);
  }

  callValidateEventThreatDetectionCustomModule();

validateEventThreatDetectionCustomModule(request, options, callback)

validateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IValidateEventThreatDetectionCustomModuleRequest
options	CallOptions
callback	Callback<protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

validateEventThreatDetectionCustomModule(request, callback)

validateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IValidateEventThreatDetectionCustomModuleRequest
callback	Callback<protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycenter.v1.IValidateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

valuedResourcePath(organization, simulation, valuedResource)

valuedResourcePath(organization: string, simulation: string, valuedResource: string): string;

Return a fully-qualified valuedResource resource name string.

Parameters
Name	Description
organization	string
simulation	string
valuedResource	string

Returns
Type	Description
string	{string} Resource name string.