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
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
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
|
|||||||
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 |
|
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 |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent, at which bulk action needs to be applied. Its format
* is `organizations/[organization_id]`, `folders/[folder_id]`,
* `projects/[project_id]`.
*/
// const parent = 'abc123'
/**
* Expression that identifies findings that should be updated.
* The expression is a list of zero or more restrictions combined
* via logical operators `AND` and `OR`. Parentheses are supported, and `OR`
* has higher precedence than `AND`.
* Restrictions have the form `<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'
/**
* This can be a mute configuration name or any identifier for mute/unmute
* of findings based on the filter.
*/
// const muteAnnotation = 'abc123'
/**
* Optional. All findings matching the given filter will have their mute state
* set to this value. The default value is `MUTED`. Setting this to
* `UNDEFINED` will clear the mute state on all matching findings.
*/
// const muteState = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// 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();
(async) checkRunAssetDiscoveryProgress(name) → {Promise}
Check the status of the long running operation returned by runAssetDiscovery()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the organization to run asset discovery for. Its format
* is `organizations/[organization_id]`.
*/
// const parent = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callRunAssetDiscovery() {
// Construct request
const request = {
parent,
};
// Run request
const [operation] = await securitycenterClient.runAssetDiscovery(request);
const [response] = await operation.promise();
console.log(response);
}
callRunAssetDiscovery();
close() → {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
|
|||||||
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 |
|
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```
folderAssetPath(folder, asset) → {string}
Return a fully-qualified folderAsset resource name string.
Parameters:
Name | Type | Description |
---|---|---|
folder |
string | |
asset |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
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. |
folderEventThreatDetectionSettingsModulePath(folder, module) → {string}
Return a fully-qualified folderEventThreatDetectionSettingsModule resource name string.
Parameters:
Name | Type | Description |
---|---|---|
folder |
string | |
module |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
folderExportPath(folder, exportParam) → {string}
Return a fully-qualified folderExport resource name string.
Parameters:
Name | Type | Description |
---|---|---|
folder |
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. |
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. |
folderNotificationConfigPath(folder, notification_config) → {string}
Return a fully-qualified folderNotificationConfig resource name string.
Parameters:
Name | Type | Description |
---|---|---|
folder |
string | |
notification_config |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
folderSecurityHealthAnalyticsSettingsCustomModulePath(folder, custom_module) → {string}
Return a fully-qualified folderSecurityHealthAnalyticsSettingsCustomModule resource name string.
Parameters:
Name | Type | Description |
---|---|---|
folder |
string | |
custom_module |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
folderSecurityHealthAnalyticsSettingsEffectiveCustomModulePath(folder, effective_custom_module) → {string}
Return a fully-qualified folderSecurityHealthAnalyticsSettingsEffectiveCustomModule resource name string.
Parameters:
Name | Type | Description |
---|---|---|
folder |
string | |
effective_custom_module |
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. |
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
|
|||||||
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 |
|
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. |
groupAssetsAsync(request, optionsopt) → {Object}
Equivalent to groupAssets
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||||||
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. The name of the parent to group the assets by. Its format is
* `organizations/[organization_id]`, `folders/[folder_id]`, or
* `projects/[project_id]`.
*/
// const parent = 'abc123'
/**
* Expression that defines the filter to apply across assets.
* The expression is a list of zero or more restrictions combined via logical
* operators `AND` and `OR`.
* Parentheses are supported, and `OR` has higher precedence than `AND`.
* Restrictions have the form `<field> <operator> <value>` and may have a `-`
* character in front of them to indicate negation. The fields map to those
* defined in the Asset resource. Examples include:
* * name
* * security_center_properties.resource_name
* * resource_properties.a_property
* * 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: `=`
* * update_time: `=`, `>`, `<`, `>=`, `<=`
* Usage: This should be milliseconds since epoch or an RFC3339 string.
* Examples:
* `update_time = "2019-06-10T16:07:18-07:00"`
* `update_time = 1560208038000`
* * create_time: `=`, `>`, `<`, `>=`, `<=`
* Usage: This should be milliseconds since epoch or an RFC3339 string.
* Examples:
* `create_time = "2019-06-10T16:07:18-07:00"`
* `create_time = 1560208038000`
* * iam_policy.policy_blob: `=`, `:`
* * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
* * security_marks.marks: `=`, `:`
* * security_center_properties.resource_name: `=`, `:`
* * security_center_properties.resource_display_name: `=`, `:`
* * security_center_properties.resource_type: `=`, `:`
* * security_center_properties.resource_parent: `=`, `:`
* * security_center_properties.resource_parent_display_name: `=`, `:`
* * security_center_properties.resource_project: `=`, `:`
* * security_center_properties.resource_project_display_name: `=`, `:`
* * security_center_properties.resource_owners: `=`, `:`
* For example, `resource_properties.size = 100` is a valid filter string.
* Use a partial match on the empty string to filter based on a property
* existing: `resource_properties.my_property : ""`
* Use a negated partial match on the empty string to filter based on a
* property not existing: `-resource_properties.my_property : ""`
*/
// 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:
* "security_center_properties.resource_project,security_center_properties.project".
* The following fields are supported when compare_duration is not set:
* * security_center_properties.resource_project
* * security_center_properties.resource_project_display_name
* * security_center_properties.resource_type
* * security_center_properties.resource_parent
* * security_center_properties.resource_parent_display_name
* The following fields are supported when compare_duration is set:
* * security_center_properties.resource_type
* * security_center_properties.resource_project_display_name
* * security_center_properties.resource_parent_display_name
*/
// const groupBy = 'abc123'
/**
* When compare_duration is set, the GroupResult's "state_change" property is
* updated to indicate whether the asset was added, removed, or remained
* present during the compare_duration period of time that precedes the
* read_time. This is the time between (read_time - compare_duration) and
* read_time.
* The state change value is derived based on the presence of the asset at the
* two points in time. Intermediate state changes between the two times don't
* affect the result. For example, the results aren't affected if the asset is
* removed and re-created again.
* Possible "state_change" values when compare_duration is specified:
* * "ADDED": indicates that the asset was not present at the start of
* compare_duration, but present at reference_time.
* * "REMOVED": indicates that the asset was present at the start of
* compare_duration, but not present at reference_time.
* * "ACTIVE": indicates that the asset was present at both the
* start and the end of the time period defined by
* compare_duration and reference_time.
* If compare_duration is not specified, then the only possible state_change
* is "UNUSED", which will be the state_change set for all assets present at
* read_time.
* If this field is set then `state_change` must be a specified field in
* `group_by`.
*/
// const compareDuration = {}
/**
* Time used as a reference point when filtering assets. The filter is limited
* to assets existing at the supplied time and their values are those at that
* specific time. Absence of this field will default to the API's version of
* NOW.
*/
// const readTime = {}
/**
* The value returned by the last `GroupAssetsResponse`; indicates
* that this is a continuation of a prior `GroupAssets` call, and that the
* system should return the next page of data.
*/
// const pageToken = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callGroupAssets() {
// Construct request
const request = {
parent,
groupBy,
};
// Run request
const iterable = securitycenterClient.groupAssetsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callGroupAssets();
groupAssetsStream(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
|
|||||||||||||||||||||||||
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(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
|
|||||||||||||||||||||||||
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. Its format is
* `organizations/[organization_id]/sources/[source_id]`,
* `folders/[folder_id]/sources/[source_id]`, or
* `projects/[project_id]/sources/[source_id]`. To groupBy across all sources
* provide a source_id of `-`. For example:
* `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`,
* or `projects/{project_id}/sources/-`
*/
// const parent = 'abc123'
/**
* Expression that defines the filter to apply across findings.
* The expression is a list of one or more restrictions combined via logical
* operators `AND` and `OR`.
* Parentheses are supported, and `OR` has higher precedence than `AND`.
* Restrictions have the form `<field> <operator> <value>` and may have a `-`
* character in front of them to indicate negation. Examples include:
* * name
* * source_properties.a_property
* * 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: `=`, `:`
* * workflow_state: `=`, `:`
* * security_marks.marks: `=`, `:`
* * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
* For example, `source_properties.size = 100` is a valid filter string.
* Use a partial match on the empty string to filter based on a property
* existing: `source_properties.my_property : ""`
* Use a negated partial match on the empty string to filter based on a
* property not existing: `-source_properties.my_property : ""`
* * 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
* (including `state_change`). The string value should follow SQL syntax:
* comma separated list of fields. For example: "parent,resource_name".
* The following fields are supported when compare_duration is set:
* * state_change
*/
// const groupBy = 'abc123'
/**
* Time used as a reference point when filtering findings. The filter is
* limited to findings existing at the supplied time and their values are
* those at that specific time. Absence of this field will default to the
* API's version of NOW.
*/
// const readTime = {}
/**
* When compare_duration is set, the GroupResult's "state_change" attribute is
* updated to indicate whether the finding had its state changed, the
* finding's state remained unchanged, or if the finding was added during the
* compare_duration period of time that precedes the read_time. This is the
* time between (read_time - compare_duration) and read_time.
* The state_change value is derived based on the presence and state of the
* finding at the two points in time. Intermediate state changes between the
* two times don't affect the result. For example, the results aren't affected
* if the finding is made inactive and then active again.
* Possible "state_change" values when compare_duration is specified:
* * "CHANGED": indicates that the finding was present and matched the given
* filter at the start of compare_duration, but changed its
* state at read_time.
* * "UNCHANGED": indicates that the finding was present and matched the given
* filter at the start of compare_duration and did not change
* state at read_time.
* * "ADDED": indicates that the finding did not match the given filter or
* was not present at the start of compare_duration, but was
* present at read_time.
* * "REMOVED": indicates that the finding was present and matched the
* filter at the start of compare_duration, but did not match
* the filter at read_time.
* If compare_duration is not specified, then the only possible state_change
* is "UNUSED", which will be the state_change set for all findings present
* at read_time.
* If this field is set then `state_change` must be a specified field in
* `group_by`.
*/
// const compareDuration = {}
/**
* 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/security-center').v1;
// 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
|
|||||||||||||||||||||||||
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 |
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. |
listAssetsAsync(request, optionsopt) → {Object}
Equivalent to listAssets
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||||||||||||||
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 ListAssetsResult. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource that contains the assets. The
* value that you can specify on parent depends on the method in which you
* specify parent. You can specify one of the following values:
* `organizations/[organization_id]`, `folders/[folder_id]`, or
* `projects/[project_id]`.
*/
// const parent = 'abc123'
/**
* Expression that defines the filter to apply across assets.
* The expression is a list of zero or more restrictions combined via logical
* operators `AND` and `OR`.
* Parentheses are supported, and `OR` has higher precedence than `AND`.
* Restrictions have the form `<field> <operator> <value>` and may have a `-`
* character in front of them to indicate negation. The fields map to those
* defined in the Asset resource. Examples include:
* * name
* * security_center_properties.resource_name
* * resource_properties.a_property
* * 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 are the allowed field and operator combinations:
* * name: `=`
* * update_time: `=`, `>`, `<`, `>=`, `<=`
* Usage: This should be milliseconds since epoch or an RFC3339 string.
* Examples:
* `update_time = "2019-06-10T16:07:18-07:00"`
* `update_time = 1560208038000`
* * create_time: `=`, `>`, `<`, `>=`, `<=`
* Usage: This should be milliseconds since epoch or an RFC3339 string.
* Examples:
* `create_time = "2019-06-10T16:07:18-07:00"`
* `create_time = 1560208038000`
* * iam_policy.policy_blob: `=`, `:`
* * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
* * security_marks.marks: `=`, `:`
* * security_center_properties.resource_name: `=`, `:`
* * security_center_properties.resource_display_name: `=`, `:`
* * security_center_properties.resource_type: `=`, `:`
* * security_center_properties.resource_parent: `=`, `:`
* * security_center_properties.resource_parent_display_name: `=`, `:`
* * security_center_properties.resource_project: `=`, `:`
* * security_center_properties.resource_project_display_name: `=`, `:`
* * security_center_properties.resource_owners: `=`, `:`
* For example, `resource_properties.size = 100` is a valid filter string.
* Use a partial match on the empty string to filter based on a property
* existing: `resource_properties.my_property : ""`
* Use a negated partial match on the empty string to filter based on a
* property not existing: `-resource_properties.my_property : ""`
*/
// 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,resource_properties.a_property". 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,resource_properties.a_property". Redundant space characters in the
* syntax are insignificant. "name desc,resource_properties.a_property" and "
* name desc , resource_properties.a_property " are equivalent.
* The following fields are supported:
* name
* update_time
* resource_properties
* security_marks.marks
* security_center_properties.resource_name
* security_center_properties.resource_display_name
* security_center_properties.resource_parent
* security_center_properties.resource_parent_display_name
* security_center_properties.resource_project
* security_center_properties.resource_project_display_name
* security_center_properties.resource_type
*/
// const orderBy = 'abc123'
/**
* Time used as a reference point when filtering assets. The filter is limited
* to assets existing at the supplied time and their values are those at that
* specific time. Absence of this field will default to the API's version of
* NOW.
*/
// const readTime = {}
/**
* When compare_duration is set, the ListAssetsResult's "state_change"
* attribute is updated to indicate whether the asset was added, removed, or
* remained present during the compare_duration period of time that precedes
* the read_time. This is the time between (read_time - compare_duration) and
* read_time.
* The state_change value is derived based on the presence of the asset at the
* two points in time. Intermediate state changes between the two times don't
* affect the result. For example, the results aren't affected if the asset is
* removed and re-created again.
* Possible "state_change" values when compare_duration is specified:
* * "ADDED": indicates that the asset was not present at the start of
* compare_duration, but present at read_time.
* * "REMOVED": indicates that the asset was present at the start of
* compare_duration, but not present at read_time.
* * "ACTIVE": indicates that the asset was present at both the
* start and the end of the time period defined by
* compare_duration and read_time.
* If compare_duration is not specified, then the only possible state_change
* is "UNUSED", which will be the state_change set for all assets present at
* read_time.
*/
// const compareDuration = {}
/**
* A field mask to specify the ListAssetsResult fields to be listed in the
* response.
* An empty field mask will list all fields.
*/
// const fieldMask = {}
/**
* The value returned by the last `ListAssetsResponse`; indicates
* that this is a continuation of a prior `ListAssets` call, and
* that the system should return the next page of data.
*/
// const pageToken = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListAssets() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listAssetsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAssets();
listAssetsStream(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
|
||||||||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing ListAssetsResult 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(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
|
||||||||||||||||
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/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListAttackPaths() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listAttackPathsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAttackPaths();
listAttackPathsStream(request, 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
|
||||||||||||||||
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 |
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
|
|||||||||||||
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]`, `folders/[folder_id]`,
* `projects/[project_id]`.
*/
// const parent = 'abc123'
/**
* The maximum number of configs to return. The service may return fewer than
* this value.
* If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListBigQueryExports` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListBigQueryExports`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListBigQueryExports() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listBigQueryExportsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListBigQueryExports();
listBigQueryExportsStream(request, 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
|
|||||||||||||
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 |
listDescendantEventThreatDetectionCustomModulesAsync(request, optionsopt) → {Object}
Equivalent to listDescendantEventThreatDetectionCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
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 EventThreatDetectionCustomModule. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the parent to list custom modules under.
* Its format is:
* * `organizations/{organization}/eventThreatDetectionSettings`.
* * `folders/{folder}/eventThreatDetectionSettings`.
* * `projects/{project}/eventThreatDetectionSettings`.
*/
// const parent = 'abc123'
/**
* A page token, received from a previous
* `ListDescendantEventThreatDetectionCustomModules` call. Provide this to
* retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListDescendantEventThreatDetectionCustomModules` must match the call that
* provided the page token.
*/
// const pageToken = 'abc123'
/**
* The maximum number of modules to return. The service may return fewer than
* this value.
* If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListDescendantEventThreatDetectionCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listDescendantEventThreatDetectionCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDescendantEventThreatDetectionCustomModules();
listDescendantEventThreatDetectionCustomModulesStream(request, 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
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing EventThreatDetectionCustomModule on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listDescendantSecurityHealthAnalyticsCustomModulesAsync(request, optionsopt) → {Object}
Equivalent to listDescendantSecurityHealthAnalyticsCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
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 SecurityHealthAnalyticsCustomModule. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of parent to list descendant custom modules. Its format is
* `organizations/{organization}/securityHealthAnalyticsSettings`,
* `folders/{folder}/securityHealthAnalyticsSettings`, or
* `projects/{project}/securityHealthAnalyticsSettings`
*/
// const parent = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
/**
* The value returned by the last call indicating a continuation
*/
// const pageToken = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListDescendantSecurityHealthAnalyticsCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listDescendantSecurityHealthAnalyticsCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDescendantSecurityHealthAnalyticsCustomModules();
listDescendantSecurityHealthAnalyticsCustomModulesStream(request, 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
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing SecurityHealthAnalyticsCustomModule on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listEffectiveEventThreatDetectionCustomModulesAsync(request, optionsopt) → {Object}
Equivalent to listEffectiveEventThreatDetectionCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
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 EffectiveEventThreatDetectionCustomModule. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the parent to list custom modules for.
* Its format is:
* * `organizations/{organization}/eventThreatDetectionSettings`.
* * `folders/{folder}/eventThreatDetectionSettings`.
* * `projects/{project}/eventThreatDetectionSettings`.
*/
// const parent = 'abc123'
/**
* A page token, received from a previous
* `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to
* retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListEffectiveEventThreatDetectionCustomModules` must match the call that
* provided the page token.
*/
// const pageToken = 'abc123'
/**
* The maximum number of modules to return. The service may return fewer than
* this value.
* If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListEffectiveEventThreatDetectionCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listEffectiveEventThreatDetectionCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListEffectiveEventThreatDetectionCustomModules();
listEffectiveEventThreatDetectionCustomModulesStream(request, 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
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing EffectiveEventThreatDetectionCustomModule on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listEffectiveSecurityHealthAnalyticsCustomModulesAsync(request, optionsopt) → {Object}
Equivalent to listEffectiveSecurityHealthAnalyticsCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
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 EffectiveSecurityHealthAnalyticsCustomModule. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of parent to list effective custom modules. Its format is
* `organizations/{organization}/securityHealthAnalyticsSettings`,
* `folders/{folder}/securityHealthAnalyticsSettings`, or
* `projects/{project}/securityHealthAnalyticsSettings`
*/
// const parent = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
/**
* The value returned by the last call indicating a continuation
*/
// const pageToken = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListEffectiveSecurityHealthAnalyticsCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listEffectiveSecurityHealthAnalyticsCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListEffectiveSecurityHealthAnalyticsCustomModules();
listEffectiveSecurityHealthAnalyticsCustomModulesStream(request, 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
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing EffectiveSecurityHealthAnalyticsCustomModule on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listEventThreatDetectionCustomModulesAsync(request, optionsopt) → {Object}
Equivalent to listEventThreatDetectionCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
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 EventThreatDetectionCustomModule. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the parent to list custom modules under.
* Its format is:
* * `organizations/{organization}/eventThreatDetectionSettings`.
* * `folders/{folder}/eventThreatDetectionSettings`.
* * `projects/{project}/eventThreatDetectionSettings`.
*/
// const parent = 'abc123'
/**
* A page token, received from a previous
* `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the
* subsequent page.
* When paginating, all other parameters provided to
* `ListEventThreatDetectionCustomModules` must match the call that provided
* the page token.
*/
// const pageToken = 'abc123'
/**
* The maximum number of modules to return. The service may return fewer than
* this value.
* If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListEventThreatDetectionCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listEventThreatDetectionCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListEventThreatDetectionCustomModules();
listEventThreatDetectionCustomModulesStream(request, 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
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing EventThreatDetectionCustomModule 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(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
|
||||||||||||||||||||||||||||
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. Its format is
* `organizations/[organization_id]/sources/[source_id]`,
* `folders/[folder_id]/sources/[source_id]`, or
* `projects/[project_id]/sources/[source_id]`. To list across all sources
* provide a source_id of `-`. For example:
* `organizations/{organization_id}/sources/-`,
* `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`
*/
// const parent = 'abc123'
/**
* Expression that defines the filter to apply across findings.
* The expression is a list of one or more restrictions combined via logical
* operators `AND` and `OR`.
* Parentheses are supported, and `OR` has higher precedence than `AND`.
* Restrictions have the form `<field> <operator> <value>` and may have a `-`
* character in front of them to indicate negation. Examples include:
* * name
* * source_properties.a_property
* * 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: `=`, `:`
* * workflow_state: `=`, `:`
* * security_marks.marks: `=`, `:`
* * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
* For example, `source_properties.size = 100` is a valid filter string.
* Use a partial match on the empty string to filter based on a property
* existing: `source_properties.my_property : ""`
* Use a negated partial match on the empty string to filter based on a
* property not existing: `-source_properties.my_property : ""`
* * 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,resource_properties.a_property". 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,source_properties.a_property". Redundant space characters in the
* syntax are insignificant. "name desc,source_properties.a_property" and "
* name desc , source_properties.a_property " are equivalent.
* The following fields are supported:
* name
* parent
* state
* category
* resource_name
* event_time
* source_properties
* security_marks.marks
*/
// const orderBy = 'abc123'
/**
* Time used as a reference point when filtering findings. The filter is
* limited to findings existing at the supplied time and their values are
* those at that specific time. Absence of this field will default to the
* API's version of NOW.
*/
// const readTime = {}
/**
* When compare_duration is set, the ListFindingsResult's "state_change"
* attribute is updated to indicate whether the finding had its state changed,
* the finding's state remained unchanged, or if the finding was added in any
* state during the compare_duration period of time that precedes the
* read_time. This is the time between (read_time - compare_duration) and
* read_time.
* The state_change value is derived based on the presence and state of the
* finding at the two points in time. Intermediate state changes between the
* two times don't affect the result. For example, the results aren't affected
* if the finding is made inactive and then active again.
* Possible "state_change" values when compare_duration is specified:
* * "CHANGED": indicates that the finding was present and matched the given
* filter at the start of compare_duration, but changed its
* state at read_time.
* * "UNCHANGED": indicates that the finding was present and matched the given
* filter at the start of compare_duration and did not change
* state at read_time.
* * "ADDED": indicates that the finding did not match the given filter or
* was not present at the start of compare_duration, but was
* present at read_time.
* * "REMOVED": indicates that the finding was present and matched the
* filter at the start of compare_duration, but did not match
* the filter at read_time.
* If compare_duration is not specified, then the only possible state_change
* is "UNUSED", which will be the state_change set for all findings present at
* read_time.
*/
// const compareDuration = {}
/**
* 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/security-center').v1;
// 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
|
||||||||||||||||||||||||||||
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 |
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
|
|||||||||||||
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]`.
*/
// const parent = 'abc123'
/**
* The maximum number of configs to return. The service may return fewer than
* this value.
* If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListMuteConfigs` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListMuteConfigs` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListMuteConfigs() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listMuteConfigsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListMuteConfigs();
listMuteConfigsStream(request, 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
|
|||||||||||||
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 |
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
|
|||||||||||||
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]",
* "folders/[folder_id]", or "projects/[project_id]".
*/
// const parent = 'abc123'
/**
* The value returned by the last `ListNotificationConfigsResponse`; indicates
* that this is a continuation of a prior `ListNotificationConfigs` call, and
* that the system should return the next page of data.
*/
// const pageToken = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListNotificationConfigs() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listNotificationConfigsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListNotificationConfigs();
listNotificationConfigsStream(request, 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
|
|||||||||||||
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 |
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
|
|||||||||||||||||
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
|
|||||||||||||
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 number of results to return. The service may return fewer than
* this value.
* If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListResourceValueConfigs` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListResourceValueConfigs` must match the call that provided the
* page token.
* page_size can be specified, and the new page_size will be used.
*/
// const pageToken = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListResourceValueConfigs() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listResourceValueConfigsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListResourceValueConfigs();
listResourceValueConfigsStream(request, 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
|
|||||||||||||
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 |
listSecurityHealthAnalyticsCustomModulesAsync(request, optionsopt) → {Object}
Equivalent to listSecurityHealthAnalyticsCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
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 SecurityHealthAnalyticsCustomModule. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of parent to list custom modules. Its format is
* `organizations/{organization}/securityHealthAnalyticsSettings`,
* `folders/{folder}/securityHealthAnalyticsSettings`, or
* `projects/{project}/securityHealthAnalyticsSettings`
*/
// const parent = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
/**
* The value returned by the last call indicating a continuation
*/
// const pageToken = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListSecurityHealthAnalyticsCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listSecurityHealthAnalyticsCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListSecurityHealthAnalyticsCustomModules();
listSecurityHealthAnalyticsCustomModulesStream(request, 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
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing SecurityHealthAnalyticsCustomModule 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(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
|
|||||||||||||
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/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListSources() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listSourcesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListSources();
listSourcesStream(request, 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
|
|||||||||||||
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 |
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
|
|||||||||||||||||||||||||
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 valued resources.
* Valid formats:
* `organizations/{organization}`,
* `organizations/{organization}/simulations/{simulation}`
* `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}`
*/
// const parent = 'abc123'
/**
* The filter expression that filters the valued resources in the response.
* Supported fields:
* * `resource_value` supports =
* * `resource_type` supports =
*/
// const filter = 'abc123'
/**
* The value returned by the last `ListValuedResourcesResponse`; indicates
* that this is a continuation of a prior `ListValuedResources` call, and
* that the system should return the next page of data.
*/
// const pageToken = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
/**
* Optional. The fields by which to order the valued resources response.
* Supported fields:
* * `exposed_score`
* * `resource_value`
* * `resource_type`
* * `resource`
* * `display_name`
* Values should be a comma separated list of fields. For example:
* `exposed_score,resource_value`.
* The default sorting order is descending. To specify ascending or descending
* order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for
* example: `exposed_score DESC`.
*/
// const orderBy = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/security-center').v1;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListValuedResources() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listValuedResourcesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListValuedResources();
listValuedResourcesStream(request, 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
|
|||||||||||||||||||||||||
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 |
matchAssetFromFolderAssetName(folderAssetName) → {string}
Parse the asset from FolderAsset resource.
Parameters:
Name | Type | Description |
---|---|---|
folderAssetName |
string |
A fully-qualified path representing folder_asset resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the asset. |
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. |
matchAssetFromOrganizationAssetName(organizationAssetName) → {string}
Parse the asset from OrganizationAsset resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationAssetName |
string |
A fully-qualified path representing organization_asset 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. |
matchAssetFromProjectAssetName(projectAssetName) → {string}
Parse the asset from ProjectAsset resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAssetName |
string |
A fully-qualified path representing project_asset 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. |
matchCustomModuleFromFolderSecurityHealthAnalyticsSettingsCustomModuleName(folderSecurityHealthAnalyticsSettingsCustomModuleName) → {string}
Parse the custom_module from FolderSecurityHealthAnalyticsSettingsCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
folderSecurityHealthAnalyticsSettingsCustomModuleName |
string |
A fully-qualified path representing folder_securityHealthAnalyticsSettings_custom_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the custom_module. |
matchCustomModuleFromOrganizationSecurityHealthAnalyticsSettingsCustomModuleName(organizationSecurityHealthAnalyticsSettingsCustomModuleName) → {string}
Parse the custom_module from OrganizationSecurityHealthAnalyticsSettingsCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationSecurityHealthAnalyticsSettingsCustomModuleName |
string |
A fully-qualified path representing organization_securityHealthAnalyticsSettings_custom_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the custom_module. |
matchCustomModuleFromProjectSecurityHealthAnalyticsSettingsCustomModuleName(projectSecurityHealthAnalyticsSettingsCustomModuleName) → {string}
Parse the custom_module from ProjectSecurityHealthAnalyticsSettingsCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
projectSecurityHealthAnalyticsSettingsCustomModuleName |
string |
A fully-qualified path representing project_securityHealthAnalyticsSettings_custom_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the custom_module. |
matchEffectiveCustomModuleFromFolderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(folderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName) → {string}
Parse the effective_custom_module from FolderSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
folderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName |
string |
A fully-qualified path representing folder_securityHealthAnalyticsSettings_effective_custom_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the effective_custom_module. |
matchEffectiveCustomModuleFromOrganizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(organizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName) → {string}
Parse the effective_custom_module from OrganizationSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName |
string |
A fully-qualified path representing organization_securityHealthAnalyticsSettings_effective_custom_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the effective_custom_module. |
matchEffectiveCustomModuleFromProjectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(projectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName) → {string}
Parse the effective_custom_module from ProjectSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
projectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName |
string |
A fully-qualified path representing project_securityHealthAnalyticsSettings_effective_custom_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the effective_custom_module. |
matchExportFromFolderExportName(folderExportName) → {string}
Parse the export from FolderExport resource.
Parameters:
Name | Type | Description |
---|---|---|
folderExportName |
string |
A fully-qualified path representing folder_export resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the export. |
matchExportFromOrganizationExportName(organizationExportName) → {string}
Parse the export from OrganizationExport resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationExportName |
string |
A fully-qualified path representing organization_export resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the export. |
matchExportFromProjectExportName(projectExportName) → {string}
Parse the export from ProjectExport resource.
Parameters:
Name | Type | Description |
---|---|---|
projectExportName |
string |
A fully-qualified path representing project_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. |
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. |
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. |
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. |
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. |
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. |
matchFolderFromFolderAssetName(folderAssetName) → {string}
Parse the folder from FolderAsset resource.
Parameters:
Name | Type | Description |
---|---|---|
folderAssetName |
string |
A fully-qualified path representing folder_asset resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the folder. |
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. |
matchFolderFromFolderEventThreatDetectionSettingsModuleName(folderEventThreatDetectionSettingsModuleName) → {string}
Parse the folder from FolderEventThreatDetectionSettingsModule resource.
Parameters:
Name | Type | Description |
---|---|---|
folderEventThreatDetectionSettingsModuleName |
string |
A fully-qualified path representing folder_eventThreatDetectionSettings_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the folder. |
matchFolderFromFolderExportName(folderExportName) → {string}
Parse the folder from FolderExport resource.
Parameters:
Name | Type | Description |
---|---|---|
folderExportName |
string |
A fully-qualified path representing folder_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. |
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. |
matchFolderFromFolderNotificationConfigName(folderNotificationConfigName) → {string}
Parse the folder from FolderNotificationConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
folderNotificationConfigName |
string |
A fully-qualified path representing folder_notification_config resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the folder. |
matchFolderFromFolderSecurityHealthAnalyticsSettingsCustomModuleName(folderSecurityHealthAnalyticsSettingsCustomModuleName) → {string}
Parse the folder from FolderSecurityHealthAnalyticsSettingsCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
folderSecurityHealthAnalyticsSettingsCustomModuleName |
string |
A fully-qualified path representing folder_securityHealthAnalyticsSettings_custom_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the folder. |
matchFolderFromFolderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(folderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName) → {string}
Parse the folder from FolderSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
folderSecurityHealthAnalyticsSettingsEffectiveCustomModuleName |
string |
A fully-qualified path representing folder_securityHealthAnalyticsSettings_effective_custom_module 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. |
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. |
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. |
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. |
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. |
matchModuleFromFolderEventThreatDetectionSettingsModuleName(folderEventThreatDetectionSettingsModuleName) → {string}
Parse the module from FolderEventThreatDetectionSettingsModule resource.
Parameters:
Name | Type | Description |
---|---|---|
folderEventThreatDetectionSettingsModuleName |
string |
A fully-qualified path representing folder_eventThreatDetectionSettings_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the module. |
matchModuleFromOrganizationEventThreatDetectionSettingsModuleName(organizationEventThreatDetectionSettingsModuleName) → {string}
Parse the module from OrganizationEventThreatDetectionSettingsModule resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationEventThreatDetectionSettingsModuleName |
string |
A fully-qualified path representing organization_eventThreatDetectionSettings_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the module. |
matchModuleFromProjectEventThreatDetectionSettingsModuleName(projectEventThreatDetectionSettingsModuleName) → {string}
Parse the module from ProjectEventThreatDetectionSettingsModule resource.
Parameters:
Name | Type | Description |
---|---|---|
projectEventThreatDetectionSettingsModuleName |
string |
A fully-qualified path representing project_eventThreatDetectionSettings_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the module. |
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. |
matchNotificationConfigFromFolderNotificationConfigName(folderNotificationConfigName) → {string}
Parse the notification_config from FolderNotificationConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
folderNotificationConfigName |
string |
A fully-qualified path representing folder_notification_config resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the notification_config. |
matchNotificationConfigFromOrganizationNotificationConfigName(organizationNotificationConfigName) → {string}
Parse the notification_config from OrganizationNotificationConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationNotificationConfigName |
string |
A fully-qualified path representing organization_notification_config resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the notification_config. |
matchNotificationConfigFromProjectNotificationConfigName(projectNotificationConfigName) → {string}
Parse the notification_config from ProjectNotificationConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
projectNotificationConfigName |
string |
A fully-qualified path representing project_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. |
matchOrganizationFromOrganizationAssetName(organizationAssetName) → {string}
Parse the organization from OrganizationAsset resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationAssetName |
string |
A fully-qualified path representing organization_asset 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. |
matchOrganizationFromOrganizationEventThreatDetectionSettingsModuleName(organizationEventThreatDetectionSettingsModuleName) → {string}
Parse the organization from OrganizationEventThreatDetectionSettingsModule resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationEventThreatDetectionSettingsModuleName |
string |
A fully-qualified path representing organization_eventThreatDetectionSettings_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the organization. |
matchOrganizationFromOrganizationEventThreatDetectionSettingsName(organizationEventThreatDetectionSettingsName) → {string}
Parse the organization from OrganizationEventThreatDetectionSettings resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationEventThreatDetectionSettingsName |
string |
A fully-qualified path representing organization_eventThreatDetectionSettings resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the organization. |
matchOrganizationFromOrganizationExportName(organizationExportName) → {string}
Parse the organization from OrganizationExport resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationExportName |
string |
A fully-qualified path representing organization_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. |
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. |
matchOrganizationFromOrganizationNotificationConfigName(organizationNotificationConfigName) → {string}
Parse the organization from OrganizationNotificationConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationNotificationConfigName |
string |
A fully-qualified path representing organization_notification_config resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the organization. |
matchOrganizationFromOrganizationSecurityHealthAnalyticsSettingsCustomModuleName(organizationSecurityHealthAnalyticsSettingsCustomModuleName) → {string}
Parse the organization from OrganizationSecurityHealthAnalyticsSettingsCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationSecurityHealthAnalyticsSettingsCustomModuleName |
string |
A fully-qualified path representing organization_securityHealthAnalyticsSettings_custom_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the organization. |
matchOrganizationFromOrganizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(organizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName) → {string}
Parse the organization from OrganizationSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationSecurityHealthAnalyticsSettingsEffectiveCustomModuleName |
string |
A fully-qualified path representing organization_securityHealthAnalyticsSettings_effective_custom_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the organization. |
matchOrganizationFromOrganizationSecurityHealthAnalyticsSettingsName(organizationSecurityHealthAnalyticsSettingsName) → {string}
Parse the organization from OrganizationSecurityHealthAnalyticsSettings resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationSecurityHealthAnalyticsSettingsName |
string |
A fully-qualified path representing organization_securityHealthAnalyticsSettings resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the organization. |
matchOrganizationFromOrganizationSettingsName(organizationSettingsName) → {string}
Parse the organization from OrganizationSettings resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationSettingsName |
string |
A fully-qualified path representing OrganizationSettings resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the organization. |
matchOrganizationFromOrganizationSimulationName(organizationSimulationName) → {string}
Parse the organization from OrganizationSimulation resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationSimulationName |
string |
A fully-qualified path representing OrganizationSimulation 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. |
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. |
matchProjectFromProjectAssetName(projectAssetName) → {string}
Parse the project from ProjectAsset resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAssetName |
string |
A fully-qualified path representing project_asset resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
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. |
matchProjectFromProjectEventThreatDetectionSettingsModuleName(projectEventThreatDetectionSettingsModuleName) → {string}
Parse the project from ProjectEventThreatDetectionSettingsModule resource.
Parameters:
Name | Type | Description |
---|---|---|
projectEventThreatDetectionSettingsModuleName |
string |
A fully-qualified path representing project_eventThreatDetectionSettings_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectExportName(projectExportName) → {string}
Parse the project from ProjectExport resource.
Parameters:
Name | Type | Description |
---|---|---|
projectExportName |
string |
A fully-qualified path representing project_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. |
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. |
matchProjectFromProjectNotificationConfigName(projectNotificationConfigName) → {string}
Parse the project from ProjectNotificationConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
projectNotificationConfigName |
string |
A fully-qualified path representing project_notification_config resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectSecurityHealthAnalyticsSettingsCustomModuleName(projectSecurityHealthAnalyticsSettingsCustomModuleName) → {string}
Parse the project from ProjectSecurityHealthAnalyticsSettingsCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
projectSecurityHealthAnalyticsSettingsCustomModuleName |
string |
A fully-qualified path representing project_securityHealthAnalyticsSettings_custom_module resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName(projectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName) → {string}
Parse the project from ProjectSecurityHealthAnalyticsSettingsEffectiveCustomModule resource.
Parameters:
Name | Type | Description |
---|---|---|
projectSecurityHealthAnalyticsSettingsEffectiveCustomModuleName |
string |
A fully-qualified path representing project_securityHealthAnalyticsSettings_effective_custom_module 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. |
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. |
matchSimulationFromOrganizationSimulationName(organizationSimulationName) → {string}
Parse the simulation from OrganizationSimulation resource.
Parameters:
Name | Type | Description |
---|---|---|
organizationSimulationName |
string |
A fully-qualified path representing OrganizationSimulation 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. |
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. |
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. |
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. |
organizationAssetPath(organization, asset) → {string}
Return a fully-qualified organizationAsset resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
string | |
asset |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
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. |
organizationEventThreatDetectionSettingsModulePath(organization, module) → {string}
Return a fully-qualified organizationEventThreatDetectionSettingsModule resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
string | |
module |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
organizationEventThreatDetectionSettingsPath(organization) → {string}
Return a fully-qualified organizationEventThreatDetectionSettings resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
organizationExportPath(organization, exportParam) → {string}
Return a fully-qualified organizationExport resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
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. |
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. |
organizationNotificationConfigPath(organization, notification_config) → {string}
Return a fully-qualified organizationNotificationConfig resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
string | |
notification_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. |
organizationSecurityHealthAnalyticsSettingsCustomModulePath(organization, custom_module) → {string}
Return a fully-qualified organizationSecurityHealthAnalyticsSettingsCustomModule resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
string | |
custom_module |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
organizationSecurityHealthAnalyticsSettingsEffectiveCustomModulePath(organization, effective_custom_module) → {string}
Return a fully-qualified organizationSecurityHealthAnalyticsSettingsEffectiveCustomModule resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
string | |
effective_custom_module |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
organizationSecurityHealthAnalyticsSettingsPath(organization) → {string}
Return a fully-qualified organizationSecurityHealthAnalyticsSettings resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
organizationSettingsPath(organization) → {string}
Return a fully-qualified organizationSettings resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
organizationSimulationPath(organization, simulation) → {string}
Return a fully-qualified organizationSimulation resource name string.
Parameters:
Name | Type | Description |
---|---|---|
organization |
string | |
simulation |
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. |
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. |
projectAssetPath(project, asset) → {string}
Return a fully-qualified projectAsset resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
asset |
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. |
projectEventThreatDetectionSettingsModulePath(project, module) → {string}
Return a fully-qualified projectEventThreatDetectionSettingsModule resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
module |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectExportPath(project, exportParam) → {string}
Return a fully-qualified projectExport resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
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. |
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. |
projectNotificationConfigPath(project, notification_config) → {string}
Return a fully-qualified projectNotificationConfig resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
notification_config |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectSecurityHealthAnalyticsSettingsCustomModulePath(project, custom_module) → {string}
Return a fully-qualified projectSecurityHealthAnalyticsSettingsCustomModule resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
custom_module |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectSecurityHealthAnalyticsSettingsEffectiveCustomModulePath(project, effective_custom_module) → {string}
Return a fully-qualified projectSecurityHealthAnalyticsSettingsEffectiveCustomModule resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
effective_custom_module |
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. |
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. |