SecurityCenterClient

SecurityCenterClient

V2 APIs for Security Center service.

Constructor

new SecurityCenterClient(optionsopt, gaxInstanceopt)

Construct an instance of SecurityCenterClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new SecurityCenterClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

attackPathPath(organization, simulation, valued_resource, attack_path) → {string}

Return a fully-qualified attackPath resource name string.

Parameters:
Name Type Description
organization string
simulation string
valued_resource string
attack_path string
Returns:
Type Description
string

Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

(async) checkBulkMuteFindingsProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent, at which bulk action needs to be applied. If no
   *  location is specified, findings are updated in global. The following list
   *  shows some examples:
   *  + `organizations/[organization_id]`
   *  + `organizations/[organization_id]/locations/[location_id]`
   *  + `folders/[folder_id]`
   *  + `folders/[folder_id]/locations/[location_id]`
   *  + `projects/[project_id]`
   *  + `projects/[project_id]/locations/[location_id]`
   */
  // const parent = 'abc123'
  /**
   *  Expression that identifies findings that should be updated.
   *  The expression is a list of zero or more restrictions combined
   *  via logical operators `AND` and `OR`. Parentheses are supported, and `OR`
   *  has higher precedence than `AND`.
   *  Restrictions have the form `<field> <operator> <value>` and may have a
   *  `-` character in front of them to indicate negation. The fields map to
   *  those defined in the corresponding resource.
   *  The supported operators are:
   *  * `=` for all value types.
   *  * `>`, `<`, `>=`, `<=` for integer values.
   *  * `:`, meaning substring matching, for strings.
   *  The supported value types are:
   *  * string literals in quotes.
   *  * integer literals without quotes.
   *  * boolean literals `true` and `false` without quotes.
   */
  // const filter = 'abc123'

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

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

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

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

  callBulkMuteFindings();

close() → {Promise}

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

A promise that resolves when the client is closed.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

folderAssetSecurityMarksPath(folder, asset) → {string}

Return a fully-qualified folderAssetSecurityMarks resource name string.

Parameters:
Name Type Description
folder string
asset string
Returns:
Type Description
string

Resource name string.

folderConstraintNamePath(folder, constraint_name) → {string}

Return a fully-qualified folderConstraintName resource name string.

Parameters:
Name Type Description
folder string
constraint_name string
Returns:
Type Description
string

Resource name string.

folderLocationExportPath(folder, location, exportParam) → {string}

Return a fully-qualified folderLocationExport resource name string.

Parameters:
Name Type Description
folder string
location string
exportParam string
Returns:
Type Description
string

Resource name string.

folderLocationMuteConfigPath(folder, location, mute_config) → {string}

Return a fully-qualified folderLocationMuteConfig resource name string.

Parameters:
Name Type Description
folder string
location string
mute_config string
Returns:
Type Description
string

Resource name string.

folderLocationNotificationConfigPath(folder, location, notification_config) → {string}

Return a fully-qualified folderLocationNotificationConfig resource name string.

Parameters:
Name Type Description
folder string
location string
notification_config string
Returns:
Type Description
string

Resource name string.

folderMuteConfigPath(folder, mute_config) → {string}

Return a fully-qualified folderMuteConfig resource name string.

Parameters:
Name Type Description
folder string
mute_config string
Returns:
Type Description
string

Resource name string.

folderSourceFindingExternalsystemPath(folder, source, finding, externalsystem) → {string}

Return a fully-qualified folderSourceFindingExternalsystem resource name string.

Parameters:
Name Type Description
folder string
source string
finding string
externalsystem string
Returns:
Type Description
string

Resource name string.

folderSourceFindingPath(folder, source, finding) → {string}

Return a fully-qualified folderSourceFinding resource name string.

Parameters:
Name Type Description
folder string
source string
finding string
Returns:
Type Description
string

Resource name string.

folderSourceFindingSecurityMarksPath(folder, source, finding) → {string}

Return a fully-qualified folderSourceFindingSecurityMarks resource name string.

Parameters:
Name Type Description
folder string
source string
finding string
Returns:
Type Description
string

Resource name string.

folderSourceLocationFindingExternalsystemPath(folder, source, location, finding, externalsystem) → {string}

Return a fully-qualified folderSourceLocationFindingExternalsystem resource name string.

Parameters:
Name Type Description
folder string
source string
location string
finding string
externalsystem string
Returns:
Type Description
string

Resource name string.

folderSourceLocationFindingPath(folder, source, location, finding) → {string}

Return a fully-qualified folderSourceLocationFinding resource name string.

Parameters:
Name Type Description
folder string
source string
location string
finding string
Returns:
Type Description
string

Resource name string.

folderSourceLocationFindingSecurityMarksPath(folder, source, location, finding) → {string}

Return a fully-qualified folderSourceLocationFindingSecurityMarks resource name string.

Parameters:
Name Type Description
folder string
source string
location string
finding string
Returns:
Type Description
string

Resource name string.

folderSourcePath(folder, source) → {string}

Return a fully-qualified folderSource resource name string.

Parameters:
Name Type Description
folder string
source string
Returns:
Type Description
string

Resource name string.

getOperation(request, optionsopt, callbackopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

groupFindingsAsync(request, optionsopt) → {Object}

Equivalent to groupFindings, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Name of the source to groupBy. If no location is specified, finding is assumed to be in global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id]

organizations/[organization_id]/sources/[source_id]/locations/[location_id]

  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]
  • projects/[project_id]/sources/[source_id]/locations/[location_id]

To groupBy across all sources provide a source_id of -. The following list shows some examples:

  • organizations/{organization_id}/sources/-
  • organizations/{organization_id}/sources/-/locations/[location_id]
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-/locations/[location_id]
  • projects/{project_id}/sources/-
  • projects/{project_id}/sources/-/locations/[location_id]
filter string

Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include:

  • name
  • security_marks.marks.marka

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.
  • integer literals without quotes.
  • boolean literals true and false without quotes.

The following field and operator combinations are supported:

  • name: =

  • parent: =, :

  • resource_name: =, :

  • state: =, :

  • category: =, :

  • external_uri: =, :

  • event_time: =, >, <, >=, <=

    Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: event_time = "2019-06-10T16:07:18-07:00" event_time = 1560208038000

  • severity: =, :

  • security_marks.marks: =, :

  • resource:

    • resource.name: =, :
    • resource.parent_name: =, :
    • resource.parent_display_name: =, :
    • resource.project_name: =, :
    • resource.project_display_name: =, :
    • resource.type: =, :
groupBy string

Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name".

The following fields are supported:

  • resource_name
  • category
  • state
  • parent
  • severity
pageToken string

