Class v1.SecurityCenterManagementClient (0.8.0)

Service describing handlers for resources v1

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of SecurityCenterManagementClient.

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 SecurityCenterManagementClient({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;
    };

locationsClient

locationsClient: LocationsClient;

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.

securityCenterManagementStub

securityCenterManagementStub?: 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

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.

createEventThreatDetectionCustomModule(request, options)

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

Creates a resident Event Threat Detection custom module at the scope of the given organization, folder, or project, and 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.securitycentermanagement.v1.IEventThreatDetectionCustomModule, (protos.google.cloud.securitycentermanagement.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. Name of parent for the module, in one of the following formats:
   *  * `organizations/{organization}/locations/{location}`
   *  * `folders/{folder}/locations/{location}`
   *  * `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The module to create. The
   *  EventThreatDetectionCustomModule.name google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule.name 
   *  field is ignored; Security Command Center generates the name.
   */
  // const eventThreatDetectionCustomModule = {}
  /**
   *  Optional. When set to `true`, the request will be validated (including IAM
   *  checks), but no module will be created. An `OK` response indicates that the
   *  request is valid, while an error response indicates that the request is
   *  invalid.
   *  If the request is valid, a subsequent request to create the module could
   *  still fail for one of the following reasons:
   *  *  The state of your cloud resources changed; for example, you lost a
   *     required IAM permission
   *  *  An error occurred during creation of the module
   *  Defaults to `false`.
   */
  // const validateOnly = true

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callCreateEventThreatDetectionCustomModule();

createEventThreatDetectionCustomModule(request, options, callback)

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

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

Returns
Type	Description
`void`

createEventThreatDetectionCustomModule(request, callback)

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

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

Returns
Type	Description
`void`

createSecurityHealthAnalyticsCustomModule(request, options)

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

Creates a resident at the scope of the given organization, folder, or project, and also creates inherited SecurityHealthAnalyticsCustomModule resources for all folders and projects that are 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.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, (protos.google.cloud.securitycentermanagement.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. Name of the parent organization, folder, or project of the
   *  module, in one of the following formats:
   *  * `organizations/{organization}/locations/{location}`
   *  * `folders/{folder}/locations/{location}`
   *  * `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource being created.
   */
  // const securityHealthAnalyticsCustomModule = {}
  /**
   *  Optional. When set to `true`, the request will be validated (including IAM
   *  checks), but no module will be created. An `OK` response indicates that the
   *  request is valid, while an error response indicates that the request is
   *  invalid.
   *  If the request is valid, a subsequent request to create the module could
   *  still fail for one of the following reasons:
   *  *  The state of your cloud resources changed; for example, you lost a
   *     required IAM permission
   *  *  An error occurred during creation of the module
   *  Defaults to `false`.
   */
  // const validateOnly = true

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callCreateSecurityHealthAnalyticsCustomModule();

createSecurityHealthAnalyticsCustomModule(request, options, callback)

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

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

Returns
Type	Description
`void`

createSecurityHealthAnalyticsCustomModule(request, callback)

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

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

Returns
Type	Description
`void`

deleteEventThreatDetectionCustomModule(request, options)

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

Deletes the specified Event Threat Detection custom module and all of its descendants in the resource 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.securitycentermanagement.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. The resource name of the Event Threat Detection custom module, in
   *  one of the following formats:
   *  * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
   *  * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
   *  * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
   */
  // const name = 'abc123'
  /**
   *  Optional. When set to `true`, the request will be validated (including IAM
   *  checks), but no module will be deleted. An `OK` response indicates that the
   *  request is valid, while an error response indicates that the request is
   *  invalid.
   *  If the request is valid, a subsequent request to delete the module could
   *  still fail for one of the following reasons:
   *  *  The state of your cloud resources changed; for example, you lost a
   *     required IAM permission
   *  *  An error occurred during creation of the module
   *  Defaults to `false`.
   */
  // const validateOnly = true

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callDeleteEventThreatDetectionCustomModule();

deleteEventThreatDetectionCustomModule(request, options, callback)

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

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

Returns
Type	Description
`void`

deleteEventThreatDetectionCustomModule(request, callback)

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

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

Returns
Type	Description
`void`

deleteSecurityHealthAnalyticsCustomModule(request, options)

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

Deletes the specified and all of its descendants in the resource 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.securitycentermanagement.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. The resource name of the SHA custom module, in one of the
   *  following formats:
   *    * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
   *    * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
   *    * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
   */
  // const name = 'abc123'
  /**
   *  Optional. When set to `true`, the request will be validated (including IAM
   *  checks), but no module will be deleted. An `OK` response indicates that the
   *  request is valid, while an error response indicates that the request is
   *  invalid.
   *  If the request is valid, a subsequent request to delete the module could
   *  still fail for one of the following reasons:
   *  *  The state of your cloud resources changed; for example, you lost a
   *     required IAM permission
   *  *  An error occurred during deletion of the module
   *  Defaults to `false`.
   */
  // const validateOnly = true

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callDeleteSecurityHealthAnalyticsCustomModule();

deleteSecurityHealthAnalyticsCustomModule(request, options, callback)

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

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

Returns
Type	Description
`void`

deleteSecurityHealthAnalyticsCustomModule(request, callback)

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

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

Returns
Type	Description
`void`

folderLocationEffectiveEventThreatDetectionCustomModulesPath(folder, location, effectiveEventThreatDetectionCustomModule)

folderLocationEffectiveEventThreatDetectionCustomModulesPath(folder: string, location: string, effectiveEventThreatDetectionCustomModule: string): string;

Return a fully-qualified folderLocationEffectiveEventThreatDetectionCustomModules resource name string.

Parameters
Name	Description
`folder`	`string`
`location`	`string`
`effectiveEventThreatDetectionCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

folderLocationEffectiveSecurityHealthAnalyticsCustomModulesPath(folder, location, effectiveSecurityHealthAnalyticsCustomModule)

folderLocationEffectiveSecurityHealthAnalyticsCustomModulesPath(folder: string, location: string, effectiveSecurityHealthAnalyticsCustomModule: string): string;

Return a fully-qualified folderLocationEffectiveSecurityHealthAnalyticsCustomModules resource name string.

Parameters
Name	Description
`folder`	`string`
`location`	`string`
`effectiveSecurityHealthAnalyticsCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

folderLocationEventThreatDetectionCustomModulesPath(folder, location, eventThreatDetectionCustomModule)

folderLocationEventThreatDetectionCustomModulesPath(folder: string, location: string, eventThreatDetectionCustomModule: string): string;

Return a fully-qualified folderLocationEventThreatDetectionCustomModules resource name string.

Parameters
Name	Description
`folder`	`string`
`location`	`string`
`eventThreatDetectionCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

folderLocationSecurityCenterServicesPath(folder, location, service)

folderLocationSecurityCenterServicesPath(folder: string, location: string, service: string): string;

Return a fully-qualified folderLocationSecurityCenterServices resource name string.

Parameters
Name	Description
`folder`	`string`
`location`	`string`
`service`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

folderLocationSecurityHealthAnalyticsCustomModulesPath(folder, location, securityHealthAnalyticsCustomModule)

folderLocationSecurityHealthAnalyticsCustomModulesPath(folder: string, location: string, securityHealthAnalyticsCustomModule: string): string;

Return a fully-qualified folderLocationSecurityHealthAnalyticsCustomModules resource name string.

Parameters
Name	Description
`folder`	`string`
`location`	`string`
`securityHealthAnalyticsCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

folderSourceFindingsPath(folder, source, finding)

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

Return a fully-qualified folderSourceFindings resource name string.

Parameters
Name	Description
`folder`	`string`
`source`	`string`
`finding`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

getEffectiveEventThreatDetectionCustomModule(request, options)

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

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

The difference between an and an is that the fields for an EffectiveEventThreatDetectionCustomModule are computed from ancestors if needed. For example, the enablement state for an EventThreatDetectionCustomModule can be ENABLED, DISABLED, or INHERITED. In contrast, the enablement state for an EffectiveEventThreatDetectionCustomModule is always computed as ENABLED or DISABLED.

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.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule, (protos.google.cloud.securitycentermanagement.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 Event Threat Detection custom module, in
   *  one of the following formats:
   *  * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
   *  * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
   *  * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
   */
  // const name = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callGetEffectiveEventThreatDetectionCustomModule();

getEffectiveEventThreatDetectionCustomModule(request, options, callback)

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

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

Returns
Type	Description
`void`

getEffectiveEventThreatDetectionCustomModule(request, callback)

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

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

Returns
Type	Description
`void`

getEffectiveSecurityHealthAnalyticsCustomModule(request, options)

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

Gets details of a single .

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.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule, (protos.google.cloud.securitycentermanagement.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. The full resource name of the custom module, specified in one of
   *  the following formats:
   *  * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
   *  * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
   *  * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
   */
  // const name = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callGetEffectiveSecurityHealthAnalyticsCustomModule();

getEffectiveSecurityHealthAnalyticsCustomModule(request, options, callback)

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

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

Returns
Type	Description
`void`

getEffectiveSecurityHealthAnalyticsCustomModule(request, callback)

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

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

Returns
Type	Description
`void`

getEventThreatDetectionCustomModule(request, options)

getEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IGetEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule,
        (protos.google.cloud.securitycentermanagement.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.securitycentermanagement.v1.IEventThreatDetectionCustomModule, (protos.google.cloud.securitycentermanagement.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. The resource name of the Event Threat Detection custom module, in
   *  one of the following formats:
   *  * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
   *  * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
   *  * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
   */
  // const name = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callGetEventThreatDetectionCustomModule();

getEventThreatDetectionCustomModule(request, options, callback)

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

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

Returns
Type	Description
`void`

getEventThreatDetectionCustomModule(request, callback)

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

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

Returns
Type	Description
`void`

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IGetLocationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>` Call options. See CallOptions for more details.
`callback`	`Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`Promise<google.cloud.location.ILocation>`	{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


const [response] = await client.getLocation(request);

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`

getSecurityCenterService(request, options)

getSecurityCenterService(request?: protos.google.cloud.securitycentermanagement.v1.IGetSecurityCenterServiceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService,
        (protos.google.cloud.securitycentermanagement.v1.IGetSecurityCenterServiceRequest | undefined),
        {} | undefined
    ]>;

Gets service settings for the specified Security Command Center service.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService, (protos.google.cloud.securitycentermanagement.v1.IGetSecurityCenterServiceRequest \| 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 Security Command Center service to retrieve, in one of the
   *  following formats:
   *  * organizations/{organization}/locations/{location}/securityCenterServices/{service}
   *  * folders/{folder}/locations/{location}/securityCenterServices/{service}
   *  * projects/{project}/locations/{location}/securityCenterServices/{service}
   *  The following values are valid for `{service}`:
   *  * `container-threat-detection`
   *  * `event-threat-detection`
   *  * `security-health-analytics`
   *  * `vm-threat-detection`
   *  * `web-security-scanner`
   */
  // const name = 'abc123'
  /**
   *  Set to `true` to show only modules that are in scope. By default, all
   *  modules are shown.
   */
  // const showEligibleModulesOnly = true

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

    // Run request
    const response = await securitycentermanagementClient.getSecurityCenterService(request);
    console.log(response);
  }

  callGetSecurityCenterService();

getSecurityCenterService(request, options, callback)

getSecurityCenterService(request: protos.google.cloud.securitycentermanagement.v1.IGetSecurityCenterServiceRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService, protos.google.cloud.securitycentermanagement.v1.IGetSecurityCenterServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetSecurityCenterServiceRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService, protos.google.cloud.securitycentermanagement.v1.IGetSecurityCenterServiceRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getSecurityCenterService(request, callback)

getSecurityCenterService(request: protos.google.cloud.securitycentermanagement.v1.IGetSecurityCenterServiceRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService, protos.google.cloud.securitycentermanagement.v1.IGetSecurityCenterServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetSecurityCenterServiceRequest`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService, protos.google.cloud.securitycentermanagement.v1.IGetSecurityCenterServiceRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getSecurityHealthAnalyticsCustomModule(request, options)

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

Retrieves a .

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.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, (protos.google.cloud.securitycentermanagement.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 resource, in the format
   *  `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`.
   */
  // const name = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callGetSecurityHealthAnalyticsCustomModule();

getSecurityHealthAnalyticsCustomModule(request, options, callback)

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

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

Returns
Type	Description
`void`

getSecurityHealthAnalyticsCustomModule(request, callback)

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

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

Returns
Type	Description
`void`

initialize()

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

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
`Promise<{ [name: string]: Function; }>`	{Promise} A promise that resolves to an authenticated service stub.

listDescendantEventThreatDetectionCustomModules(request, options)

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

Lists all resident Event Threat Detection custom modules for the given organization, folder, or project 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.securitycentermanagement.v1.IEventThreatDetectionCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.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.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>): void;

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

Returns
Type	Description
`void`

listDescendantEventThreatDetectionCustomModules(request, callback)

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

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

Returns
Type	Description
`void`

listDescendantEventThreatDetectionCustomModulesAsync(request, options)

listDescendantEventThreatDetectionCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.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.securitycentermanagement.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 parent to list custom modules, in one of the following
   *  formats:
   *  * `organizations/{organization}/locations/{location}`
   *  * `folders/{folder}/locations/{location}`
   *  * `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. 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
  /**
   *  Optional. A pagination token returned from a previous request. Provide this
   *  token to retrieve the next page of results.
   *  When paginating, the rest of the request must match the request that
   *  generated the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callListDescendantEventThreatDetectionCustomModules();

listDescendantEventThreatDetectionCustomModulesStream(request, options)

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

Equivalent to listDescendantEventThreatDetectionCustomModules, 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.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse
    ]>;

Returns a list of all resident resources under the given organization, folder, or project and all of its 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.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.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.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>): void;

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

Returns
Type	Description
`void`

listDescendantSecurityHealthAnalyticsCustomModules(request, callback)

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

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

Returns
Type	Description
`void`

listDescendantSecurityHealthAnalyticsCustomModulesAsync(request, options)

listDescendantSecurityHealthAnalyticsCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.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.securitycentermanagement.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 the parent organization, folder, or project in which to
   *  list custom modules, in one of the following formats:
   *  * `organizations/{organization}/locations/{location}`
   *  * `folders/{folder}/locations/{location}`
   *  * `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of results to return in a single response.
   *  Default is 10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous request. Provide this
   *  token to retrieve the next page of results.
   *  When paginating, the rest of the request must match the request that
   *  generated the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callListDescendantSecurityHealthAnalyticsCustomModules();

listDescendantSecurityHealthAnalyticsCustomModulesStream(request, options)

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

Equivalent to listDescendantSecurityHealthAnalyticsCustomModules, 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.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.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.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.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.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule>): void;

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

Returns
Type	Description
`void`

listEffectiveEventThreatDetectionCustomModules(request, callback)

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

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

Returns
Type	Description
`void`

listEffectiveEventThreatDetectionCustomModulesAsync(request, options)

listEffectiveEventThreatDetectionCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.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.securitycentermanagement.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 parent to list effective custom modules, in one of the
   *  following formats:
   *  * `organizations/{organization}/locations/{location}`
   *  * `folders/{folder}/locations/{location}`
   *  * `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of results to return in a single response.
   *  Default is 10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous request. Provide this
   *  token to retrieve the next page of results.
   *  When paginating, the rest of the request must match the request that
   *  generated the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callListEffectiveEventThreatDetectionCustomModules();

listEffectiveEventThreatDetectionCustomModulesStream(request, options)

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

Equivalent to listEffectiveEventThreatDetectionCustomModules, 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.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse
    ]>;

Returns a list of all resources for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from ancestor organizations, folders, and projects (no descendants).

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.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.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.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule>): void;

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

Returns
Type	Description
`void`

listEffectiveSecurityHealthAnalyticsCustomModules(request, callback)

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

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

Returns
Type	Description
`void`

listEffectiveSecurityHealthAnalyticsCustomModulesAsync(request, options)

listEffectiveSecurityHealthAnalyticsCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.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.securitycentermanagement.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, in one of the
   *  following formats:
   *  * `organizations/{organization}/locations/{location}`
   *  * `folders/{folder}/locations/{location}`
   *  * `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of results to return in a single response.
   *  Default is 10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous request. Provide this
   *  token to retrieve the next page of results.
   *  When paginating, the rest of the request must match the request that
   *  generated the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callListEffectiveSecurityHealthAnalyticsCustomModules();

listEffectiveSecurityHealthAnalyticsCustomModulesStream(request, options)

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

Equivalent to listEffectiveSecurityHealthAnalyticsCustomModules, 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.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesResponse
    ]>;

Lists all Event Threat Detection custom modules for the given organization, folder, or project. 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.securitycentermanagement.v1.IEventThreatDetectionCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.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.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>): void;

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

Returns
Type	Description
`void`

listEventThreatDetectionCustomModules(request, callback)

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

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

Returns
Type	Description
`void`

listEventThreatDetectionCustomModulesAsync(request, options)

listEventThreatDetectionCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.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.securitycentermanagement.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 parent to list custom modules, in one of the following
   *  formats:
   *  * `organizations/{organization}/locations/{location}`
   *  * `folders/{folder}/locations/{location}`
   *  * `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of modules to return. The service may return
   *  fewer than this value. If unspecified, at most 10 modules will be returned.
   *  The maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous request. Provide this
   *  token to retrieve the next page of results.
   *  When paginating, the rest of the request must match the request that
   *  generated the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callListEventThreatDetectionCustomModules();

listEventThreatDetectionCustomModulesStream(request, options)

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

Equivalent to listEventThreatDetectionCustomModules, 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.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IListLocationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<google.cloud.location.ILocation>`	{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


const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listSecurityCenterServices(request, options)

listSecurityCenterServices(request?: protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService[],
        protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest | null,
        protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesResponse
    ]>;

Returns a list of all Security Command Center services for the given parent.

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

Returns

Type Description

Promise<[
        protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService[],
        protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest | null,
        protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesResponse
    ]>

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

listSecurityCenterServices(request, options, callback)

listSecurityCenterServices(request: protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest, protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService>): void;

Parameters
Name	Description
`request`	`IListSecurityCenterServicesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest, protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesResponse \| null \| undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService>`

Returns
Type	Description
`void`

listSecurityCenterServices(request, callback)

listSecurityCenterServices(request: protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest, protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService>): void;

Parameters
Name	Description
`request`	`IListSecurityCenterServicesRequest`
`callback`	`PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest, protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesResponse \| null \| undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService>`

Returns
Type	Description
`void`

listSecurityCenterServicesAsync(request, options)

listSecurityCenterServicesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService>;

Equivalent to listSecurityCenterServices, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService>`	{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 to list Security Command Center services,
   *  in one of the following formats:
   *  * `organizations/{organization}/locations/{location}`
   *  * `folders/{folder}/locations/{location}`
   *  * `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of results to return in a single response.
   *  Default is 10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous request. Provide this
   *  token to retrieve the next page of results.
   *  When paginating, the rest of the request must match the request that
   *  generated the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Flag that, when set, is used to filter the module settings that are shown.
   *  The default setting is that all modules are shown.
   */
  // const showEligibleModulesOnly = true

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callListSecurityCenterServices();

listSecurityCenterServicesStream(request, options)

listSecurityCenterServicesStream(request?: protos.google.cloud.securitycentermanagement.v1.IListSecurityCenterServicesRequest, options?: CallOptions): Transform;

Equivalent to listSecurityCenterServices, but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`IListSecurityCenterServicesRequest` 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 listSecurityCenterServicesAsync() 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.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesResponse
    ]>;

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.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule[],
        protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest | null,
        protos.google.cloud.securitycentermanagement.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.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>): void;

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

Returns
Type	Description
`void`

listSecurityHealthAnalyticsCustomModules(request, callback)

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

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

Returns
Type	Description
`void`

listSecurityHealthAnalyticsCustomModulesAsync(request, options)

listSecurityHealthAnalyticsCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.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.securitycentermanagement.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 the parent organization, folder, or project in which to
   *  list custom modules, in one of the following formats:
   *  * `organizations/{organization}/locations/{location}`
   *  * `folders/{folder}/locations/{location}`
   *  * `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of results to return in a single response.
   *  Default is 10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous request. Provide this
   *  token to retrieve the next page of results.
   *  When paginating, the rest of the request must match the request that
   *  generated the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

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

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

  callListSecurityHealthAnalyticsCustomModules();

listSecurityHealthAnalyticsCustomModulesStream(request, options)

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

Equivalent to listSecurityHealthAnalyticsCustomModules, 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.

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

matchEffectiveEventThreatDetectionCustomModuleFromFolderLocationEffectiveEventThreatDetectionCustomModulesName(folderLocationEffectiveEventThreatDetectionCustomModulesName)

matchEffectiveEventThreatDetectionCustomModuleFromFolderLocationEffectiveEventThreatDetectionCustomModulesName(folderLocationEffectiveEventThreatDetectionCustomModulesName: string): string | number;

Parse the effective_event_threat_detection_custom_module from FolderLocationEffectiveEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`folderLocationEffectiveEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing folder_location_effectiveEventThreatDetectionCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the effective_event_threat_detection_custom_module.

matchEffectiveEventThreatDetectionCustomModuleFromOrganizationLocationEffectiveEventThreatDetectionCustomModulesName(organizationLocationEffectiveEventThreatDetectionCustomModulesName)

matchEffectiveEventThreatDetectionCustomModuleFromOrganizationLocationEffectiveEventThreatDetectionCustomModulesName(organizationLocationEffectiveEventThreatDetectionCustomModulesName: string): string | number;

Parse the effective_event_threat_detection_custom_module from OrganizationLocationEffectiveEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`organizationLocationEffectiveEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing organization_location_effectiveEventThreatDetectionCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the effective_event_threat_detection_custom_module.

matchEffectiveEventThreatDetectionCustomModuleFromProjectLocationEffectiveEventThreatDetectionCustomModulesName(projectLocationEffectiveEventThreatDetectionCustomModulesName)

matchEffectiveEventThreatDetectionCustomModuleFromProjectLocationEffectiveEventThreatDetectionCustomModulesName(projectLocationEffectiveEventThreatDetectionCustomModulesName: string): string | number;

Parse the effective_event_threat_detection_custom_module from ProjectLocationEffectiveEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`projectLocationEffectiveEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing project_location_effectiveEventThreatDetectionCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the effective_event_threat_detection_custom_module.

matchEffectiveSecurityHealthAnalyticsCustomModuleFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModulesName(folderLocationEffectiveSecurityHealthAnalyticsCustomModulesName)

matchEffectiveSecurityHealthAnalyticsCustomModuleFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModulesName(folderLocationEffectiveSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the effective_security_health_analytics_custom_module from FolderLocationEffectiveSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`folderLocationEffectiveSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing folder_location_effectiveSecurityHealthAnalyticsCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the effective_security_health_analytics_custom_module.

matchEffectiveSecurityHealthAnalyticsCustomModuleFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName)

matchEffectiveSecurityHealthAnalyticsCustomModuleFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the effective_security_health_analytics_custom_module from OrganizationLocationEffectiveSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing organization_location_effectiveSecurityHealthAnalyticsCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the effective_security_health_analytics_custom_module.

matchEffectiveSecurityHealthAnalyticsCustomModuleFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModulesName(projectLocationEffectiveSecurityHealthAnalyticsCustomModulesName)

matchEffectiveSecurityHealthAnalyticsCustomModuleFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModulesName(projectLocationEffectiveSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the effective_security_health_analytics_custom_module from ProjectLocationEffectiveSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`projectLocationEffectiveSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing project_location_effectiveSecurityHealthAnalyticsCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the effective_security_health_analytics_custom_module.

matchEventThreatDetectionCustomModuleFromFolderLocationEventThreatDetectionCustomModulesName(folderLocationEventThreatDetectionCustomModulesName)

matchEventThreatDetectionCustomModuleFromFolderLocationEventThreatDetectionCustomModulesName(folderLocationEventThreatDetectionCustomModulesName: string): string | number;

Parse the event_threat_detection_custom_module from FolderLocationEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`folderLocationEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing folder_location_eventThreatDetectionCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the event_threat_detection_custom_module.

matchEventThreatDetectionCustomModuleFromOrganizationLocationEventThreatDetectionCustomModulesName(organizationLocationEventThreatDetectionCustomModulesName)

matchEventThreatDetectionCustomModuleFromOrganizationLocationEventThreatDetectionCustomModulesName(organizationLocationEventThreatDetectionCustomModulesName: string): string | number;

Parse the event_threat_detection_custom_module from OrganizationLocationEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`organizationLocationEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing organization_location_eventThreatDetectionCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the event_threat_detection_custom_module.

matchEventThreatDetectionCustomModuleFromProjectLocationEventThreatDetectionCustomModulesName(projectLocationEventThreatDetectionCustomModulesName)

matchEventThreatDetectionCustomModuleFromProjectLocationEventThreatDetectionCustomModulesName(projectLocationEventThreatDetectionCustomModulesName: string): string | number;

Parse the event_threat_detection_custom_module from ProjectLocationEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`projectLocationEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing project_location_eventThreatDetectionCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the event_threat_detection_custom_module.

matchFindingFromFolderSourceFindingsName(folderSourceFindingsName)

matchFindingFromFolderSourceFindingsName(folderSourceFindingsName: string): string | number;

Parse the finding from FolderSourceFindings resource.

Parameter
Name	Description
`folderSourceFindingsName`	`string` A fully-qualified path representing folder_source_findings resource.

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

matchFindingFromOrganizationSourceFindingsName(organizationSourceFindingsName)

matchFindingFromOrganizationSourceFindingsName(organizationSourceFindingsName: string): string | number;

Parse the finding from OrganizationSourceFindings resource.

Parameter
Name	Description
`organizationSourceFindingsName`	`string` A fully-qualified path representing organization_source_findings resource.

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

matchFindingFromProjectSourceFindingsName(projectSourceFindingsName)

matchFindingFromProjectSourceFindingsName(projectSourceFindingsName: string): string | number;

Parse the finding from ProjectSourceFindings resource.

Parameter
Name	Description
`projectSourceFindingsName`	`string` A fully-qualified path representing project_source_findings resource.

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

matchFolderFromFolderLocationEffectiveEventThreatDetectionCustomModulesName(folderLocationEffectiveEventThreatDetectionCustomModulesName)

matchFolderFromFolderLocationEffectiveEventThreatDetectionCustomModulesName(folderLocationEffectiveEventThreatDetectionCustomModulesName: string): string | number;

Parse the folder from FolderLocationEffectiveEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`folderLocationEffectiveEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing folder_location_effectiveEventThreatDetectionCustomModules resource.

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

matchFolderFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModulesName(folderLocationEffectiveSecurityHealthAnalyticsCustomModulesName)

matchFolderFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModulesName(folderLocationEffectiveSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the folder from FolderLocationEffectiveSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`folderLocationEffectiveSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing folder_location_effectiveSecurityHealthAnalyticsCustomModules resource.

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

matchFolderFromFolderLocationEventThreatDetectionCustomModulesName(folderLocationEventThreatDetectionCustomModulesName)

matchFolderFromFolderLocationEventThreatDetectionCustomModulesName(folderLocationEventThreatDetectionCustomModulesName: string): string | number;

Parse the folder from FolderLocationEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`folderLocationEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing folder_location_eventThreatDetectionCustomModules resource.

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

matchFolderFromFolderLocationSecurityCenterServicesName(folderLocationSecurityCenterServicesName)

matchFolderFromFolderLocationSecurityCenterServicesName(folderLocationSecurityCenterServicesName: string): string | number;

Parse the folder from FolderLocationSecurityCenterServices resource.

Parameter
Name	Description
`folderLocationSecurityCenterServicesName`	`string` A fully-qualified path representing folder_location_securityCenterServices resource.

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

matchFolderFromFolderLocationSecurityHealthAnalyticsCustomModulesName(folderLocationSecurityHealthAnalyticsCustomModulesName)

matchFolderFromFolderLocationSecurityHealthAnalyticsCustomModulesName(folderLocationSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the folder from FolderLocationSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`folderLocationSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing folder_location_securityHealthAnalyticsCustomModules resource.

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

matchFolderFromFolderSourceFindingsName(folderSourceFindingsName)

matchFolderFromFolderSourceFindingsName(folderSourceFindingsName: string): string | number;

Parse the folder from FolderSourceFindings resource.

Parameter
Name	Description
`folderSourceFindingsName`	`string` A fully-qualified path representing folder_source_findings resource.

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

matchLocationFromFolderLocationEffectiveEventThreatDetectionCustomModulesName(folderLocationEffectiveEventThreatDetectionCustomModulesName)

matchLocationFromFolderLocationEffectiveEventThreatDetectionCustomModulesName(folderLocationEffectiveEventThreatDetectionCustomModulesName: string): string | number;

Parse the location from FolderLocationEffectiveEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`folderLocationEffectiveEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing folder_location_effectiveEventThreatDetectionCustomModules resource.

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

matchLocationFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModulesName(folderLocationEffectiveSecurityHealthAnalyticsCustomModulesName)

matchLocationFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModulesName(folderLocationEffectiveSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the location from FolderLocationEffectiveSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`folderLocationEffectiveSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing folder_location_effectiveSecurityHealthAnalyticsCustomModules resource.

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

matchLocationFromFolderLocationEventThreatDetectionCustomModulesName(folderLocationEventThreatDetectionCustomModulesName)

matchLocationFromFolderLocationEventThreatDetectionCustomModulesName(folderLocationEventThreatDetectionCustomModulesName: string): string | number;

Parse the location from FolderLocationEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`folderLocationEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing folder_location_eventThreatDetectionCustomModules resource.

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

matchLocationFromFolderLocationSecurityCenterServicesName(folderLocationSecurityCenterServicesName)

matchLocationFromFolderLocationSecurityCenterServicesName(folderLocationSecurityCenterServicesName: string): string | number;

Parse the location from FolderLocationSecurityCenterServices resource.

Parameter
Name	Description
`folderLocationSecurityCenterServicesName`	`string` A fully-qualified path representing folder_location_securityCenterServices resource.

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

matchLocationFromFolderLocationSecurityHealthAnalyticsCustomModulesName(folderLocationSecurityHealthAnalyticsCustomModulesName)

matchLocationFromFolderLocationSecurityHealthAnalyticsCustomModulesName(folderLocationSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the location from FolderLocationSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`folderLocationSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing folder_location_securityHealthAnalyticsCustomModules resource.

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

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name	Description
`locationName`	`string` A fully-qualified path representing Location resource.

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

matchLocationFromOrganizationLocationEffectiveEventThreatDetectionCustomModulesName(organizationLocationEffectiveEventThreatDetectionCustomModulesName)

matchLocationFromOrganizationLocationEffectiveEventThreatDetectionCustomModulesName(organizationLocationEffectiveEventThreatDetectionCustomModulesName: string): string | number;

Parse the location from OrganizationLocationEffectiveEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`organizationLocationEffectiveEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing organization_location_effectiveEventThreatDetectionCustomModules resource.

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

matchLocationFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName)

matchLocationFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the location from OrganizationLocationEffectiveSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing organization_location_effectiveSecurityHealthAnalyticsCustomModules resource.

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

matchLocationFromOrganizationLocationEventThreatDetectionCustomModulesName(organizationLocationEventThreatDetectionCustomModulesName)

matchLocationFromOrganizationLocationEventThreatDetectionCustomModulesName(organizationLocationEventThreatDetectionCustomModulesName: string): string | number;

Parse the location from OrganizationLocationEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`organizationLocationEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing organization_location_eventThreatDetectionCustomModules resource.

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

matchLocationFromOrganizationLocationName(organizationLocationName)

matchLocationFromOrganizationLocationName(organizationLocationName: string): string | number;

Parse the location from OrganizationLocation resource.

Parameter
Name	Description
`organizationLocationName`	`string` A fully-qualified path representing OrganizationLocation resource.

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

matchLocationFromOrganizationLocationSecurityCenterServicesName(organizationLocationSecurityCenterServicesName)

matchLocationFromOrganizationLocationSecurityCenterServicesName(organizationLocationSecurityCenterServicesName: string): string | number;

Parse the location from OrganizationLocationSecurityCenterServices resource.

Parameter
Name	Description
`organizationLocationSecurityCenterServicesName`	`string` A fully-qualified path representing organization_location_securityCenterServices resource.

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

matchLocationFromOrganizationLocationSecurityHealthAnalyticsCustomModulesName(organizationLocationSecurityHealthAnalyticsCustomModulesName)

matchLocationFromOrganizationLocationSecurityHealthAnalyticsCustomModulesName(organizationLocationSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the location from OrganizationLocationSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`organizationLocationSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing organization_location_securityHealthAnalyticsCustomModules resource.

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

matchLocationFromProjectLocationEffectiveEventThreatDetectionCustomModulesName(projectLocationEffectiveEventThreatDetectionCustomModulesName)

matchLocationFromProjectLocationEffectiveEventThreatDetectionCustomModulesName(projectLocationEffectiveEventThreatDetectionCustomModulesName: string): string | number;

Parse the location from ProjectLocationEffectiveEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`projectLocationEffectiveEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing project_location_effectiveEventThreatDetectionCustomModules resource.

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

matchLocationFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModulesName(projectLocationEffectiveSecurityHealthAnalyticsCustomModulesName)

matchLocationFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModulesName(projectLocationEffectiveSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the location from ProjectLocationEffectiveSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`projectLocationEffectiveSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing project_location_effectiveSecurityHealthAnalyticsCustomModules resource.

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

matchLocationFromProjectLocationEventThreatDetectionCustomModulesName(projectLocationEventThreatDetectionCustomModulesName)

matchLocationFromProjectLocationEventThreatDetectionCustomModulesName(projectLocationEventThreatDetectionCustomModulesName: string): string | number;

Parse the location from ProjectLocationEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`projectLocationEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing project_location_eventThreatDetectionCustomModules resource.

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

matchLocationFromProjectLocationSecurityCenterServicesName(projectLocationSecurityCenterServicesName)

matchLocationFromProjectLocationSecurityCenterServicesName(projectLocationSecurityCenterServicesName: string): string | number;

Parse the location from ProjectLocationSecurityCenterServices resource.

Parameter
Name	Description
`projectLocationSecurityCenterServicesName`	`string` A fully-qualified path representing project_location_securityCenterServices resource.

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

matchLocationFromProjectLocationSecurityHealthAnalyticsCustomModulesName(projectLocationSecurityHealthAnalyticsCustomModulesName)

matchLocationFromProjectLocationSecurityHealthAnalyticsCustomModulesName(projectLocationSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the location from ProjectLocationSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`projectLocationSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing project_location_securityHealthAnalyticsCustomModules resource.

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

matchOrganizationFromOrganizationLocationEffectiveEventThreatDetectionCustomModulesName(organizationLocationEffectiveEventThreatDetectionCustomModulesName)

matchOrganizationFromOrganizationLocationEffectiveEventThreatDetectionCustomModulesName(organizationLocationEffectiveEventThreatDetectionCustomModulesName: string): string | number;

Parse the organization from OrganizationLocationEffectiveEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`organizationLocationEffectiveEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing organization_location_effectiveEventThreatDetectionCustomModules resource.

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

matchOrganizationFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName)

matchOrganizationFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the organization from OrganizationLocationEffectiveSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing organization_location_effectiveSecurityHealthAnalyticsCustomModules resource.

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

matchOrganizationFromOrganizationLocationEventThreatDetectionCustomModulesName(organizationLocationEventThreatDetectionCustomModulesName)

matchOrganizationFromOrganizationLocationEventThreatDetectionCustomModulesName(organizationLocationEventThreatDetectionCustomModulesName: string): string | number;

Parse the organization from OrganizationLocationEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`organizationLocationEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing organization_location_eventThreatDetectionCustomModules resource.

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

matchOrganizationFromOrganizationLocationName(organizationLocationName)

matchOrganizationFromOrganizationLocationName(organizationLocationName: string): string | number;

Parse the organization from OrganizationLocation resource.

Parameter
Name	Description
`organizationLocationName`	`string` A fully-qualified path representing OrganizationLocation resource.

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

matchOrganizationFromOrganizationLocationSecurityCenterServicesName(organizationLocationSecurityCenterServicesName)

matchOrganizationFromOrganizationLocationSecurityCenterServicesName(organizationLocationSecurityCenterServicesName: string): string | number;

Parse the organization from OrganizationLocationSecurityCenterServices resource.

Parameter
Name	Description
`organizationLocationSecurityCenterServicesName`	`string` A fully-qualified path representing organization_location_securityCenterServices resource.

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

matchOrganizationFromOrganizationLocationSecurityHealthAnalyticsCustomModulesName(organizationLocationSecurityHealthAnalyticsCustomModulesName)

matchOrganizationFromOrganizationLocationSecurityHealthAnalyticsCustomModulesName(organizationLocationSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the organization from OrganizationLocationSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`organizationLocationSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing organization_location_securityHealthAnalyticsCustomModules 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.

matchOrganizationFromOrganizationSourceFindingsName(organizationSourceFindingsName)

matchOrganizationFromOrganizationSourceFindingsName(organizationSourceFindingsName: string): string | number;

Parse the organization from OrganizationSourceFindings resource.

Parameter
Name	Description
`organizationSourceFindingsName`	`string` A fully-qualified path representing organization_source_findings resource.

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

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name	Description
`locationName`	`string` A fully-qualified path representing Location resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationEffectiveEventThreatDetectionCustomModulesName(projectLocationEffectiveEventThreatDetectionCustomModulesName)

matchProjectFromProjectLocationEffectiveEventThreatDetectionCustomModulesName(projectLocationEffectiveEventThreatDetectionCustomModulesName: string): string | number;

Parse the project from ProjectLocationEffectiveEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`projectLocationEffectiveEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing project_location_effectiveEventThreatDetectionCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModulesName(projectLocationEffectiveSecurityHealthAnalyticsCustomModulesName)

matchProjectFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModulesName(projectLocationEffectiveSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the project from ProjectLocationEffectiveSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`projectLocationEffectiveSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing project_location_effectiveSecurityHealthAnalyticsCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationEventThreatDetectionCustomModulesName(projectLocationEventThreatDetectionCustomModulesName)

matchProjectFromProjectLocationEventThreatDetectionCustomModulesName(projectLocationEventThreatDetectionCustomModulesName: string): string | number;

Parse the project from ProjectLocationEventThreatDetectionCustomModules resource.

Parameter
Name	Description
`projectLocationEventThreatDetectionCustomModulesName`	`string` A fully-qualified path representing project_location_eventThreatDetectionCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationSecurityCenterServicesName(projectLocationSecurityCenterServicesName)

matchProjectFromProjectLocationSecurityCenterServicesName(projectLocationSecurityCenterServicesName: string): string | number;

Parse the project from ProjectLocationSecurityCenterServices resource.

Parameter
Name	Description
`projectLocationSecurityCenterServicesName`	`string` A fully-qualified path representing project_location_securityCenterServices resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationSecurityHealthAnalyticsCustomModulesName(projectLocationSecurityHealthAnalyticsCustomModulesName)

matchProjectFromProjectLocationSecurityHealthAnalyticsCustomModulesName(projectLocationSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the project from ProjectLocationSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`projectLocationSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing project_location_securityHealthAnalyticsCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name	Description
`projectName`	`string` A fully-qualified path representing Project resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectSourceFindingsName(projectSourceFindingsName)

matchProjectFromProjectSourceFindingsName(projectSourceFindingsName: string): string | number;

Parse the project from ProjectSourceFindings resource.

Parameter
Name	Description
`projectSourceFindingsName`	`string` A fully-qualified path representing project_source_findings resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchSecurityHealthAnalyticsCustomModuleFromFolderLocationSecurityHealthAnalyticsCustomModulesName(folderLocationSecurityHealthAnalyticsCustomModulesName)

matchSecurityHealthAnalyticsCustomModuleFromFolderLocationSecurityHealthAnalyticsCustomModulesName(folderLocationSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the security_health_analytics_custom_module from FolderLocationSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`folderLocationSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing folder_location_securityHealthAnalyticsCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the security_health_analytics_custom_module.

matchSecurityHealthAnalyticsCustomModuleFromOrganizationLocationSecurityHealthAnalyticsCustomModulesName(organizationLocationSecurityHealthAnalyticsCustomModulesName)

matchSecurityHealthAnalyticsCustomModuleFromOrganizationLocationSecurityHealthAnalyticsCustomModulesName(organizationLocationSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the security_health_analytics_custom_module from OrganizationLocationSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`organizationLocationSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing organization_location_securityHealthAnalyticsCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the security_health_analytics_custom_module.

matchSecurityHealthAnalyticsCustomModuleFromProjectLocationSecurityHealthAnalyticsCustomModulesName(projectLocationSecurityHealthAnalyticsCustomModulesName)

matchSecurityHealthAnalyticsCustomModuleFromProjectLocationSecurityHealthAnalyticsCustomModulesName(projectLocationSecurityHealthAnalyticsCustomModulesName: string): string | number;

Parse the security_health_analytics_custom_module from ProjectLocationSecurityHealthAnalyticsCustomModules resource.

Parameter
Name	Description
`projectLocationSecurityHealthAnalyticsCustomModulesName`	`string` A fully-qualified path representing project_location_securityHealthAnalyticsCustomModules resource.

Returns
Type	Description
`string \| number`	{string} A string representing the security_health_analytics_custom_module.

matchServiceFromFolderLocationSecurityCenterServicesName(folderLocationSecurityCenterServicesName)

matchServiceFromFolderLocationSecurityCenterServicesName(folderLocationSecurityCenterServicesName: string): string | number;

Parse the service from FolderLocationSecurityCenterServices resource.

Parameter
Name	Description
`folderLocationSecurityCenterServicesName`	`string` A fully-qualified path representing folder_location_securityCenterServices resource.

Returns
Type	Description
`string \| number`	{string} A string representing the service.

matchServiceFromOrganizationLocationSecurityCenterServicesName(organizationLocationSecurityCenterServicesName)

matchServiceFromOrganizationLocationSecurityCenterServicesName(organizationLocationSecurityCenterServicesName: string): string | number;

Parse the service from OrganizationLocationSecurityCenterServices resource.

Parameter
Name	Description
`organizationLocationSecurityCenterServicesName`	`string` A fully-qualified path representing organization_location_securityCenterServices resource.

Returns
Type	Description
`string \| number`	{string} A string representing the service.

matchServiceFromProjectLocationSecurityCenterServicesName(projectLocationSecurityCenterServicesName)

matchServiceFromProjectLocationSecurityCenterServicesName(projectLocationSecurityCenterServicesName: string): string | number;

Parse the service from ProjectLocationSecurityCenterServices resource.

Parameter
Name	Description
`projectLocationSecurityCenterServicesName`	`string` A fully-qualified path representing project_location_securityCenterServices resource.

Returns
Type	Description
`string \| number`	{string} A string representing the service.

matchSourceFromFolderSourceFindingsName(folderSourceFindingsName)

matchSourceFromFolderSourceFindingsName(folderSourceFindingsName: string): string | number;

Parse the source from FolderSourceFindings resource.

Parameter
Name	Description
`folderSourceFindingsName`	`string` A fully-qualified path representing folder_source_findings resource.

Returns
Type	Description
`string \| number`	{string} A string representing the source.

matchSourceFromOrganizationSourceFindingsName(organizationSourceFindingsName)

matchSourceFromOrganizationSourceFindingsName(organizationSourceFindingsName: string): string | number;

Parse the source from OrganizationSourceFindings resource.

Parameter
Name	Description
`organizationSourceFindingsName`	`string` A fully-qualified path representing organization_source_findings resource.

Returns
Type	Description
`string \| number`	{string} A string representing the source.

matchSourceFromProjectSourceFindingsName(projectSourceFindingsName)

matchSourceFromProjectSourceFindingsName(projectSourceFindingsName: string): string | number;

Parse the source from ProjectSourceFindings resource.

Parameter
Name	Description
`projectSourceFindingsName`	`string` A fully-qualified path representing project_source_findings resource.

Returns
Type	Description
`string \| number`	{string} A string representing the source.

organizationLocationEffectiveEventThreatDetectionCustomModulesPath(organization, location, effectiveEventThreatDetectionCustomModule)

organizationLocationEffectiveEventThreatDetectionCustomModulesPath(organization: string, location: string, effectiveEventThreatDetectionCustomModule: string): string;

Return a fully-qualified organizationLocationEffectiveEventThreatDetectionCustomModules resource name string.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`effectiveEventThreatDetectionCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesPath(organization, location, effectiveSecurityHealthAnalyticsCustomModule)

organizationLocationEffectiveSecurityHealthAnalyticsCustomModulesPath(organization: string, location: string, effectiveSecurityHealthAnalyticsCustomModule: string): string;

Return a fully-qualified organizationLocationEffectiveSecurityHealthAnalyticsCustomModules resource name string.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`effectiveSecurityHealthAnalyticsCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

organizationLocationEventThreatDetectionCustomModulesPath(organization, location, eventThreatDetectionCustomModule)

organizationLocationEventThreatDetectionCustomModulesPath(organization: string, location: string, eventThreatDetectionCustomModule: string): string;

Return a fully-qualified organizationLocationEventThreatDetectionCustomModules resource name string.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`eventThreatDetectionCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

organizationLocationPath(organization, location)

organizationLocationPath(organization: string, location: string): string;

Return a fully-qualified organizationLocation resource name string.

Parameters
Name	Description
`organization`	`string`
`location`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

organizationLocationSecurityCenterServicesPath(organization, location, service)

organizationLocationSecurityCenterServicesPath(organization: string, location: string, service: string): string;

Return a fully-qualified organizationLocationSecurityCenterServices resource name string.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`service`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

organizationLocationSecurityHealthAnalyticsCustomModulesPath(organization, location, securityHealthAnalyticsCustomModule)

organizationLocationSecurityHealthAnalyticsCustomModulesPath(organization: string, location: string, securityHealthAnalyticsCustomModule: string): string;

Return a fully-qualified organizationLocationSecurityHealthAnalyticsCustomModules resource name string.

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`securityHealthAnalyticsCustomModule`	`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.

organizationSourceFindingsPath(organization, source, finding)

organizationSourceFindingsPath(organization: string, source: string, finding: string): string;

Return a fully-qualified organizationSourceFindings resource name string.

Parameters
Name	Description
`organization`	`string`
`source`	`string`
`finding`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationEffectiveEventThreatDetectionCustomModulesPath(project, location, effectiveEventThreatDetectionCustomModule)

projectLocationEffectiveEventThreatDetectionCustomModulesPath(project: string, location: string, effectiveEventThreatDetectionCustomModule: string): string;

Return a fully-qualified projectLocationEffectiveEventThreatDetectionCustomModules resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`effectiveEventThreatDetectionCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationEffectiveSecurityHealthAnalyticsCustomModulesPath(project, location, effectiveSecurityHealthAnalyticsCustomModule)

projectLocationEffectiveSecurityHealthAnalyticsCustomModulesPath(project: string, location: string, effectiveSecurityHealthAnalyticsCustomModule: string): string;

Return a fully-qualified projectLocationEffectiveSecurityHealthAnalyticsCustomModules resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`effectiveSecurityHealthAnalyticsCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationEventThreatDetectionCustomModulesPath(project, location, eventThreatDetectionCustomModule)

projectLocationEventThreatDetectionCustomModulesPath(project: string, location: string, eventThreatDetectionCustomModule: string): string;

Return a fully-qualified projectLocationEventThreatDetectionCustomModules resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`eventThreatDetectionCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationSecurityCenterServicesPath(project, location, service)

projectLocationSecurityCenterServicesPath(project: string, location: string, service: string): string;

Return a fully-qualified projectLocationSecurityCenterServices resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`service`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationSecurityHealthAnalyticsCustomModulesPath(project, location, securityHealthAnalyticsCustomModule)

projectLocationSecurityHealthAnalyticsCustomModulesPath(project: string, location: string, securityHealthAnalyticsCustomModule: string): string;

Return a fully-qualified projectLocationSecurityHealthAnalyticsCustomModules resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`securityHealthAnalyticsCustomModule`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectSourceFindingsPath(project, source, finding)

projectSourceFindingsPath(project: string, source: string, finding: string): string;

Return a fully-qualified projectSourceFindings resource name string.

Parameters
Name	Description
`project`	`string`
`source`	`string`
`finding`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

simulateSecurityHealthAnalyticsCustomModule(request, options)

simulateSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse,
        (protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | undefined),
        {} | undefined
    ]>;

Simulates the result of using a to check a 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.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, (protos.google.cloud.securitycentermanagement.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 AIP-122:
   *  Resource names (https://google.aip.dev/122). 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 Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

  async function callSimulateSecurityHealthAnalyticsCustomModule() {
    // Construct request
    const request = {
      parent,
      customConfig,
      resource,
    };

    // Run request
    const response = await securitycentermanagementClient.simulateSecurityHealthAnalyticsCustomModule(request);
    console.log(response);
  }

  callSimulateSecurityHealthAnalyticsCustomModule();

simulateSecurityHealthAnalyticsCustomModule(request, options, callback)

simulateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ISimulateSecurityHealthAnalyticsCustomModuleRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

simulateSecurityHealthAnalyticsCustomModule(request, callback)

simulateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ISimulateSecurityHealthAnalyticsCustomModuleRequest`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateEventThreatDetectionCustomModule(request, options)

updateEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule,
        (protos.google.cloud.securitycentermanagement.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.securitycentermanagement.v1.IEventThreatDetectionCustomModule, (protos.google.cloud.securitycentermanagement.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 fields to update. If omitted, then all fields are updated.
   */
  // const updateMask = {}
  /**
   *  Required. The module being updated.
   */
  // const eventThreatDetectionCustomModule = {}
  /**
   *  Optional. When set to `true`, the request will be validated (including IAM
   *  checks), but no module will be updated. An `OK` response indicates that the
   *  request is valid, while an error response indicates that the request is
   *  invalid.
   *  If the request is valid, a subsequent request to update the module could
   *  still fail for one of the following reasons:
   *  *  The state of your cloud resources changed; for example, you lost a
   *     required IAM permission
   *  *  An error occurred during creation of the module
   *  Defaults to `false`.
   */
  // const validateOnly = true

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

  async function callUpdateEventThreatDetectionCustomModule() {
    // Construct request
    const request = {
      updateMask,
      eventThreatDetectionCustomModule,
    };

    // Run request
    const response = await securitycentermanagementClient.updateEventThreatDetectionCustomModule(request);
    console.log(response);
  }

  callUpdateEventThreatDetectionCustomModule();

updateEventThreatDetectionCustomModule(request, options, callback)

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

Parameters
Name	Description
`request`	`IUpdateEventThreatDetectionCustomModuleRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateEventThreatDetectionCustomModule(request, callback)

updateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateEventThreatDetectionCustomModuleRequest`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateSecurityCenterService(request, options)

updateSecurityCenterService(request?: protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityCenterServiceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService,
        (protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityCenterServiceRequest | undefined),
        {} | undefined
    ]>;

Updates a Security Command Center service using the given update mask.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService, (protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityCenterServiceRequest \| 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 updated service.
   */
  // const securityCenterService = {}
  /**
   *  Required. The fields to update. Accepts the following values:
   *  * `intended_enablement_state`
   *  * `modules`
   *  If omitted, then all eligible fields are updated.
   */
  // const updateMask = {}
  /**
   *  Optional. When set to `true`, the request will be validated (including IAM
   *  checks), but no service will be updated. An `OK` response indicates that
   *  the request is valid, while an error response indicates that the request is
   *  invalid.
   *  If the request is valid, a subsequent request to update the service could
   *  still fail for one of the following reasons:
   *  *  The state of your cloud resources changed; for example, you lost a
   *     required IAM permission
   *  *  An error occurred during update of the service
   *  Defaults to `false`.
   */
  // const validateOnly = true

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

  async function callUpdateSecurityCenterService() {
    // Construct request
    const request = {
      securityCenterService,
      updateMask,
    };

    // Run request
    const response = await securitycentermanagementClient.updateSecurityCenterService(request);
    console.log(response);
  }

  callUpdateSecurityCenterService();

updateSecurityCenterService(request, options, callback)

updateSecurityCenterService(request: protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityCenterServiceRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityCenterServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateSecurityCenterServiceRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityCenterServiceRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateSecurityCenterService(request, callback)

updateSecurityCenterService(request: protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityCenterServiceRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityCenterServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateSecurityCenterServiceRequest`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityCenterService, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityCenterServiceRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateSecurityHealthAnalyticsCustomModule(request, options)

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

Updates the 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 configuration 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.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, (protos.google.cloud.securitycentermanagement.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 fields to update. The following values are valid:
   *  * `custom_config`
   *  * `enablement_state`
   *  If you omit this field or set it to the wildcard value `*`, then all
   *  eligible fields are updated.
   */
  // const updateMask = {}
  /**
   *  Required. The resource being updated.
   */
  // const securityHealthAnalyticsCustomModule = {}
  /**
   *  Optional. When set to `true`, the request will be validated (including IAM
   *  checks), but no module will be updated. An `OK` response indicates that the
   *  request is valid, while an error response indicates that the request is
   *  invalid.
   *  If the request is valid, a subsequent request to update the module could
   *  still fail for one of the following reasons:
   *  *  The state of your cloud resources changed; for example, you lost a
   *     required IAM permission
   *  *  An error occurred during creation of the module
   *  Defaults to `false`.
   */
  // const validateOnly = true

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

  async function callUpdateSecurityHealthAnalyticsCustomModule() {
    // Construct request
    const request = {
      updateMask,
      securityHealthAnalyticsCustomModule,
    };

    // Run request
    const response = await securitycentermanagementClient.updateSecurityHealthAnalyticsCustomModule(request);
    console.log(response);
  }

  callUpdateSecurityHealthAnalyticsCustomModule();

updateSecurityHealthAnalyticsCustomModule(request, options, callback)

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

Parameters
Name	Description
`request`	`IUpdateSecurityHealthAnalyticsCustomModuleRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateSecurityHealthAnalyticsCustomModule(request, callback)

updateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateSecurityHealthAnalyticsCustomModuleRequest`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

validateEventThreatDetectionCustomModule(request, options)

validateEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse,
        (protos.google.cloud.securitycentermanagement.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.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse, (protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest \| 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 parent to validate the custom modules under,
   *  in one of the following formats:
   *  * `organizations/{organization}/locations/{location}`
   */
  // 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. For example, `CONFIGURABLE_BAD_IP`.
   */
  // const type = 'abc123'

  // Imports the Securitycentermanagement library
  const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;

  // Instantiates a client
  const securitycentermanagementClient = new SecurityCenterManagementClient();

  async function callValidateEventThreatDetectionCustomModule() {
    // Construct request
    const request = {
      parent,
      rawText,
      type,
    };

    // Run request
    const response = await securitycentermanagementClient.validateEventThreatDetectionCustomModule(request);
    console.log(response);
  }

  callValidateEventThreatDetectionCustomModule();

validateEventThreatDetectionCustomModule(request, options, callback)

validateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IValidateEventThreatDetectionCustomModuleRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

validateEventThreatDetectionCustomModule(request, callback)

validateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IValidateEventThreatDetectionCustomModuleRequest`
`callback`	`Callback<protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

Class v1.SecurityCenterManagementClient (0.8.0) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(opts, gaxInstance)

Properties

apiEndpoint

apiEndpoint

auth

descriptors

innerApiCalls

locationsClient

pathTemplates

port

scopes

securityCenterManagementStub

servicePath

universeDomain

warn

Methods

close()

createEventThreatDetectionCustomModule(request, options)

createEventThreatDetectionCustomModule(request, options, callback)

createEventThreatDetectionCustomModule(request, callback)

createSecurityHealthAnalyticsCustomModule(request, options)

createSecurityHealthAnalyticsCustomModule(request, options, callback)

createSecurityHealthAnalyticsCustomModule(request, callback)

deleteEventThreatDetectionCustomModule(request, options)

deleteEventThreatDetectionCustomModule(request, options, callback)

deleteEventThreatDetectionCustomModule(request, callback)

deleteSecurityHealthAnalyticsCustomModule(request, options)

deleteSecurityHealthAnalyticsCustomModule(request, options, callback)

deleteSecurityHealthAnalyticsCustomModule(request, callback)

folderLocationEffectiveEventThreatDetectionCustomModulesPath(folder, location, effectiveEventThreatDetectionCustomModule)

folderLocationEffectiveSecurityHealthAnalyticsCustomModulesPath(folder, location, effectiveSecurityHealthAnalyticsCustomModule)

folderLocationEventThreatDetectionCustomModulesPath(folder, location, eventThreatDetectionCustomModule)

folderLocationSecurityCenterServicesPath(folder, location, service)

folderLocationSecurityHealthAnalyticsCustomModulesPath(folder, location, securityHealthAnalyticsCustomModule)

folderSourceFindingsPath(folder, source, finding)

getEffectiveEventThreatDetectionCustomModule(request, options)

getEffectiveEventThreatDetectionCustomModule(request, options, callback)

getEffectiveEventThreatDetectionCustomModule(request, callback)

getEffectiveSecurityHealthAnalyticsCustomModule(request, options)

getEffectiveSecurityHealthAnalyticsCustomModule(request, options, callback)

getEffectiveSecurityHealthAnalyticsCustomModule(request, callback)

getEventThreatDetectionCustomModule(request, options)

getEventThreatDetectionCustomModule(request, options, callback)

getEventThreatDetectionCustomModule(request, callback)

getLocation(request, options, callback)

getProjectId()

getProjectId(callback)

getSecurityCenterService(request, options)

getSecurityCenterService(request, options, callback)

getSecurityCenterService(request, callback)

getSecurityHealthAnalyticsCustomModule(request, options)

getSecurityHealthAnalyticsCustomModule(request, options, callback)

getSecurityHealthAnalyticsCustomModule(request, callback)

initialize()

listDescendantEventThreatDetectionCustomModules(request, options)

listDescendantEventThreatDetectionCustomModules(request, options, callback)

listDescendantEventThreatDetectionCustomModules(request, callback)

listDescendantEventThreatDetectionCustomModulesAsync(request, options)

listDescendantEventThreatDetectionCustomModulesStream(request, options)

listDescendantSecurityHealthAnalyticsCustomModules(request, options)

listDescendantSecurityHealthAnalyticsCustomModules(request, options, callback)

listDescendantSecurityHealthAnalyticsCustomModules(request, callback)

listDescendantSecurityHealthAnalyticsCustomModulesAsync(request, options)

listDescendantSecurityHealthAnalyticsCustomModulesStream(request, options)

listEffectiveEventThreatDetectionCustomModules(request, options)

listEffectiveEventThreatDetectionCustomModules(request, options, callback)

listEffectiveEventThreatDetectionCustomModules(request, callback)

listEffectiveEventThreatDetectionCustomModulesAsync(request, options)

listEffectiveEventThreatDetectionCustomModulesStream(request, options)

listEffectiveSecurityHealthAnalyticsCustomModules(request, options)

listEffectiveSecurityHealthAnalyticsCustomModules(request, options, callback)

listEffectiveSecurityHealthAnalyticsCustomModules(request, callback)

listEffectiveSecurityHealthAnalyticsCustomModulesAsync(request, options)

listEffectiveSecurityHealthAnalyticsCustomModulesStream(request, options)

listEventThreatDetectionCustomModules(request, options)

listEventThreatDetectionCustomModules(request, options, callback)

listEventThreatDetectionCustomModules(request, callback)

Class v1.SecurityCenterManagementClient (0.8.0)