The value returned by the last GroupFindingsResponse; indicates that this is a continuation of a prior GroupFindings call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing GroupResult. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the source to groupBy. If no location is specified,
   *  finding is assumed to be in global.
   *   The following list shows some examples:
   *  + `organizations/[organization_id]/sources/[source_id]`
   *  +
   *  `organizations/[organization_id]/sources/[source_id]/locations/[location_id]`
   *  + `folders/[folder_id]/sources/[source_id]`
   *  + `folders/[folder_id]/sources/[source_id]/locations/[location_id]`
   *  + `projects/[project_id]/sources/[source_id]`
   *  + `projects/[project_id]/sources/[source_id]/locations/[location_id]`
   *  To groupBy across all sources provide a source_id of `-`. The following
   *  list shows some examples:
   *  + `organizations/{organization_id}/sources/-`
   *  + `organizations/{organization_id}/sources/-/locations/[location_id]`
   *  + `folders/{folder_id}/sources/-`
   *  + `folders/{folder_id}/sources/-/locations/[location_id]`
   *  + `projects/{project_id}/sources/-`
   *  + `projects/{project_id}/sources/-/locations/[location_id]`
   */
  // const parent = 'abc123'
  /**
   *  Expression that defines the filter to apply across findings.
   *  The expression is a list of one or more restrictions combined via logical
   *  operators `AND` and `OR`.
   *  Parentheses are supported, and `OR` has higher precedence than `AND`.
   *  Restrictions have the form `<field> <operator> <value>` and may have a `-`
   *  character in front of them to indicate negation. Examples include:
   *   * name
   *   * security_marks.marks.marka
   *  The supported operators are:
   *  * `=` for all value types.
   *  * `>`, `<`, `>=`, `<=` for integer values.
   *  * `:`, meaning substring matching, for strings.
   *  The supported value types are:
   *  * string literals in quotes.
   *  * integer literals without quotes.
   *  * boolean literals `true` and `false` without quotes.
   *  The following field and operator combinations are supported:
   *  * name: `=`
   *  * parent: `=`, `:`
   *  * resource_name: `=`, `:`
   *  * state: `=`, `:`
   *  * category: `=`, `:`
   *  * external_uri: `=`, `:`
   *  * event_time: `=`, `>`, `<`, `>=`, `<=`
   *    Usage: This should be milliseconds since epoch or an RFC3339 string.
   *    Examples:
   *      `event_time = "2019-06-10T16:07:18-07:00"`
   *      `event_time = 1560208038000`
   *  * severity: `=`, `:`
   *  * security_marks.marks: `=`, `:`
   *  * resource:
   *    * resource.name: `=`, `:`
   *    * resource.parent_name: `=`, `:`
   *    * resource.parent_display_name: `=`, `:`
   *    * resource.project_name: `=`, `:`
   *    * resource.project_display_name: `=`, `:`
   *    * resource.type: `=`, `:`
   */
  // const filter = 'abc123'
  /**
   *  Required. Expression that defines what assets fields to use for grouping.
   *  The string value should follow SQL syntax: comma separated list of fields.
   *  For example: "parent,resource_name".
   *  The following fields are supported:
   *  * resource_name
   *  * category
   *  * state
   *  * parent
   *  * severity
   */
  // const groupBy = 'abc123'
  /**
   *  The value returned by the last `GroupFindingsResponse`; indicates
   *  that this is a continuation of a prior `GroupFindings` call, and
   *  that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234

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

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

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

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

  callGroupFindings();

groupFindingsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Name of the source to groupBy. If no location is specified, finding is assumed to be in global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id]

organizations/[organization_id]/sources/[source_id]/locations/[location_id]

  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]
  • projects/[project_id]/sources/[source_id]/locations/[location_id]

To groupBy across all sources provide a source_id of -. The following list shows some examples:

  • organizations/{organization_id}/sources/-
  • organizations/{organization_id}/sources/-/locations/[location_id]
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-/locations/[location_id]
  • projects/{project_id}/sources/-
  • projects/{project_id}/sources/-/locations/[location_id]
filter string

Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include:

  • name
  • security_marks.marks.marka

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.
  • integer literals without quotes.
  • boolean literals true and false without quotes.

The following field and operator combinations are supported:

  • name: =

  • parent: =, :

  • resource_name: =, :

  • state: =, :

  • category: =, :

  • external_uri: =, :

  • event_time: =, >, <, >=, <=

    Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: event_time = "2019-06-10T16:07:18-07:00" event_time = 1560208038000

  • severity: =, :

  • security_marks.marks: =, :

  • resource:

    • resource.name: =, :
    • resource.parent_name: =, :
    • resource.parent_display_name: =, :
    • resource.project_name: =, :
    • resource.project_display_name: =, :
    • resource.type: =, :
groupBy string

Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name".

The following fields are supported:

  • resource_name
  • category
  • state
  • parent
  • severity
pageToken string

The value returned by the last GroupFindingsResponse; indicates that this is a continuation of a prior GroupFindings call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing GroupResult on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using groupFindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

listAttackPathsAsync(request, optionsopt) → {Object}

Equivalent to listAttackPaths, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Name of parent to list attack paths.

Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}" "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"
filter string

The filter expression that filters the attack path in the response. Supported fields:

* `valued_resources` supports =
pageToken string

The value returned by the last ListAttackPathsResponse; indicates that this is a continuation of a prior ListAttackPaths call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AttackPath. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of parent to list attack paths.
   *  Valid formats:
   *  "organizations/{organization}",
   *  "organizations/{organization}/simulations/{simulation}"
   *  "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"
   *  "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"
   */
  // const parent = 'abc123'
  /**
   *  The filter expression that filters the attack path in the response.
   *  Supported fields:
   *    * `valued_resources` supports =
   */
  // const filter = 'abc123'
  /**
   *  The value returned by the last `ListAttackPathsResponse`; indicates
   *  that this is a continuation of a prior `ListAttackPaths` call, and
   *  that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234

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

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

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

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

  callListAttackPaths();

listAttackPathsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Name of parent to list attack paths.

Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}" "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"
filter string

The filter expression that filters the attack path in the response. Supported fields:

* `valued_resources` supports =
pageToken string

The value returned by the last ListAttackPathsResponse; indicates that this is a continuation of a prior ListAttackPaths call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing AttackPath on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAttackPathsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBigQueryExportsAsync(request, optionsopt) → {Object}

Equivalent to listBigQueryExports, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", or "projects/[project_id]/locations/[location_id]".
pageSize number

The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken string

A page token, received from a previous ListBigQueryExports call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBigQueryExports must match the call that provided the page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing BigQueryExport. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent, which owns the collection of BigQuery exports. Its
   *  format is "organizations/[organization_id]/locations/[location_id]",
   *  "folders/[folder_id]/locations/[location_id]", or
   *  "projects/[project_id]/locations/[location_id]".
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of configs to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 10 configs will be returned.
   *  The maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListBigQueryExports` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListBigQueryExports`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListBigQueryExports();

listBigQueryExportsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", or "projects/[project_id]/locations/[location_id]".
pageSize number

The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken string

A page token, received from a previous ListBigQueryExports call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBigQueryExports must match the call that provided the page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing BigQueryExport on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listBigQueryExportsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFindingsAsync(request, optionsopt) → {Object}

Equivalent to listFindings, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id]

organizations/[organization_id]/sources/[source_id]/locations/[location_id]

  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]
  • projects/[project_id]/sources/[source_id]/locations/[location_id]

To list across all sources provide a source_id of -. The following list shows some examples:

  • organizations/{organization_id}/sources/-
  • organizations/{organization_id}/sources/-/locations/{location_id}
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-locations/{location_id}
  • projects/{projects_id}/sources/-
  • projects/{projects_id}/sources/-/locations/{location_id}
filter string

Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include:

  • name
  • security_marks.marks.marka

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.
  • integer literals without quotes.
  • boolean literals true and false without quotes.

The following field and operator combinations are supported:

  • name: =

  • parent: =, :

  • resource_name: =, :

  • state: =, :

  • category: =, :

  • external_uri: =, :

  • event_time: =, >, <, >=, <=

    Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: event_time = "2019-06-10T16:07:18-07:00" event_time = 1560208038000

  • severity: =, :

  • security_marks.marks: =, :

  • resource:

    • resource.name: =, :
    • resource.parent_name: =, :
    • resource.parent_display_name: =, :
    • resource.project_name: =, :
    • resource.project_display_name: =, :
    • resource.type: =, :
    • resource.folders.resource_folder: =, :
    • resource.display_name: =, :
orderBy string

Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,parent". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent.

The following fields are supported: name parent state category resource_name event_time security_marks.marks
fieldMask google.protobuf.FieldMask

A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
pageToken string

The value returned by the last ListFindingsResponse; indicates that this is a continuation of a prior ListFindings call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ListFindingsResult. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the source the findings belong to. If no location is
   *  specified, the default is global. The following list shows some examples:
   *  + `organizations/[organization_id]/sources/[source_id]`
   *  +
   *  `organizations/[organization_id]/sources/[source_id]/locations/[location_id]`
   *  + `folders/[folder_id]/sources/[source_id]`
   *  + `folders/[folder_id]/sources/[source_id]/locations/[location_id]`
   *  + `projects/[project_id]/sources/[source_id]`
   *  + `projects/[project_id]/sources/[source_id]/locations/[location_id]`
   *  To list across all sources provide a source_id of `-`. The following
   *  list shows some examples:
   *  + `organizations/{organization_id}/sources/-`
   *  + `organizations/{organization_id}/sources/-/locations/{location_id}`
   *  + `folders/{folder_id}/sources/-`
   *  + `folders/{folder_id}/sources/-locations/{location_id}`
   *  + `projects/{projects_id}/sources/-`
   *  + `projects/{projects_id}/sources/-/locations/{location_id}`
   */
  // const parent = 'abc123'
  /**
   *  Expression that defines the filter to apply across findings.
   *  The expression is a list of one or more restrictions combined via logical
   *  operators `AND` and `OR`.
   *  Parentheses are supported, and `OR` has higher precedence than `AND`.
   *  Restrictions have the form `<field> <operator> <value>` and may have a `-`
   *  character in front of them to indicate negation. Examples include:
   *   * name
   *   * security_marks.marks.marka
   *  The supported operators are:
   *  * `=` for all value types.
   *  * `>`, `<`, `>=`, `<=` for integer values.
   *  * `:`, meaning substring matching, for strings.
   *  The supported value types are:
   *  * string literals in quotes.
   *  * integer literals without quotes.
   *  * boolean literals `true` and `false` without quotes.
   *  The following field and operator combinations are supported:
   *  * name: `=`
   *  * parent: `=`, `:`
   *  * resource_name: `=`, `:`
   *  * state: `=`, `:`
   *  * category: `=`, `:`
   *  * external_uri: `=`, `:`
   *  * event_time: `=`, `>`, `<`, `>=`, `<=`
   *    Usage: This should be milliseconds since epoch or an RFC3339 string.
   *    Examples:
   *      `event_time = "2019-06-10T16:07:18-07:00"`
   *      `event_time = 1560208038000`
   *  * severity: `=`, `:`
   *  * security_marks.marks: `=`, `:`
   *  * resource:
   *    * resource.name: `=`, `:`
   *    * resource.parent_name: `=`, `:`
   *    * resource.parent_display_name: `=`, `:`
   *    * resource.project_name: `=`, `:`
   *    * resource.project_display_name: `=`, `:`
   *    * resource.type: `=`, `:`
   *    * resource.folders.resource_folder: `=`, `:`
   *    * resource.display_name: `=`, `:`
   */
  // const filter = 'abc123'
  /**
   *  Expression that defines what fields and order to use for sorting. The
   *  string value should follow SQL syntax: comma separated list of fields. For
   *  example: "name,parent". The default sorting order
   *  is ascending. To specify descending order for a field, a suffix " desc"
   *  should be appended to the field name. For example: "name
   *  desc,parent". Redundant space characters in the
   *  syntax are insignificant. "name desc,parent" and "
   *  name     desc  ,   parent  " are equivalent.
   *  The following fields are supported:
   *  name
   *  parent
   *  state
   *  category
   *  resource_name
   *  event_time
   *  security_marks.marks
   */
  // const orderBy = 'abc123'
  /**
   *  A field mask to specify the Finding fields to be listed in the response.
   *  An empty field mask will list all fields.
   */
  // const fieldMask = {}
  /**
   *  The value returned by the last `ListFindingsResponse`; indicates
   *  that this is a continuation of a prior `ListFindings` call, and
   *  that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234

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

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

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

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

  callListFindings();

listFindingsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id]

organizations/[organization_id]/sources/[source_id]/locations/[location_id]

  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]
  • projects/[project_id]/sources/[source_id]/locations/[location_id]

To list across all sources provide a source_id of -. The following list shows some examples:

  • organizations/{organization_id}/sources/-
  • organizations/{organization_id}/sources/-/locations/{location_id}
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-locations/{location_id}
  • projects/{projects_id}/sources/-
  • projects/{projects_id}/sources/-/locations/{location_id}
filter string

Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include:

  • name
  • security_marks.marks.marka

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.
  • integer literals without quotes.
  • boolean literals true and false without quotes.

The following field and operator combinations are supported:

  • name: =

  • parent: =, :

  • resource_name: =, :

  • state: =, :

  • category: =, :

  • external_uri: =, :

  • event_time: =, >, <, >=, <=

    Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: event_time = "2019-06-10T16:07:18-07:00" event_time = 1560208038000

  • severity: =, :

  • security_marks.marks: =, :

  • resource:

    • resource.name: =, :
    • resource.parent_name: =, :
    • resource.parent_display_name: =, :
    • resource.project_name: =, :
    • resource.project_display_name: =, :
    • resource.type: =, :
    • resource.folders.resource_folder: =, :
    • resource.display_name: =, :
orderBy string

Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,parent". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent.

The following fields are supported: name parent state category resource_name event_time security_marks.marks
fieldMask google.protobuf.FieldMask

A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
pageToken string

The value returned by the last ListFindingsResponse; indicates that this is a continuation of a prior ListFindings call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing ListFindingsResult on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listFindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMuteConfigsAsync(request, optionsopt) → {Object}

Equivalent to listMuteConfigs, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]", "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", "projects/[project_id]/locations/[location_id]".
pageSize number

The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken string

A page token, received from a previous ListMuteConfigs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListMuteConfigs must match the call that provided the page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing MuteConfig. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent, which owns the collection of mute configs. Its format
   *  is "organizations/[organization_id]", "folders/[folder_id]",
   *  "projects/[project_id]",
   *  "organizations/[organization_id]/locations/[location_id]",
   *  "folders/[folder_id]/locations/[location_id]",
   *  "projects/[project_id]/locations/[location_id]".
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of configs to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 10 configs will be returned.
   *  The maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListMuteConfigs` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListMuteConfigs` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListMuteConfigs();

listMuteConfigsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]", "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", "projects/[project_id]/locations/[location_id]".
pageSize number

The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken string

A page token, received from a previous ListMuteConfigs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListMuteConfigs must match the call that provided the page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing MuteConfig on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listMuteConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNotificationConfigsAsync(request, optionsopt) → {Object}

Equivalent to listNotificationConfigs, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent in which to list the notification configurations. Its format is "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", or "projects/[project_id]/locations/[location_id]".
pageToken string

The value returned by the last ListNotificationConfigsResponse; indicates that this is a continuation of a prior ListNotificationConfigs call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing NotificationConfig. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent in which to list the notification
   *  configurations. Its format is
   *  "organizations/[organization_id]/locations/[location_id]",
   *  "folders/[folder_id]/locations/[location_id]", or
   *  "projects/[project_id]/locations/[location_id]".
   */
  // const parent = 'abc123'
  /**
   *  The value returned by the last `ListNotificationConfigsResponse`; indicates
   *  that this is a continuation of a prior `ListNotificationConfigs` call, and
   *  that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234

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

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

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

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

  callListNotificationConfigs();

listNotificationConfigsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent in which to list the notification configurations. Its format is "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", or "projects/[project_id]/locations/[location_id]".
pageToken string

The value returned by the last ListNotificationConfigsResponse; indicates that this is a continuation of a prior ListNotificationConfigs call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing NotificationConfig on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listNotificationConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOperationsAsync(request, optionsopt) → {Object}

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

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

listResourceValueConfigsAsync(request, optionsopt) → {Object}

Equivalent to listResourceValueConfigs, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent, which owns the collection of resource value configs. Its format is "organizations/[organization_id]"
pageSize number

The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken string

A page token, received from a previous ListResourceValueConfigs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListResourceValueConfigs must match the call that provided the page token.

page_size can be specified, and the new page_size will be used.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ResourceValueConfig. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent, which owns the collection of resource value configs.
   *  Its format is
   *  "organizations/[organization_id]"
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of configs to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 10 configs will be returned.
   *  The maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListResourceValueConfigs` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListResourceValueConfigs` must match the call that provided the
   *  page token.
   *  page_size can be specified, and the new page_size will be used.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListResourceValueConfigs();

listResourceValueConfigsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent, which owns the collection of resource value configs. Its format is "organizations/[organization_id]"
pageSize number

The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken string

A page token, received from a previous ListResourceValueConfigs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListResourceValueConfigs must match the call that provided the page token.

page_size can be specified, and the new page_size will be used.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing ResourceValueConfig on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listResourceValueConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSourcesAsync(request, optionsopt) → {Object}

Equivalent to listSources, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".
pageToken string

The value returned by the last ListSourcesResponse; indicates that this is a continuation of a prior ListSources call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Source. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the parent of sources to list. Its format should
   *  be "organizations/[organization_id]", "folders/[folder_id]", or
   *  "projects/[project_id]".
   */
  // const parent = 'abc123'
  /**
   *  The value returned by the last `ListSourcesResponse`; indicates
   *  that this is a continuation of a prior `ListSources` call, and
   *  that the system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of results to return in a single response. Default is
   *  10, minimum is 1, maximum is 1000.
   */
  // const pageSize = 1234

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

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

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

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

  callListSources();

listSourcesStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".
pageToken string

The value returned by the last ListSourcesResponse; indicates that this is a continuation of a prior ListSources call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Source on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSourcesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listValuedResourcesAsync(request, optionsopt) → {Object}

Equivalent to listValuedResources, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. Name of parent to list exposed resources.

Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"
filter string

The filter expression that filters the valued resources in the response. Supported fields:

* `resource_value` supports =
* `resource_type` supports =
pageToken string

The value returned by the last ListValuedResourcesResponse; indicates that this is a continuation of a prior ListValuedResources call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
orderBy string <optional>

Optional. The fields by which to order the valued resources response.

Supported fields:

* `exposed_score`

* `resource_value`

* `resource_type`

Values should be a comma separated list of fields. For example: exposed_score,resource_value.

The default sorting order is descending. To specify ascending or descending order for a field, append a " ASC" or a " DESC" suffix, respectively; for example: exposed_score DESC.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

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

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

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

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

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

  callListValuedResources();

listValuedResourcesStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. Name of parent to list exposed resources.

Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"
filter string

The filter expression that filters the valued resources in the response. Supported fields:

* `resource_value` supports =
* `resource_type` supports =
pageToken string

The value returned by the last ListValuedResourcesResponse; indicates that this is a continuation of a prior ListValuedResources call, and that the system should return the next page of data.
pageSize number

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
orderBy string <optional>

Optional. The fields by which to order the valued resources response.

Supported fields:

* `exposed_score`

* `resource_value`

* `resource_type`

Values should be a comma separated list of fields. For example: exposed_score,resource_value.

The default sorting order is descending. To specify ascending or descending order for a field, append a " ASC" or a " DESC" suffix, respectively; for example: exposed_score DESC.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing ValuedResource on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listValuedResourcesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAssetFromFolderAssetSecurityMarksName(folderAssetSecurityMarksName) → {string}

Parse the asset from FolderAssetSecurityMarks resource.

Parameters:
Name Type Description
folderAssetSecurityMarksName string

A fully-qualified path representing folder_asset_securityMarks resource.
Returns:
Type Description
string

A string representing the asset.

matchAssetFromOrganizationAssetSecurityMarksName(organizationAssetSecurityMarksName) → {string}

Parse the asset from OrganizationAssetSecurityMarks resource.

Parameters:
Name Type Description
organizationAssetSecurityMarksName string

A fully-qualified path representing organization_asset_securityMarks resource.
Returns:
Type Description
string

A string representing the asset.

matchAssetFromProjectAssetSecurityMarksName(projectAssetSecurityMarksName) → {string}

Parse the asset from ProjectAssetSecurityMarks resource.

Parameters:
Name Type Description
projectAssetSecurityMarksName string

A fully-qualified path representing project_asset_securityMarks resource.
Returns:
Type Description
string

A string representing the asset.

matchAttackPathFromAttackPathName(attackPathName) → {string}

Parse the attack_path from AttackPath resource.

Parameters:
Name Type Description
attackPathName string

A fully-qualified path representing AttackPath resource.
Returns:
Type Description
string

A string representing the attack_path.

matchConstraintNameFromFolderConstraintNameName(folderConstraintNameName) → {string}

Parse the constraint_name from FolderConstraintName resource.

Parameters:
Name Type Description
folderConstraintNameName string

A fully-qualified path representing folder_constraint_name resource.
Returns:
Type Description
string

A string representing the constraint_name.

matchConstraintNameFromOrganizationConstraintNameName(organizationConstraintNameName) → {string}

Parse the constraint_name from OrganizationConstraintName resource.

Parameters:
Name Type Description
organizationConstraintNameName string

A fully-qualified path representing organization_constraint_name resource.
Returns:
Type Description
string

A string representing the constraint_name.

matchConstraintNameFromProjectConstraintNameName(projectConstraintNameName) → {string}

Parse the constraint_name from ProjectConstraintName resource.

Parameters:
Name Type Description
projectConstraintNameName string

A fully-qualified path representing project_constraint_name resource.
Returns:
Type Description
string

A string representing the constraint_name.

matchExportFromFolderLocationExportName(folderLocationExportName) → {string}

Parse the export from FolderLocationExport resource.

Parameters:
Name Type Description
folderLocationExportName string

A fully-qualified path representing folder_location_export resource.
Returns:
Type Description
string

A string representing the export.

matchExportFromOrganizationLocationExportName(organizationLocationExportName) → {string}

Parse the export from OrganizationLocationExport resource.

Parameters:
Name Type Description
organizationLocationExportName string

A fully-qualified path representing organization_location_export resource.
Returns:
Type Description
string

A string representing the export.

matchExportFromProjectLocationExportName(projectLocationExportName) → {string}

Parse the export from ProjectLocationExport resource.

Parameters:
Name Type Description
projectLocationExportName string

A fully-qualified path representing project_location_export resource.
Returns:
Type Description
string

A string representing the export.

matchExternalsystemFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName) → {string}

Parse the externalsystem from FolderSourceFindingExternalsystem resource.

Parameters:
Name Type Description
folderSourceFindingExternalsystemName string

A fully-qualified path representing folder_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the externalsystem.

matchExternalsystemFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName) → {string}

Parse the externalsystem from FolderSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
folderSourceLocationFindingExternalsystemName string

A fully-qualified path representing folder_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the externalsystem.

matchExternalsystemFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName) → {string}

Parse the externalsystem from OrganizationSourceFindingExternalsystem resource.

Parameters:
Name Type Description
organizationSourceFindingExternalsystemName string

A fully-qualified path representing organization_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the externalsystem.

matchExternalsystemFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName) → {string}

Parse the externalsystem from OrganizationSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
organizationSourceLocationFindingExternalsystemName string

A fully-qualified path representing organization_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the externalsystem.

matchExternalsystemFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName) → {string}

Parse the externalsystem from ProjectSourceFindingExternalsystem resource.

Parameters:
Name Type Description
projectSourceFindingExternalsystemName string

A fully-qualified path representing project_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the externalsystem.

matchExternalsystemFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName) → {string}

Parse the externalsystem from ProjectSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
projectSourceLocationFindingExternalsystemName string

A fully-qualified path representing project_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the externalsystem.

matchFindingFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName) → {string}

Parse the finding from FolderSourceFindingExternalsystem resource.

Parameters:
Name Type Description
folderSourceFindingExternalsystemName string

A fully-qualified path representing folder_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromFolderSourceFindingName(folderSourceFindingName) → {string}

Parse the finding from FolderSourceFinding resource.

Parameters:
Name Type Description
folderSourceFindingName string

A fully-qualified path representing folder_source_finding resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName) → {string}

Parse the finding from FolderSourceFindingSecurityMarks resource.

Parameters:
Name Type Description
folderSourceFindingSecurityMarksName string

A fully-qualified path representing folder_source_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName) → {string}

Parse the finding from FolderSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
folderSourceLocationFindingExternalsystemName string

A fully-qualified path representing folder_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromFolderSourceLocationFindingName(folderSourceLocationFindingName) → {string}

Parse the finding from FolderSourceLocationFinding resource.

Parameters:
Name Type Description
folderSourceLocationFindingName string

A fully-qualified path representing folder_source_location_finding resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName) → {string}

Parse the finding from FolderSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
folderSourceLocationFindingSecurityMarksName string

A fully-qualified path representing folder_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName) → {string}

Parse the finding from OrganizationSourceFindingExternalsystem resource.

Parameters:
Name Type Description
organizationSourceFindingExternalsystemName string

A fully-qualified path representing organization_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromOrganizationSourceFindingName(organizationSourceFindingName) → {string}

Parse the finding from OrganizationSourceFinding resource.

Parameters:
Name Type Description
organizationSourceFindingName string

A fully-qualified path representing organization_source_finding resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName) → {string}

Parse the finding from OrganizationSourceFindingSecurityMarks resource.

Parameters:
Name Type Description
organizationSourceFindingSecurityMarksName string

A fully-qualified path representing organization_source_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName) → {string}

Parse the finding from OrganizationSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
organizationSourceLocationFindingExternalsystemName string

A fully-qualified path representing organization_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName) → {string}

Parse the finding from OrganizationSourceLocationFinding resource.

Parameters:
Name Type Description
organizationSourceLocationFindingName string

A fully-qualified path representing organization_source_location_finding resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName) → {string}

Parse the finding from OrganizationSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
organizationSourceLocationFindingSecurityMarksName string

A fully-qualified path representing organization_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName) → {string}

Parse the finding from ProjectSourceFindingExternalsystem resource.

Parameters:
Name Type Description
projectSourceFindingExternalsystemName string

A fully-qualified path representing project_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromProjectSourceFindingName(projectSourceFindingName) → {string}

Parse the finding from ProjectSourceFinding resource.

Parameters:
Name Type Description
projectSourceFindingName string

A fully-qualified path representing project_source_finding resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName) → {string}

Parse the finding from ProjectSourceFindingSecurityMarks resource.

Parameters:
Name Type Description
projectSourceFindingSecurityMarksName string

A fully-qualified path representing project_source_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName) → {string}

Parse the finding from ProjectSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
projectSourceLocationFindingExternalsystemName string

A fully-qualified path representing project_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromProjectSourceLocationFindingName(projectSourceLocationFindingName) → {string}

Parse the finding from ProjectSourceLocationFinding resource.

Parameters:
Name Type Description
projectSourceLocationFindingName string

A fully-qualified path representing project_source_location_finding resource.
Returns:
Type Description
string

A string representing the finding.

matchFindingFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName) → {string}

Parse the finding from ProjectSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
projectSourceLocationFindingSecurityMarksName string

A fully-qualified path representing project_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the finding.

matchFolderFromFolderAssetSecurityMarksName(folderAssetSecurityMarksName) → {string}

Parse the folder from FolderAssetSecurityMarks resource.

Parameters:
Name Type Description
folderAssetSecurityMarksName string

A fully-qualified path representing folder_asset_securityMarks resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderConstraintNameName(folderConstraintNameName) → {string}

Parse the folder from FolderConstraintName resource.

Parameters:
Name Type Description
folderConstraintNameName string

A fully-qualified path representing folder_constraint_name resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderLocationExportName(folderLocationExportName) → {string}

Parse the folder from FolderLocationExport resource.

Parameters:
Name Type Description
folderLocationExportName string

A fully-qualified path representing folder_location_export resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderLocationMuteConfigName(folderLocationMuteConfigName) → {string}

Parse the folder from FolderLocationMuteConfig resource.

Parameters:
Name Type Description
folderLocationMuteConfigName string

A fully-qualified path representing folder_location_mute_config resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderLocationNotificationConfigName(folderLocationNotificationConfigName) → {string}

Parse the folder from FolderLocationNotificationConfig resource.

Parameters:
Name Type Description
folderLocationNotificationConfigName string

A fully-qualified path representing folder_location_notification_config resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderMuteConfigName(folderMuteConfigName) → {string}

Parse the folder from FolderMuteConfig resource.

Parameters:
Name Type Description
folderMuteConfigName string

A fully-qualified path representing folder_mute_config resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName) → {string}

Parse the folder from FolderSourceFindingExternalsystem resource.

Parameters:
Name Type Description
folderSourceFindingExternalsystemName string

A fully-qualified path representing folder_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderSourceFindingName(folderSourceFindingName) → {string}

Parse the folder from FolderSourceFinding resource.

Parameters:
Name Type Description
folderSourceFindingName string

A fully-qualified path representing folder_source_finding resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName) → {string}

Parse the folder from FolderSourceFindingSecurityMarks resource.

Parameters:
Name Type Description
folderSourceFindingSecurityMarksName string

A fully-qualified path representing folder_source_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName) → {string}

Parse the folder from FolderSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
folderSourceLocationFindingExternalsystemName string

A fully-qualified path representing folder_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderSourceLocationFindingName(folderSourceLocationFindingName) → {string}

Parse the folder from FolderSourceLocationFinding resource.

Parameters:
Name Type Description
folderSourceLocationFindingName string

A fully-qualified path representing folder_source_location_finding resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName) → {string}

Parse the folder from FolderSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
folderSourceLocationFindingSecurityMarksName string

A fully-qualified path representing folder_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderSourceName(folderSourceName) → {string}

Parse the folder from FolderSource resource.

Parameters:
Name Type Description
folderSourceName string

A fully-qualified path representing folder_source resource.
Returns:
Type Description
string

A string representing the folder.

matchLocationFromFolderLocationExportName(folderLocationExportName) → {string}

Parse the location from FolderLocationExport resource.

Parameters:
Name Type Description
folderLocationExportName string

A fully-qualified path representing folder_location_export resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromFolderLocationMuteConfigName(folderLocationMuteConfigName) → {string}

Parse the location from FolderLocationMuteConfig resource.

Parameters:
Name Type Description
folderLocationMuteConfigName string

A fully-qualified path representing folder_location_mute_config resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromFolderLocationNotificationConfigName(folderLocationNotificationConfigName) → {string}

Parse the location from FolderLocationNotificationConfig resource.

Parameters:
Name Type Description
folderLocationNotificationConfigName string

A fully-qualified path representing folder_location_notification_config resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName) → {string}

Parse the location from FolderSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
folderSourceLocationFindingExternalsystemName string

A fully-qualified path representing folder_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromFolderSourceLocationFindingName(folderSourceLocationFindingName) → {string}

Parse the location from FolderSourceLocationFinding resource.

Parameters:
Name Type Description
folderSourceLocationFindingName string

A fully-qualified path representing folder_source_location_finding resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName) → {string}

Parse the location from FolderSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
folderSourceLocationFindingSecurityMarksName string

A fully-qualified path representing folder_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationLocationExportName(organizationLocationExportName) → {string}

Parse the location from OrganizationLocationExport resource.

Parameters:
Name Type Description
organizationLocationExportName string

A fully-qualified path representing organization_location_export resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName) → {string}

Parse the location from OrganizationLocationMuteConfig resource.

Parameters:
Name Type Description
organizationLocationMuteConfigName string

A fully-qualified path representing organization_location_mute_config resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationLocationName(organizationLocationName) → {string}

Parse the location from OrganizationLocation resource.

Parameters:
Name Type Description
organizationLocationName string

A fully-qualified path representing OrganizationLocation resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationLocationNotificationConfigName(organizationLocationNotificationConfigName) → {string}

Parse the location from OrganizationLocationNotificationConfig resource.

Parameters:
Name Type Description
organizationLocationNotificationConfigName string

A fully-qualified path representing organization_location_notification_config resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName) → {string}

Parse the location from OrganizationSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
organizationSourceLocationFindingExternalsystemName string

A fully-qualified path representing organization_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName) → {string}

Parse the location from OrganizationSourceLocationFinding resource.

Parameters:
Name Type Description
organizationSourceLocationFindingName string

A fully-qualified path representing organization_source_location_finding resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName) → {string}

Parse the location from OrganizationSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
organizationSourceLocationFindingSecurityMarksName string

A fully-qualified path representing organization_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationExportName(projectLocationExportName) → {string}

Parse the location from ProjectLocationExport resource.

Parameters:
Name Type Description
projectLocationExportName string

A fully-qualified path representing project_location_export resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationMuteConfigName(projectLocationMuteConfigName) → {string}

Parse the location from ProjectLocationMuteConfig resource.

Parameters:
Name Type Description
projectLocationMuteConfigName string

A fully-qualified path representing project_location_mute_config resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationNotificationConfigName(projectLocationNotificationConfigName) → {string}

Parse the location from ProjectLocationNotificationConfig resource.

Parameters:
Name Type Description
projectLocationNotificationConfigName string

A fully-qualified path representing project_location_notification_config resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName) → {string}

Parse the location from ProjectSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
projectSourceLocationFindingExternalsystemName string

A fully-qualified path representing project_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectSourceLocationFindingName(projectSourceLocationFindingName) → {string}

Parse the location from ProjectSourceLocationFinding resource.

Parameters:
Name Type Description
projectSourceLocationFindingName string

A fully-qualified path representing project_source_location_finding resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName) → {string}

Parse the location from ProjectSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
projectSourceLocationFindingSecurityMarksName string

A fully-qualified path representing project_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the location.

matchMuteConfigFromFolderLocationMuteConfigName(folderLocationMuteConfigName) → {string}

Parse the mute_config from FolderLocationMuteConfig resource.

Parameters:
Name Type Description
folderLocationMuteConfigName string

A fully-qualified path representing folder_location_mute_config resource.
Returns:
Type Description
string

A string representing the mute_config.

matchMuteConfigFromFolderMuteConfigName(folderMuteConfigName) → {string}

Parse the mute_config from FolderMuteConfig resource.

Parameters:
Name Type Description
folderMuteConfigName string

A fully-qualified path representing folder_mute_config resource.
Returns:
Type Description
string

A string representing the mute_config.

matchMuteConfigFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName) → {string}

Parse the mute_config from OrganizationLocationMuteConfig resource.

Parameters:
Name Type Description
organizationLocationMuteConfigName string

A fully-qualified path representing organization_location_mute_config resource.
Returns:
Type Description
string

A string representing the mute_config.

matchMuteConfigFromOrganizationMuteConfigName(organizationMuteConfigName) → {string}

Parse the mute_config from OrganizationMuteConfig resource.

Parameters:
Name Type Description
organizationMuteConfigName string

A fully-qualified path representing organization_mute_config resource.
Returns:
Type Description
string

A string representing the mute_config.

matchMuteConfigFromProjectLocationMuteConfigName(projectLocationMuteConfigName) → {string}

Parse the mute_config from ProjectLocationMuteConfig resource.

Parameters:
Name Type Description
projectLocationMuteConfigName string

A fully-qualified path representing project_location_mute_config resource.
Returns:
Type Description
string

A string representing the mute_config.

matchMuteConfigFromProjectMuteConfigName(projectMuteConfigName) → {string}

Parse the mute_config from ProjectMuteConfig resource.

Parameters:
Name Type Description
projectMuteConfigName string

A fully-qualified path representing project_mute_config resource.
Returns:
Type Description
string

A string representing the mute_config.

matchNotificationConfigFromFolderLocationNotificationConfigName(folderLocationNotificationConfigName) → {string}

Parse the notification_config from FolderLocationNotificationConfig resource.

Parameters:
Name Type Description
folderLocationNotificationConfigName string

A fully-qualified path representing folder_location_notification_config resource.
Returns:
Type Description
string

A string representing the notification_config.

matchNotificationConfigFromOrganizationLocationNotificationConfigName(organizationLocationNotificationConfigName) → {string}

Parse the notification_config from OrganizationLocationNotificationConfig resource.

Parameters:
Name Type Description
organizationLocationNotificationConfigName string

A fully-qualified path representing organization_location_notification_config resource.
Returns:
Type Description
string

A string representing the notification_config.

matchNotificationConfigFromProjectLocationNotificationConfigName(projectLocationNotificationConfigName) → {string}

Parse the notification_config from ProjectLocationNotificationConfig resource.

Parameters:
Name Type Description
projectLocationNotificationConfigName string

A fully-qualified path representing project_location_notification_config resource.
Returns:
Type Description
string

A string representing the notification_config.

matchOrganizationFromAttackPathName(attackPathName) → {string}

Parse the organization from AttackPath resource.

Parameters:
Name Type Description
attackPathName string

A fully-qualified path representing AttackPath resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationAssetSecurityMarksName(organizationAssetSecurityMarksName) → {string}

Parse the organization from OrganizationAssetSecurityMarks resource.

Parameters:
Name Type Description
organizationAssetSecurityMarksName string

A fully-qualified path representing organization_asset_securityMarks resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationConstraintNameName(organizationConstraintNameName) → {string}

Parse the organization from OrganizationConstraintName resource.

Parameters:
Name Type Description
organizationConstraintNameName string

A fully-qualified path representing organization_constraint_name resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationLocationExportName(organizationLocationExportName) → {string}

Parse the organization from OrganizationLocationExport resource.

Parameters:
Name Type Description
organizationLocationExportName string

A fully-qualified path representing organization_location_export resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName) → {string}

Parse the organization from OrganizationLocationMuteConfig resource.

Parameters:
Name Type Description
organizationLocationMuteConfigName string

A fully-qualified path representing organization_location_mute_config resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationLocationName(organizationLocationName) → {string}

Parse the organization from OrganizationLocation resource.

Parameters:
Name Type Description
organizationLocationName string

A fully-qualified path representing OrganizationLocation resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationLocationNotificationConfigName(organizationLocationNotificationConfigName) → {string}

Parse the organization from OrganizationLocationNotificationConfig resource.

Parameters:
Name Type Description
organizationLocationNotificationConfigName string

A fully-qualified path representing organization_location_notification_config resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationMuteConfigName(organizationMuteConfigName) → {string}

Parse the organization from OrganizationMuteConfig resource.

Parameters:
Name Type Description
organizationMuteConfigName string

A fully-qualified path representing organization_mute_config resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationName(organizationName) → {string}

Parse the organization from Organization resource.

Parameters:
Name Type Description
organizationName string

A fully-qualified path representing Organization resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName) → {string}

Parse the organization from OrganizationSourceFindingExternalsystem resource.

Parameters:
Name Type Description
organizationSourceFindingExternalsystemName string

A fully-qualified path representing organization_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationSourceFindingName(organizationSourceFindingName) → {string}

Parse the organization from OrganizationSourceFinding resource.

Parameters:
Name Type Description
organizationSourceFindingName string

A fully-qualified path representing organization_source_finding resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName) → {string}

Parse the organization from OrganizationSourceFindingSecurityMarks resource.

Parameters:
Name Type Description
organizationSourceFindingSecurityMarksName string

A fully-qualified path representing organization_source_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName) → {string}

Parse the organization from OrganizationSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
organizationSourceLocationFindingExternalsystemName string

A fully-qualified path representing organization_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName) → {string}

Parse the organization from OrganizationSourceLocationFinding resource.

Parameters:
Name Type Description
organizationSourceLocationFindingName string

A fully-qualified path representing organization_source_location_finding resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName) → {string}

Parse the organization from OrganizationSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
organizationSourceLocationFindingSecurityMarksName string

A fully-qualified path representing organization_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationSourceName(organizationSourceName) → {string}

Parse the organization from OrganizationSource resource.

Parameters:
Name Type Description
organizationSourceName string

A fully-qualified path representing organization_source resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromResourceValueConfigName(resourceValueConfigName) → {string}

Parse the organization from ResourceValueConfig resource.

Parameters:
Name Type Description
resourceValueConfigName string

A fully-qualified path representing ResourceValueConfig resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromSimulationName(simulationName) → {string}

Parse the organization from Simulation resource.

Parameters:
Name Type Description
simulationName string

A fully-qualified path representing Simulation resource.
Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromValuedResourceName(valuedResourceName) → {string}

Parse the organization from ValuedResource resource.

Parameters:
Name Type Description
valuedResourceName string

A fully-qualified path representing ValuedResource resource.
Returns:
Type Description
string

A string representing the organization.

matchProjectFromProjectAssetSecurityMarksName(projectAssetSecurityMarksName) → {string}

Parse the project from ProjectAssetSecurityMarks resource.

Parameters:
Name Type Description
projectAssetSecurityMarksName string

A fully-qualified path representing project_asset_securityMarks resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectConstraintNameName(projectConstraintNameName) → {string}

Parse the project from ProjectConstraintName resource.

Parameters:
Name Type Description
projectConstraintNameName string

A fully-qualified path representing project_constraint_name resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationExportName(projectLocationExportName) → {string}

Parse the project from ProjectLocationExport resource.

Parameters:
Name Type Description
projectLocationExportName string

A fully-qualified path representing project_location_export resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationMuteConfigName(projectLocationMuteConfigName) → {string}

Parse the project from ProjectLocationMuteConfig resource.

Parameters:
Name Type Description
projectLocationMuteConfigName string

A fully-qualified path representing project_location_mute_config resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationNotificationConfigName(projectLocationNotificationConfigName) → {string}

Parse the project from ProjectLocationNotificationConfig resource.

Parameters:
Name Type Description
projectLocationNotificationConfigName string

A fully-qualified path representing project_location_notification_config resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectMuteConfigName(projectMuteConfigName) → {string}

Parse the project from ProjectMuteConfig resource.

Parameters:
Name Type Description
projectMuteConfigName string

A fully-qualified path representing project_mute_config resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName) → {string}

Parse the project from ProjectSourceFindingExternalsystem resource.

Parameters:
Name Type Description
projectSourceFindingExternalsystemName string

A fully-qualified path representing project_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectSourceFindingName(projectSourceFindingName) → {string}

Parse the project from ProjectSourceFinding resource.

Parameters:
Name Type Description
projectSourceFindingName string

A fully-qualified path representing project_source_finding resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName) → {string}

Parse the project from ProjectSourceFindingSecurityMarks resource.

Parameters:
Name Type Description
projectSourceFindingSecurityMarksName string

A fully-qualified path representing project_source_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName) → {string}

Parse the project from ProjectSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
projectSourceLocationFindingExternalsystemName string

A fully-qualified path representing project_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectSourceLocationFindingName(projectSourceLocationFindingName) → {string}

Parse the project from ProjectSourceLocationFinding resource.

Parameters:
Name Type Description
projectSourceLocationFindingName string

A fully-qualified path representing project_source_location_finding resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName) → {string}

Parse the project from ProjectSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
projectSourceLocationFindingSecurityMarksName string

A fully-qualified path representing project_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectSourceName(projectSourceName) → {string}

Parse the project from ProjectSource resource.

Parameters:
Name Type Description
projectSourceName string

A fully-qualified path representing project_source resource.
Returns:
Type Description
string

A string representing the project.

matchResourceValueConfigFromResourceValueConfigName(resourceValueConfigName) → {string}

Parse the resource_value_config from ResourceValueConfig resource.

Parameters:
Name Type Description
resourceValueConfigName string

A fully-qualified path representing ResourceValueConfig resource.
Returns:
Type Description
string

A string representing the resource_value_config.

matchSimulationFromAttackPathName(attackPathName) → {string}

Parse the simulation from AttackPath resource.

Parameters:
Name Type Description
attackPathName string

A fully-qualified path representing AttackPath resource.
Returns:
Type Description
string

A string representing the simulation.

matchSimulationFromSimulationName(simulationName) → {string}

Parse the simulation from Simulation resource.

Parameters:
Name Type Description
simulationName string

A fully-qualified path representing Simulation resource.
Returns:
Type Description
string

A string representing the simulation.

matchSimulationFromValuedResourceName(valuedResourceName) → {string}

Parse the simulation from ValuedResource resource.

Parameters:
Name Type Description
valuedResourceName string

A fully-qualified path representing ValuedResource resource.
Returns:
Type Description
string

A string representing the simulation.

matchSourceFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName) → {string}

Parse the source from FolderSourceFindingExternalsystem resource.

Parameters:
Name Type Description
folderSourceFindingExternalsystemName string

A fully-qualified path representing folder_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromFolderSourceFindingName(folderSourceFindingName) → {string}

Parse the source from FolderSourceFinding resource.

Parameters:
Name Type Description
folderSourceFindingName string

A fully-qualified path representing folder_source_finding resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName) → {string}

Parse the source from FolderSourceFindingSecurityMarks resource.

Parameters:
Name Type Description
folderSourceFindingSecurityMarksName string

A fully-qualified path representing folder_source_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName) → {string}

Parse the source from FolderSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
folderSourceLocationFindingExternalsystemName string

A fully-qualified path representing folder_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromFolderSourceLocationFindingName(folderSourceLocationFindingName) → {string}

Parse the source from FolderSourceLocationFinding resource.

Parameters:
Name Type Description
folderSourceLocationFindingName string

A fully-qualified path representing folder_source_location_finding resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName) → {string}

Parse the source from FolderSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
folderSourceLocationFindingSecurityMarksName string

A fully-qualified path representing folder_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromFolderSourceName(folderSourceName) → {string}

Parse the source from FolderSource resource.

Parameters:
Name Type Description
folderSourceName string

A fully-qualified path representing folder_source resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName) → {string}

Parse the source from OrganizationSourceFindingExternalsystem resource.

Parameters:
Name Type Description
organizationSourceFindingExternalsystemName string

A fully-qualified path representing organization_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromOrganizationSourceFindingName(organizationSourceFindingName) → {string}

Parse the source from OrganizationSourceFinding resource.

Parameters:
Name Type Description
organizationSourceFindingName string

A fully-qualified path representing organization_source_finding resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName) → {string}

Parse the source from OrganizationSourceFindingSecurityMarks resource.

Parameters:
Name Type Description
organizationSourceFindingSecurityMarksName string

A fully-qualified path representing organization_source_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName) → {string}

Parse the source from OrganizationSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
organizationSourceLocationFindingExternalsystemName string

A fully-qualified path representing organization_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName) → {string}

Parse the source from OrganizationSourceLocationFinding resource.

Parameters:
Name Type Description
organizationSourceLocationFindingName string

A fully-qualified path representing organization_source_location_finding resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName) → {string}

Parse the source from OrganizationSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
organizationSourceLocationFindingSecurityMarksName string

A fully-qualified path representing organization_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromOrganizationSourceName(organizationSourceName) → {string}

Parse the source from OrganizationSource resource.

Parameters:
Name Type Description
organizationSourceName string

A fully-qualified path representing organization_source resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName) → {string}

Parse the source from ProjectSourceFindingExternalsystem resource.

Parameters:
Name Type Description
projectSourceFindingExternalsystemName string

A fully-qualified path representing project_source_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromProjectSourceFindingName(projectSourceFindingName) → {string}

Parse the source from ProjectSourceFinding resource.

Parameters:
Name Type Description
projectSourceFindingName string

A fully-qualified path representing project_source_finding resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName) → {string}

Parse the source from ProjectSourceFindingSecurityMarks resource.

Parameters:
Name Type Description
projectSourceFindingSecurityMarksName string

A fully-qualified path representing project_source_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName) → {string}

Parse the source from ProjectSourceLocationFindingExternalsystem resource.

Parameters:
Name Type Description
projectSourceLocationFindingExternalsystemName string

A fully-qualified path representing project_source_location_finding_externalsystem resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromProjectSourceLocationFindingName(projectSourceLocationFindingName) → {string}

Parse the source from ProjectSourceLocationFinding resource.

Parameters:
Name Type Description
projectSourceLocationFindingName string

A fully-qualified path representing project_source_location_finding resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName) → {string}

Parse the source from ProjectSourceLocationFindingSecurityMarks resource.

Parameters:
Name Type Description
projectSourceLocationFindingSecurityMarksName string

A fully-qualified path representing project_source_location_finding_securityMarks resource.
Returns:
Type Description
string

A string representing the source.

matchSourceFromProjectSourceName(projectSourceName) → {string}

Parse the source from ProjectSource resource.

Parameters:
Name Type Description
projectSourceName string

A fully-qualified path representing project_source resource.
Returns:
Type Description
string

A string representing the source.

matchValuedResourceFromAttackPathName(attackPathName) → {string}

Parse the valued_resource from AttackPath resource.

Parameters:
Name Type Description
attackPathName string

A fully-qualified path representing AttackPath resource.
Returns:
Type Description
string

A string representing the valued_resource.

matchValuedResourceFromValuedResourceName(valuedResourceName) → {string}

Parse the valued_resource from ValuedResource resource.

Parameters:
Name Type Description
valuedResourceName string

A fully-qualified path representing ValuedResource resource.
Returns:
Type Description
string

A string representing the valued_resource.

organizationAssetSecurityMarksPath(organization, asset) → {string}

Return a fully-qualified organizationAssetSecurityMarks resource name string.

Parameters:
Name Type Description
organization string
asset string
Returns:
Type Description
string

Resource name string.

organizationConstraintNamePath(organization, constraint_name) → {string}

Return a fully-qualified organizationConstraintName resource name string.

Parameters:
Name Type Description
organization string
constraint_name string
Returns:
Type Description
string

Resource name string.

organizationLocationExportPath(organization, location, exportParam) → {string}

Return a fully-qualified organizationLocationExport resource name string.

Parameters:
Name Type Description
organization string
location string
exportParam string
Returns:
Type Description
string

Resource name string.

organizationLocationMuteConfigPath(organization, location, mute_config) → {string}

Return a fully-qualified organizationLocationMuteConfig resource name string.

Parameters:
Name Type Description
organization string
location string
mute_config string
Returns:
Type Description
string

Resource name string.

organizationLocationNotificationConfigPath(organization, location, notification_config) → {string}

Return a fully-qualified organizationLocationNotificationConfig resource name string.

Parameters:
Name Type Description
organization string
location string
notification_config string
Returns:
Type Description
string

Resource name string.

organizationLocationPath(organization, location) → {string}

Return a fully-qualified organizationLocation resource name string.

Parameters:
Name Type Description
organization string
location string
Returns:
Type Description
string

Resource name string.

organizationMuteConfigPath(organization, mute_config) → {string}

Return a fully-qualified organizationMuteConfig resource name string.

Parameters:
Name Type Description
organization string
mute_config string
Returns:
Type Description
string

Resource name string.

organizationPath(organization) → {string}

Return a fully-qualified organization resource name string.

Parameters:
Name Type Description
organization string
Returns:
Type Description
string

Resource name string.

organizationSourceFindingExternalsystemPath(organization, source, finding, externalsystem) → {string}

Return a fully-qualified organizationSourceFindingExternalsystem resource name string.

Parameters:
Name Type Description
organization string
source string
finding string
externalsystem string
Returns:
Type Description
string

Resource name string.

organizationSourceFindingPath(organization, source, finding) → {string}

Return a fully-qualified organizationSourceFinding resource name string.

Parameters:
Name Type Description
organization string
source string
finding string
Returns:
Type Description
string

Resource name string.

organizationSourceFindingSecurityMarksPath(organization, source, finding) → {string}

Return a fully-qualified organizationSourceFindingSecurityMarks resource name string.

Parameters:
Name Type Description
organization string
source string
finding string
Returns:
Type Description
string

Resource name string.

organizationSourceLocationFindingExternalsystemPath(organization, source, location, finding, externalsystem) → {string}

Return a fully-qualified organizationSourceLocationFindingExternalsystem resource name string.

Parameters:
Name Type Description
organization string
source string
location string
finding string
externalsystem string
Returns:
Type Description
string

Resource name string.

organizationSourceLocationFindingPath(organization, source, location, finding) → {string}

Return a fully-qualified organizationSourceLocationFinding resource name string.

Parameters:
Name Type Description
organization string
source string
location string
finding string
Returns:
Type Description
string

Resource name string.

organizationSourceLocationFindingSecurityMarksPath(organization, source, location, finding) → {string}

Return a fully-qualified organizationSourceLocationFindingSecurityMarks resource name string.

Parameters:
Name Type Description
organization string
source string
location string
finding string
Returns:
Type Description
string

Resource name string.

organizationSourcePath(organization, source) → {string}

Return a fully-qualified organizationSource resource name string.

Parameters:
Name Type Description
organization string
source string
Returns:
Type Description
string

Resource name string.

projectAssetSecurityMarksPath(project, asset) → {string}

Return a fully-qualified projectAssetSecurityMarks resource name string.

Parameters:
Name Type Description
project string
asset string
Returns:
Type Description
string

Resource name string.

projectConstraintNamePath(project, constraint_name) → {string}

Return a fully-qualified projectConstraintName resource name string.

Parameters:
Name Type Description
project string
constraint_name string
Returns:
Type Description
string

Resource name string.

projectLocationExportPath(project, location, exportParam) → {string}

Return a fully-qualified projectLocationExport resource name string.

Parameters:
Name Type Description
project string
location string
exportParam string
Returns:
Type Description
string

Resource name string.

projectLocationMuteConfigPath(project, location, mute_config) → {string}

Return a fully-qualified projectLocationMuteConfig resource name string.

Parameters:
Name Type Description
project string
location string
mute_config string
Returns:
Type Description
string

Resource name string.

projectLocationNotificationConfigPath(project, location, notification_config) → {string}

Return a fully-qualified projectLocationNotificationConfig resource name string.

Parameters:
Name Type Description
project string
location string
notification_config string
Returns:
Type Description
string

Resource name string.

projectMuteConfigPath(project, mute_config) → {string}

Return a fully-qualified projectMuteConfig resource name string.

Parameters:
Name Type Description
project string
mute_config string
Returns:
Type Description
string

Resource name string.

projectSourceFindingExternalsystemPath(project, source, finding, externalsystem) → {string}

Return a fully-qualified projectSourceFindingExternalsystem resource name string.

Parameters:
Name Type Description
project string
source string
finding string
externalsystem string
Returns:
Type Description
string

Resource name string.

projectSourceFindingPath(project, source, finding) → {string}

Return a fully-qualified projectSourceFinding resource name string.

Parameters:
Name Type Description
project string
source string
finding string
Returns:
Type Description
string

Resource name string.

projectSourceFindingSecurityMarksPath(project, source, finding) → {string}

Return a fully-qualified projectSourceFindingSecurityMarks resource name string.

Parameters:
Name Type Description
project string
source string
finding string
Returns:
Type Description
string

Resource name string.

projectSourceLocationFindingExternalsystemPath(project, source, location, finding, externalsystem) → {string}

Return a fully-qualified projectSourceLocationFindingExternalsystem resource name string.

Parameters:
Name Type Description
project string
source string
location string
finding string
externalsystem string
Returns:
Type Description
string

Resource name string.

projectSourceLocationFindingPath(project, source, location, finding) → {string}

Return a fully-qualified projectSourceLocationFinding resource name string.

Parameters:
Name Type Description
project string
source string
location string
finding string
Returns:
Type Description
string

Resource name string.

projectSourceLocationFindingSecurityMarksPath(project, source, location, finding) → {string}

Return a fully-qualified projectSourceLocationFindingSecurityMarks resource name string.

Parameters:
Name Type Description
project string
source string
location string
finding string
Returns:
Type Description
string

Resource name string.

projectSourcePath(project, source) → {string}

Return a fully-qualified projectSource resource name string.

Parameters:
Name Type Description
project string
source string
Returns:
Type Description
string

Resource name string.

resourceValueConfigPath(organization, resource_value_config) → {string}

Return a fully-qualified resourceValueConfig resource name string.

Parameters:
Name Type Description
organization string
resource_value_config string
Returns:
Type Description
string

Resource name string.

simulationPath(organization, simulation) → {string}

Return a fully-qualified simulation resource name string.

Parameters:
Name Type Description
organization string
simulation string
Returns:
Type Description
string

Resource name string.

valuedResourcePath(organization, simulation, valued_resource) → {string}

Return a fully-qualified valuedResource resource name string.

Parameters:
Name Type Description
organization string
simulation string
valued_resource string
Returns:
Type Description
string

Resource name string.