Service describing handlers for resources v1
Package
@google-cloud/securitycentermanagementConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of SecurityCenterManagementClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
locationsClient
locationsClient: LocationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
securityCenterManagementStub
securityCenterManagementStub?: Promise<{
[name: string]: Function;
}>;
servicePath
static get servicePath(): string;
The DNS address for this API service.
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createEventThreatDetectionCustomModule(request, options)
createEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.ICreateEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule,
(protos.google.cloud.securitycentermanagement.v1.ICreateEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]>;
Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
Parameters | |
---|---|
Name | Description |
request |
ICreateEventThreatDetectionCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule,
(protos.google.cloud.securitycentermanagement.v1.ICreateEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of parent for the module. Its format is
* "organizations/{organization}/locations/{location}",
* "folders/{folder}/locations/{location}",
* or
* "projects/{project}/locations/{location}"
*/
// const parent = 'abc123'
/**
* Required. The module to create. The
* event_threat_detection_custom_module.name will be ignored and server
* generated.
*/
// const eventThreatDetectionCustomModule = {}
/**
* Optional. When set to true, only validations (including IAM checks) will
* done for the request (no module will be created). An OK response indicates
* the request is valid while an error response indicates the request is
* invalid. Note that a subsequent request to actually create the module could
* still fail because 1. the state could have changed (e.g. IAM permission
* lost) or
* 2. A failure occurred during creation of the module.
*/
// const validateOnly = true
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callCreateEventThreatDetectionCustomModule() {
// Construct request
const request = {
parent,
eventThreatDetectionCustomModule,
};
// Run request
const response = await securitycentermanagementClient.createEventThreatDetectionCustomModule(request);
console.log(response);
}
callCreateEventThreatDetectionCustomModule();
createEventThreatDetectionCustomModule(request, options, callback)
createEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.ICreateEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.ICreateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateEventThreatDetectionCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.ICreateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createEventThreatDetectionCustomModule(request, callback)
createEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.ICreateEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.ICreateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateEventThreatDetectionCustomModuleRequest
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.ICreateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createSecurityHealthAnalyticsCustomModule(request, options)
createSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule,
(protos.google.cloud.securitycentermanagement.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]>;
Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
Parameters | |
---|---|
Name | Description |
request |
ICreateSecurityHealthAnalyticsCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule,
(protos.google.cloud.securitycentermanagement.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* 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 for the module. Its format is
* "organizations/{organization}/locations/{location}",
* "folders/{folder}/locations/{location}",
* or
* "projects/{project}/locations/{location}"
*/
// const parent = 'abc123'
/**
* Required. The resource being created
*/
// const securityHealthAnalyticsCustomModule = {}
/**
* Optional. When set to true, only validations (including IAM checks) will
* done for the request (no module will be created). An OK response indicates
* the request is valid while an error response indicates the request is
* invalid. Note that a subsequent request to actually create the module could
* still fail because:
* 1. the state could have changed (e.g. IAM permission lost) or
* 2. A failure occurred during creation of the module.
* Defaults to false.
*/
// const validateOnly = true
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callCreateSecurityHealthAnalyticsCustomModule() {
// Construct request
const request = {
parent,
securityHealthAnalyticsCustomModule,
};
// Run request
const response = await securitycentermanagementClient.createSecurityHealthAnalyticsCustomModule(request);
console.log(response);
}
callCreateSecurityHealthAnalyticsCustomModule();
createSecurityHealthAnalyticsCustomModule(request, options, callback)
createSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateSecurityHealthAnalyticsCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createSecurityHealthAnalyticsCustomModule(request, callback)
createSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateSecurityHealthAnalyticsCustomModuleRequest
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.ICreateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteEventThreatDetectionCustomModule(request, options)
deleteEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IDeleteEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycentermanagement.v1.IDeleteEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]>;
Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
Parameters | |
---|---|
Name | Description |
request |
IDeleteEventThreatDetectionCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycentermanagement.v1.IDeleteEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the ETD custom module.
* Its format is:
* * "organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".
* * "folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".
* * "projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".
*/
// const name = 'abc123'
/**
* Optional. When set to true, only validations (including IAM checks) will
* done for the request (module will not be deleted). An OK response indicates
* the request is valid while an error response indicates the request is
* invalid. Note that a subsequent request to actually delete the module could
* still fail because 1. the state could have changed (e.g. IAM permission
* lost) or
* 2. A failure occurred while trying to delete the module.
*/
// const validateOnly = true
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callDeleteEventThreatDetectionCustomModule() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycentermanagementClient.deleteEventThreatDetectionCustomModule(request);
console.log(response);
}
callDeleteEventThreatDetectionCustomModule();
deleteEventThreatDetectionCustomModule(request, options, callback)
deleteEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IDeleteEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycentermanagement.v1.IDeleteEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteEventThreatDetectionCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycentermanagement.v1.IDeleteEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteEventThreatDetectionCustomModule(request, callback)
deleteEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IDeleteEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycentermanagement.v1.IDeleteEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteEventThreatDetectionCustomModuleRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycentermanagement.v1.IDeleteEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteSecurityHealthAnalyticsCustomModule(request, options)
deleteSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycentermanagement.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]>;
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
Parameters | |
---|---|
Name | Description |
request |
IDeleteSecurityHealthAnalyticsCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycentermanagement.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the SHA custom module.
* Its format is:
* * "organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
* * "folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
* * "projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
*/
// const name = 'abc123'
/**
* Optional. When set to true, only validations (including IAM checks) will
* done for the request (module will not be deleted). An OK response indicates
* the request is valid while an error response indicates the request is
* invalid. Note that a subsequent request to actually delete the module could
* still fail because 1. the state could have changed (e.g. IAM permission
* lost) or
* 2. A failure occurred while trying to delete the module.
*/
// const validateOnly = true
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callDeleteSecurityHealthAnalyticsCustomModule() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycentermanagementClient.deleteSecurityHealthAnalyticsCustomModule(request);
console.log(response);
}
callDeleteSecurityHealthAnalyticsCustomModule();
deleteSecurityHealthAnalyticsCustomModule(request, options, callback)
deleteSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycentermanagement.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteSecurityHealthAnalyticsCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycentermanagement.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteSecurityHealthAnalyticsCustomModule(request, callback)
deleteSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycentermanagement.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteSecurityHealthAnalyticsCustomModuleRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycentermanagement.v1.IDeleteSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
folderLocationEffectiveEventThreatDetectionCustomModulePath(folder, location, effectiveEventThreatDetectionCustomModule)
folderLocationEffectiveEventThreatDetectionCustomModulePath(folder: string, location: string, effectiveEventThreatDetectionCustomModule: string): string;
Return a fully-qualified folderLocationEffectiveEventThreatDetectionCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
effectiveEventThreatDetectionCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderLocationEffectiveSecurityHealthAnalyticsCustomModulePath(folder, location, effectiveSecurityHealthAnalyticsCustomModule)
folderLocationEffectiveSecurityHealthAnalyticsCustomModulePath(folder: string, location: string, effectiveSecurityHealthAnalyticsCustomModule: string): string;
Return a fully-qualified folderLocationEffectiveSecurityHealthAnalyticsCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
effectiveSecurityHealthAnalyticsCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderLocationEventThreatDetectionCustomModulePath(folder, location, eventThreatDetectionCustomModule)
folderLocationEventThreatDetectionCustomModulePath(folder: string, location: string, eventThreatDetectionCustomModule: string): string;
Return a fully-qualified folderLocationEventThreatDetectionCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
eventThreatDetectionCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderLocationSecurityHealthAnalyticsCustomModulePath(folder, location, securityHealthAnalyticsCustomModule)
folderLocationSecurityHealthAnalyticsCustomModulePath(folder: string, location: string, securityHealthAnalyticsCustomModule: string): string;
Return a fully-qualified folderLocationSecurityHealthAnalyticsCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
securityHealthAnalyticsCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderSourceFindingPath(folder, source, finding)
folderSourceFindingPath(folder: string, source: string, finding: string): string;
Return a fully-qualified folderSourceFinding resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
getEffectiveEventThreatDetectionCustomModule(request, options)
getEffectiveEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]>;
Gets an effective ETD custom module. Retrieves the effective module at the given level. The difference between an EffectiveCustomModule and a CustomModule is that the fields for an EffectiveCustomModule are computed from ancestors if needed. For example, the enablement_state for a CustomModule can be either ENABLED, DISABLED, or INHERITED. Where as the enablement_state for an EffectiveCustomModule is always computed to ENABLED or DISABLED (the effective enablement_state).
Parameters | |
---|---|
Name | Description |
request |
IGetEffectiveEventThreatDetectionCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the ETD custom module.
* Its format is:
* * "organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}".
* * "folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}".
* * "projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}".
*/
// const name = 'abc123'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callGetEffectiveEventThreatDetectionCustomModule() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycentermanagementClient.getEffectiveEventThreatDetectionCustomModule(request);
console.log(response);
}
callGetEffectiveEventThreatDetectionCustomModule();
getEffectiveEventThreatDetectionCustomModule(request, options, callback)
getEffectiveEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetEffectiveEventThreatDetectionCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getEffectiveEventThreatDetectionCustomModule(request, callback)
getEffectiveEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetEffectiveEventThreatDetectionCustomModuleRequest
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEffectiveEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getEffectiveSecurityHealthAnalyticsCustomModule(request, options)
getEffectiveSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]>;
Gets details of a single EffectiveSecurityHealthAnalyticsCustomModule.
Parameters | |
---|---|
Name | Description |
request |
IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the SHA custom module.
* Its format is:
* * "organizations/{organization}/locations/{location}/effectiveSecurityHealthAnalyticsCustomModules/{module_id}".
* * "folders/{folder}/locations/{location}/effectiveSecurityHealthAnalyticsCustomModules/{module_id}".
* * "projects/{project}/locations/{location}/effectiveSecurityHealthAnalyticsCustomModules/{module_id}".
*/
// const name = 'abc123'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callGetEffectiveSecurityHealthAnalyticsCustomModule() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycentermanagementClient.getEffectiveSecurityHealthAnalyticsCustomModule(request);
console.log(response);
}
callGetEffectiveSecurityHealthAnalyticsCustomModule();
getEffectiveSecurityHealthAnalyticsCustomModule(request, options, callback)
getEffectiveSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getEffectiveSecurityHealthAnalyticsCustomModule(request, callback)
getEffectiveSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEffectiveSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getEventThreatDetectionCustomModule(request, options)
getEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IGetEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IGetEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]>;
Gets an Event Threat Detection custom module.
Parameters | |
---|---|
Name | Description |
request |
IGetEventThreatDetectionCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IGetEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the ETD custom module.
* Its format is:
* * "organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".
* * "folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".
* * "projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".
*/
// const name = 'abc123'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callGetEventThreatDetectionCustomModule() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycentermanagementClient.getEventThreatDetectionCustomModule(request);
console.log(response);
}
callGetEventThreatDetectionCustomModule();
getEventThreatDetectionCustomModule(request, options, callback)
getEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IGetEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetEventThreatDetectionCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getEventThreatDetectionCustomModule(request, callback)
getEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IGetEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetEventThreatDetectionCustomModuleRequest
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getLocation(request, options, callback)
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions for more details. |
callback |
Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
Promise<google.cloud.location.ILocation> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
const [response] = await client.getLocation(request);
getProjectId()
getProjectId(): Promise<string>;
Returns | |
---|---|
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter | |
---|---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns | |
---|---|
Type | Description |
void |
getSecurityHealthAnalyticsCustomModule(request, options)
getSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IGetSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]>;
Retrieves a SecurityHealthAnalyticsCustomModule.
Parameters | |
---|---|
Name | Description |
request |
IGetSecurityHealthAnalyticsCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callGetSecurityHealthAnalyticsCustomModule() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycentermanagementClient.getSecurityHealthAnalyticsCustomModule(request);
console.log(response);
}
callGetSecurityHealthAnalyticsCustomModule();
getSecurityHealthAnalyticsCustomModule(request, options, callback)
getSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IGetSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetSecurityHealthAnalyticsCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getSecurityHealthAnalyticsCustomModule(request, callback)
getSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IGetSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetSecurityHealthAnalyticsCustomModuleRequest
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IGetSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns | |
---|---|
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub. |
listDescendantEventThreatDetectionCustomModules(request, options)
listDescendantEventThreatDetectionCustomModules(request?: protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesResponse
]>;
Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
Parameters | |
---|---|
Name | Description |
request |
IListDescendantEventThreatDetectionCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listDescendantEventThreatDetectionCustomModules(request, options, callback)
listDescendantEventThreatDetectionCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListDescendantEventThreatDetectionCustomModulesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>
|
Returns | |
---|---|
Type | Description |
void |
listDescendantEventThreatDetectionCustomModules(request, callback)
listDescendantEventThreatDetectionCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListDescendantEventThreatDetectionCustomModulesRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>
|
Returns | |
---|---|
Type | Description |
void |
listDescendantEventThreatDetectionCustomModulesAsync(request, options)
listDescendantEventThreatDetectionCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>;
Equivalent to listDescendantEventThreatDetectionCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListDescendantEventThreatDetectionCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* 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}/locations/{location}",
* "folders/{folder}/locations/{location}",
* or
* "projects/{project}/locations/{location}"
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of modules to return. The service may return
* fewer than this value. If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* Optional. A token identifying a page of results the server should return.
*/
// const pageToken = 'abc123'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callListDescendantEventThreatDetectionCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycentermanagementClient.listDescendantEventThreatDetectionCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDescendantEventThreatDetectionCustomModules();
listDescendantEventThreatDetectionCustomModulesStream(request, options)
listDescendantEventThreatDetectionCustomModulesStream(request?: protos.google.cloud.securitycentermanagement.v1.IListDescendantEventThreatDetectionCustomModulesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListDescendantEventThreatDetectionCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listDescendantSecurityHealthAnalyticsCustomModules(request, options)
listDescendantSecurityHealthAnalyticsCustomModules(request?: protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse
]>;
Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent's CRM descendants.
Parameters | |
---|---|
Name | Description |
request |
IListDescendantSecurityHealthAnalyticsCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listDescendantSecurityHealthAnalyticsCustomModules(request, options, callback)
listDescendantSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListDescendantSecurityHealthAnalyticsCustomModulesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>
|
Returns | |
---|---|
Type | Description |
void |
listDescendantSecurityHealthAnalyticsCustomModules(request, callback)
listDescendantSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>): void;
Returns | |
---|---|
Type | Description |
void |
listDescendantSecurityHealthAnalyticsCustomModulesAsync(request, options)
listDescendantSecurityHealthAnalyticsCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>;
Equivalent to listDescendantSecurityHealthAnalyticsCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListDescendantSecurityHealthAnalyticsCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* 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}/locations/{location}",
* "folders/{folder}/locations/{location}",
* or
* "projects/{project}/locations/{location}"
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of results to return in a single response.
* Default is 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
/**
* Optional. A token identifying a page of results the server should return.
*/
// const pageToken = 'abc123'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callListDescendantSecurityHealthAnalyticsCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycentermanagementClient.listDescendantSecurityHealthAnalyticsCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDescendantSecurityHealthAnalyticsCustomModules();
listDescendantSecurityHealthAnalyticsCustomModulesStream(request, options)
listDescendantSecurityHealthAnalyticsCustomModulesStream(request?: protos.google.cloud.securitycentermanagement.v1.IListDescendantSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListDescendantSecurityHealthAnalyticsCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listEffectiveEventThreatDetectionCustomModules(request, options)
listEffectiveEventThreatDetectionCustomModules(request?: protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesResponse
]>;
Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
Parameters | |
---|---|
Name | Description |
request |
IListEffectiveEventThreatDetectionCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listEffectiveEventThreatDetectionCustomModules(request, options, callback)
listEffectiveEventThreatDetectionCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListEffectiveEventThreatDetectionCustomModulesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule>
|
Returns | |
---|---|
Type | Description |
void |
listEffectiveEventThreatDetectionCustomModules(request, callback)
listEffectiveEventThreatDetectionCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule>): void;
Returns | |
---|---|
Type | Description |
void |
listEffectiveEventThreatDetectionCustomModulesAsync(request, options)
listEffectiveEventThreatDetectionCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule>;
Equivalent to listEffectiveEventThreatDetectionCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListEffectiveEventThreatDetectionCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* 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}/locations/{location}",
* "folders/{folder}/locations/{location}",
* or
* "projects/{project}/locations/{location}"
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of results to return in a single response.
* Default is 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
/**
* Optional. The value returned by the last call indicating a continuation
*/
// const pageToken = 'abc123'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callListEffectiveEventThreatDetectionCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycentermanagementClient.listEffectiveEventThreatDetectionCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListEffectiveEventThreatDetectionCustomModules();
listEffectiveEventThreatDetectionCustomModulesStream(request, options)
listEffectiveEventThreatDetectionCustomModulesStream(request?: protos.google.cloud.securitycentermanagement.v1.IListEffectiveEventThreatDetectionCustomModulesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListEffectiveEventThreatDetectionCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listEffectiveSecurityHealthAnalyticsCustomModules(request, options)
listEffectiveSecurityHealthAnalyticsCustomModules(request?: protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse
]>;
Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors (no descendants).
Parameters | |
---|---|
Name | Description |
request |
IListEffectiveSecurityHealthAnalyticsCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listEffectiveSecurityHealthAnalyticsCustomModules(request, options, callback)
listEffectiveSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListEffectiveSecurityHealthAnalyticsCustomModulesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule>
|
Returns | |
---|---|
Type | Description |
void |
listEffectiveSecurityHealthAnalyticsCustomModules(request, callback)
listEffectiveSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule>): void;
Returns | |
---|---|
Type | Description |
void |
listEffectiveSecurityHealthAnalyticsCustomModulesAsync(request, options)
listEffectiveSecurityHealthAnalyticsCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule>;
Equivalent to listEffectiveSecurityHealthAnalyticsCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListEffectiveSecurityHealthAnalyticsCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycentermanagement.v1.IEffectiveSecurityHealthAnalyticsCustomModule> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* 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}/locations/{location}",
* "folders/{folder}/locations/{location}",
* or
* "projects/{project}/locations/{location}"
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of results to return in a single response.
* Default is 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
/**
* Optional. The value returned by the last call indicating a continuation.
*/
// const pageToken = 'abc123'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callListEffectiveSecurityHealthAnalyticsCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycentermanagementClient.listEffectiveSecurityHealthAnalyticsCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListEffectiveSecurityHealthAnalyticsCustomModules();
listEffectiveSecurityHealthAnalyticsCustomModulesStream(request, options)
listEffectiveSecurityHealthAnalyticsCustomModulesStream(request?: protos.google.cloud.securitycentermanagement.v1.IListEffectiveSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListEffectiveSecurityHealthAnalyticsCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listEventThreatDetectionCustomModules(request, options)
listEventThreatDetectionCustomModules(request?: protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesResponse
]>;
Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
Parameters | |
---|---|
Name | Description |
request |
IListEventThreatDetectionCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listEventThreatDetectionCustomModules(request, options, callback)
listEventThreatDetectionCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListEventThreatDetectionCustomModulesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>
|
Returns | |
---|---|
Type | Description |
void |
listEventThreatDetectionCustomModules(request, callback)
listEventThreatDetectionCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListEventThreatDetectionCustomModulesRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>
|
Returns | |
---|---|
Type | Description |
void |
listEventThreatDetectionCustomModulesAsync(request, options)
listEventThreatDetectionCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule>;
Equivalent to listEventThreatDetectionCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListEventThreatDetectionCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* 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}/locations/{location}",
* "folders/{folder}/locations/{location}",
* or
* "projects/{project}/locations/{location}"
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of modules to return. The service may return
* fewer than this value. If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* Optional. A 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'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callListEventThreatDetectionCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycentermanagementClient.listEventThreatDetectionCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListEventThreatDetectionCustomModules();
listEventThreatDetectionCustomModulesStream(request, options)
listEventThreatDetectionCustomModulesStream(request?: protos.google.cloud.securitycentermanagement.v1.IListEventThreatDetectionCustomModulesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListEventThreatDetectionCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listLocationsAsync(request, options)
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
Lists information about the supported locations for this service. Returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<google.cloud.location.ILocation> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listSecurityHealthAnalyticsCustomModules(request, options)
listSecurityHealthAnalyticsCustomModules(request?: protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesResponse
]>;
Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors (no descendants).
Parameters | |
---|---|
Name | Description |
request |
IListSecurityHealthAnalyticsCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule[],
protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest | null,
protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listSecurityHealthAnalyticsCustomModules(request, options, callback)
listSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListSecurityHealthAnalyticsCustomModulesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>
|
Returns | |
---|---|
Type | Description |
void |
listSecurityHealthAnalyticsCustomModules(request, callback)
listSecurityHealthAnalyticsCustomModules(request: protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, callback: PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListSecurityHealthAnalyticsCustomModulesRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesResponse | null | undefined, protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>
|
Returns | |
---|---|
Type | Description |
void |
listSecurityHealthAnalyticsCustomModulesAsync(request, options)
listSecurityHealthAnalyticsCustomModulesAsync(request?: protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule>;
Equivalent to listSecurityHealthAnalyticsCustomModules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListSecurityHealthAnalyticsCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* 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}/locations/{location}",
* "folders/{folder}/locations/{location}",
* or
* "projects/{project}/locations/{location}"
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of results to return in a single response.
* Default is 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
/**
* Optional. A token identifying a page of results the server should return.
*/
// const pageToken = 'abc123'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callListSecurityHealthAnalyticsCustomModules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycentermanagementClient.listSecurityHealthAnalyticsCustomModulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListSecurityHealthAnalyticsCustomModules();
listSecurityHealthAnalyticsCustomModulesStream(request, options)
listSecurityHealthAnalyticsCustomModulesStream(request?: protos.google.cloud.securitycentermanagement.v1.IListSecurityHealthAnalyticsCustomModulesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListSecurityHealthAnalyticsCustomModulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
matchEffectiveEventThreatDetectionCustomModuleFromFolderLocationEffectiveEventThreatDetectionCustomModuleName(folderLocationEffectiveEventThreatDetectionCustomModuleName)
matchEffectiveEventThreatDetectionCustomModuleFromFolderLocationEffectiveEventThreatDetectionCustomModuleName(folderLocationEffectiveEventThreatDetectionCustomModuleName: string): string | number;
Parse the effective_event_threat_detection_custom_module from FolderLocationEffectiveEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationEffectiveEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing folder_location_effective_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the effective_event_threat_detection_custom_module. |
matchEffectiveEventThreatDetectionCustomModuleFromOrganizationLocationEffectiveEventThreatDetectionCustomModuleName(organizationLocationEffectiveEventThreatDetectionCustomModuleName)
matchEffectiveEventThreatDetectionCustomModuleFromOrganizationLocationEffectiveEventThreatDetectionCustomModuleName(organizationLocationEffectiveEventThreatDetectionCustomModuleName: string): string | number;
Parse the effective_event_threat_detection_custom_module from OrganizationLocationEffectiveEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationEffectiveEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing organization_location_effective_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the effective_event_threat_detection_custom_module. |
matchEffectiveEventThreatDetectionCustomModuleFromProjectLocationEffectiveEventThreatDetectionCustomModuleName(projectLocationEffectiveEventThreatDetectionCustomModuleName)
matchEffectiveEventThreatDetectionCustomModuleFromProjectLocationEffectiveEventThreatDetectionCustomModuleName(projectLocationEffectiveEventThreatDetectionCustomModuleName: string): string | number;
Parse the effective_event_threat_detection_custom_module from ProjectLocationEffectiveEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationEffectiveEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing project_location_effective_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the effective_event_threat_detection_custom_module. |
matchEffectiveSecurityHealthAnalyticsCustomModuleFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModuleName(folderLocationEffectiveSecurityHealthAnalyticsCustomModuleName)
matchEffectiveSecurityHealthAnalyticsCustomModuleFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModuleName(folderLocationEffectiveSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the effective_security_health_analytics_custom_module from FolderLocationEffectiveSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationEffectiveSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing folder_location_effective_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the effective_security_health_analytics_custom_module. |
matchEffectiveSecurityHealthAnalyticsCustomModuleFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName)
matchEffectiveSecurityHealthAnalyticsCustomModuleFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the effective_security_health_analytics_custom_module from OrganizationLocationEffectiveSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing organization_location_effective_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the effective_security_health_analytics_custom_module. |
matchEffectiveSecurityHealthAnalyticsCustomModuleFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModuleName(projectLocationEffectiveSecurityHealthAnalyticsCustomModuleName)
matchEffectiveSecurityHealthAnalyticsCustomModuleFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModuleName(projectLocationEffectiveSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the effective_security_health_analytics_custom_module from ProjectLocationEffectiveSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationEffectiveSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing project_location_effective_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the effective_security_health_analytics_custom_module. |
matchEventThreatDetectionCustomModuleFromFolderLocationEventThreatDetectionCustomModuleName(folderLocationEventThreatDetectionCustomModuleName)
matchEventThreatDetectionCustomModuleFromFolderLocationEventThreatDetectionCustomModuleName(folderLocationEventThreatDetectionCustomModuleName: string): string | number;
Parse the event_threat_detection_custom_module from FolderLocationEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing folder_location_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the event_threat_detection_custom_module. |
matchEventThreatDetectionCustomModuleFromOrganizationLocationEventThreatDetectionCustomModuleName(organizationLocationEventThreatDetectionCustomModuleName)
matchEventThreatDetectionCustomModuleFromOrganizationLocationEventThreatDetectionCustomModuleName(organizationLocationEventThreatDetectionCustomModuleName: string): string | number;
Parse the event_threat_detection_custom_module from OrganizationLocationEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing organization_location_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the event_threat_detection_custom_module. |
matchEventThreatDetectionCustomModuleFromProjectLocationEventThreatDetectionCustomModuleName(projectLocationEventThreatDetectionCustomModuleName)
matchEventThreatDetectionCustomModuleFromProjectLocationEventThreatDetectionCustomModuleName(projectLocationEventThreatDetectionCustomModuleName: string): string | number;
Parse the event_threat_detection_custom_module from ProjectLocationEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing project_location_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the event_threat_detection_custom_module. |
matchFindingFromFolderSourceFindingName(folderSourceFindingName)
matchFindingFromFolderSourceFindingName(folderSourceFindingName: string): string | number;
Parse the finding from FolderSourceFinding resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingName |
string
A fully-qualified path representing folder_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromOrganizationSourceFindingName(organizationSourceFindingName)
matchFindingFromOrganizationSourceFindingName(organizationSourceFindingName: string): string | number;
Parse the finding from OrganizationSourceFinding resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingName |
string
A fully-qualified path representing organization_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromProjectSourceFindingName(projectSourceFindingName)
matchFindingFromProjectSourceFindingName(projectSourceFindingName: string): string | number;
Parse the finding from ProjectSourceFinding resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingName |
string
A fully-qualified path representing project_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFolderFromFolderLocationEffectiveEventThreatDetectionCustomModuleName(folderLocationEffectiveEventThreatDetectionCustomModuleName)
matchFolderFromFolderLocationEffectiveEventThreatDetectionCustomModuleName(folderLocationEffectiveEventThreatDetectionCustomModuleName: string): string | number;
Parse the folder from FolderLocationEffectiveEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationEffectiveEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing folder_location_effective_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModuleName(folderLocationEffectiveSecurityHealthAnalyticsCustomModuleName)
matchFolderFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModuleName(folderLocationEffectiveSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the folder from FolderLocationEffectiveSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationEffectiveSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing folder_location_effective_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderLocationEventThreatDetectionCustomModuleName(folderLocationEventThreatDetectionCustomModuleName)
matchFolderFromFolderLocationEventThreatDetectionCustomModuleName(folderLocationEventThreatDetectionCustomModuleName: string): string | number;
Parse the folder from FolderLocationEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing folder_location_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderLocationSecurityHealthAnalyticsCustomModuleName(folderLocationSecurityHealthAnalyticsCustomModuleName)
matchFolderFromFolderLocationSecurityHealthAnalyticsCustomModuleName(folderLocationSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the folder from FolderLocationSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing folder_location_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderSourceFindingName(folderSourceFindingName)
matchFolderFromFolderSourceFindingName(folderSourceFindingName: string): string | number;
Parse the folder from FolderSourceFinding resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingName |
string
A fully-qualified path representing folder_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchLocationFromFolderLocationEffectiveEventThreatDetectionCustomModuleName(folderLocationEffectiveEventThreatDetectionCustomModuleName)
matchLocationFromFolderLocationEffectiveEventThreatDetectionCustomModuleName(folderLocationEffectiveEventThreatDetectionCustomModuleName: string): string | number;
Parse the location from FolderLocationEffectiveEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationEffectiveEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing folder_location_effective_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModuleName(folderLocationEffectiveSecurityHealthAnalyticsCustomModuleName)
matchLocationFromFolderLocationEffectiveSecurityHealthAnalyticsCustomModuleName(folderLocationEffectiveSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the location from FolderLocationEffectiveSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationEffectiveSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing folder_location_effective_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromFolderLocationEventThreatDetectionCustomModuleName(folderLocationEventThreatDetectionCustomModuleName)
matchLocationFromFolderLocationEventThreatDetectionCustomModuleName(folderLocationEventThreatDetectionCustomModuleName: string): string | number;
Parse the location from FolderLocationEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing folder_location_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromFolderLocationSecurityHealthAnalyticsCustomModuleName(folderLocationSecurityHealthAnalyticsCustomModuleName)
matchLocationFromFolderLocationSecurityHealthAnalyticsCustomModuleName(folderLocationSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the location from FolderLocationSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing folder_location_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromOrganizationLocationEffectiveEventThreatDetectionCustomModuleName(organizationLocationEffectiveEventThreatDetectionCustomModuleName)
matchLocationFromOrganizationLocationEffectiveEventThreatDetectionCustomModuleName(organizationLocationEffectiveEventThreatDetectionCustomModuleName: string): string | number;
Parse the location from OrganizationLocationEffectiveEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationEffectiveEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing organization_location_effective_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName)
matchLocationFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the location from OrganizationLocationEffectiveSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing organization_location_effective_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromOrganizationLocationEventThreatDetectionCustomModuleName(organizationLocationEventThreatDetectionCustomModuleName)
matchLocationFromOrganizationLocationEventThreatDetectionCustomModuleName(organizationLocationEventThreatDetectionCustomModuleName: string): string | number;
Parse the location from OrganizationLocationEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing organization_location_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromOrganizationLocationName(organizationLocationName)
matchLocationFromOrganizationLocationName(organizationLocationName: string): string | number;
Parse the location from OrganizationLocation resource.
Parameter | |
---|---|
Name | Description |
organizationLocationName |
string
A fully-qualified path representing OrganizationLocation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromOrganizationLocationSecurityHealthAnalyticsCustomModuleName(organizationLocationSecurityHealthAnalyticsCustomModuleName)
matchLocationFromOrganizationLocationSecurityHealthAnalyticsCustomModuleName(organizationLocationSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the location from OrganizationLocationSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing organization_location_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationEffectiveEventThreatDetectionCustomModuleName(projectLocationEffectiveEventThreatDetectionCustomModuleName)
matchLocationFromProjectLocationEffectiveEventThreatDetectionCustomModuleName(projectLocationEffectiveEventThreatDetectionCustomModuleName: string): string | number;
Parse the location from ProjectLocationEffectiveEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationEffectiveEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing project_location_effective_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModuleName(projectLocationEffectiveSecurityHealthAnalyticsCustomModuleName)
matchLocationFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModuleName(projectLocationEffectiveSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the location from ProjectLocationEffectiveSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationEffectiveSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing project_location_effective_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationEventThreatDetectionCustomModuleName(projectLocationEventThreatDetectionCustomModuleName)
matchLocationFromProjectLocationEventThreatDetectionCustomModuleName(projectLocationEventThreatDetectionCustomModuleName: string): string | number;
Parse the location from ProjectLocationEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing project_location_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationSecurityHealthAnalyticsCustomModuleName(projectLocationSecurityHealthAnalyticsCustomModuleName)
matchLocationFromProjectLocationSecurityHealthAnalyticsCustomModuleName(projectLocationSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the location from ProjectLocationSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing project_location_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchOrganizationFromOrganizationLocationEffectiveEventThreatDetectionCustomModuleName(organizationLocationEffectiveEventThreatDetectionCustomModuleName)
matchOrganizationFromOrganizationLocationEffectiveEventThreatDetectionCustomModuleName(organizationLocationEffectiveEventThreatDetectionCustomModuleName: string): string | number;
Parse the organization from OrganizationLocationEffectiveEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationEffectiveEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing organization_location_effective_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName)
matchOrganizationFromOrganizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName(organizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the organization from OrganizationLocationEffectiveSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationEffectiveSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing organization_location_effective_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationLocationEventThreatDetectionCustomModuleName(organizationLocationEventThreatDetectionCustomModuleName)
matchOrganizationFromOrganizationLocationEventThreatDetectionCustomModuleName(organizationLocationEventThreatDetectionCustomModuleName: string): string | number;
Parse the organization from OrganizationLocationEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing organization_location_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationLocationName(organizationLocationName)
matchOrganizationFromOrganizationLocationName(organizationLocationName: string): string | number;
Parse the organization from OrganizationLocation resource.
Parameter | |
---|---|
Name | Description |
organizationLocationName |
string
A fully-qualified path representing OrganizationLocation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationLocationSecurityHealthAnalyticsCustomModuleName(organizationLocationSecurityHealthAnalyticsCustomModuleName)
matchOrganizationFromOrganizationLocationSecurityHealthAnalyticsCustomModuleName(organizationLocationSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the organization from OrganizationLocationSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing organization_location_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationName(organizationName)
matchOrganizationFromOrganizationName(organizationName: string): string | number;
Parse the organization from Organization resource.
Parameter | |
---|---|
Name | Description |
organizationName |
string
A fully-qualified path representing Organization resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationSourceFindingName(organizationSourceFindingName)
matchOrganizationFromOrganizationSourceFindingName(organizationSourceFindingName: string): string | number;
Parse the organization from OrganizationSourceFinding resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingName |
string
A fully-qualified path representing organization_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchProjectFromProjectLocationEffectiveEventThreatDetectionCustomModuleName(projectLocationEffectiveEventThreatDetectionCustomModuleName)
matchProjectFromProjectLocationEffectiveEventThreatDetectionCustomModuleName(projectLocationEffectiveEventThreatDetectionCustomModuleName: string): string | number;
Parse the project from ProjectLocationEffectiveEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationEffectiveEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing project_location_effective_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModuleName(projectLocationEffectiveSecurityHealthAnalyticsCustomModuleName)
matchProjectFromProjectLocationEffectiveSecurityHealthAnalyticsCustomModuleName(projectLocationEffectiveSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the project from ProjectLocationEffectiveSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationEffectiveSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing project_location_effective_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationEventThreatDetectionCustomModuleName(projectLocationEventThreatDetectionCustomModuleName)
matchProjectFromProjectLocationEventThreatDetectionCustomModuleName(projectLocationEventThreatDetectionCustomModuleName: string): string | number;
Parse the project from ProjectLocationEventThreatDetectionCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationEventThreatDetectionCustomModuleName |
string
A fully-qualified path representing project_location_event_threat_detection_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationSecurityHealthAnalyticsCustomModuleName(projectLocationSecurityHealthAnalyticsCustomModuleName)
matchProjectFromProjectLocationSecurityHealthAnalyticsCustomModuleName(projectLocationSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the project from ProjectLocationSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing project_location_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectSourceFindingName(projectSourceFindingName)
matchProjectFromProjectSourceFindingName(projectSourceFindingName: string): string | number;
Parse the project from ProjectSourceFinding resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingName |
string
A fully-qualified path representing project_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchSecurityHealthAnalyticsCustomModuleFromFolderLocationSecurityHealthAnalyticsCustomModuleName(folderLocationSecurityHealthAnalyticsCustomModuleName)
matchSecurityHealthAnalyticsCustomModuleFromFolderLocationSecurityHealthAnalyticsCustomModuleName(folderLocationSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the security_health_analytics_custom_module from FolderLocationSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
folderLocationSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing folder_location_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the security_health_analytics_custom_module. |
matchSecurityHealthAnalyticsCustomModuleFromOrganizationLocationSecurityHealthAnalyticsCustomModuleName(organizationLocationSecurityHealthAnalyticsCustomModuleName)
matchSecurityHealthAnalyticsCustomModuleFromOrganizationLocationSecurityHealthAnalyticsCustomModuleName(organizationLocationSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the security_health_analytics_custom_module from OrganizationLocationSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
organizationLocationSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing organization_location_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the security_health_analytics_custom_module. |
matchSecurityHealthAnalyticsCustomModuleFromProjectLocationSecurityHealthAnalyticsCustomModuleName(projectLocationSecurityHealthAnalyticsCustomModuleName)
matchSecurityHealthAnalyticsCustomModuleFromProjectLocationSecurityHealthAnalyticsCustomModuleName(projectLocationSecurityHealthAnalyticsCustomModuleName: string): string | number;
Parse the security_health_analytics_custom_module from ProjectLocationSecurityHealthAnalyticsCustomModule resource.
Parameter | |
---|---|
Name | Description |
projectLocationSecurityHealthAnalyticsCustomModuleName |
string
A fully-qualified path representing project_location_security_health_analytics_custom_module resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the security_health_analytics_custom_module. |
matchSourceFromFolderSourceFindingName(folderSourceFindingName)
matchSourceFromFolderSourceFindingName(folderSourceFindingName: string): string | number;
Parse the source from FolderSourceFinding resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingName |
string
A fully-qualified path representing folder_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromOrganizationSourceFindingName(organizationSourceFindingName)
matchSourceFromOrganizationSourceFindingName(organizationSourceFindingName: string): string | number;
Parse the source from OrganizationSourceFinding resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingName |
string
A fully-qualified path representing organization_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromProjectSourceFindingName(projectSourceFindingName)
matchSourceFromProjectSourceFindingName(projectSourceFindingName: string): string | number;
Parse the source from ProjectSourceFinding resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingName |
string
A fully-qualified path representing project_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
organizationLocationEffectiveEventThreatDetectionCustomModulePath(organization, location, effectiveEventThreatDetectionCustomModule)
organizationLocationEffectiveEventThreatDetectionCustomModulePath(organization: string, location: string, effectiveEventThreatDetectionCustomModule: string): string;
Return a fully-qualified organizationLocationEffectiveEventThreatDetectionCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
effectiveEventThreatDetectionCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationLocationEffectiveSecurityHealthAnalyticsCustomModulePath(organization, location, effectiveSecurityHealthAnalyticsCustomModule)
organizationLocationEffectiveSecurityHealthAnalyticsCustomModulePath(organization: string, location: string, effectiveSecurityHealthAnalyticsCustomModule: string): string;
Return a fully-qualified organizationLocationEffectiveSecurityHealthAnalyticsCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
effectiveSecurityHealthAnalyticsCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationLocationEventThreatDetectionCustomModulePath(organization, location, eventThreatDetectionCustomModule)
organizationLocationEventThreatDetectionCustomModulePath(organization: string, location: string, eventThreatDetectionCustomModule: string): string;
Return a fully-qualified organizationLocationEventThreatDetectionCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
eventThreatDetectionCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationLocationPath(organization, location)
organizationLocationPath(organization: string, location: string): string;
Return a fully-qualified organizationLocation resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationLocationSecurityHealthAnalyticsCustomModulePath(organization, location, securityHealthAnalyticsCustomModule)
organizationLocationSecurityHealthAnalyticsCustomModulePath(organization: string, location: string, securityHealthAnalyticsCustomModule: string): string;
Return a fully-qualified organizationLocationSecurityHealthAnalyticsCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
securityHealthAnalyticsCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationPath(organization)
organizationPath(organization: string): string;
Return a fully-qualified organization resource name string.
Parameter | |
---|---|
Name | Description |
organization |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationSourceFindingPath(organization, source, finding)
organizationSourceFindingPath(organization: string, source: string, finding: string): string;
Return a fully-qualified organizationSourceFinding resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectLocationEffectiveEventThreatDetectionCustomModulePath(project, location, effectiveEventThreatDetectionCustomModule)
projectLocationEffectiveEventThreatDetectionCustomModulePath(project: string, location: string, effectiveEventThreatDetectionCustomModule: string): string;
Return a fully-qualified projectLocationEffectiveEventThreatDetectionCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
effectiveEventThreatDetectionCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectLocationEffectiveSecurityHealthAnalyticsCustomModulePath(project, location, effectiveSecurityHealthAnalyticsCustomModule)
projectLocationEffectiveSecurityHealthAnalyticsCustomModulePath(project: string, location: string, effectiveSecurityHealthAnalyticsCustomModule: string): string;
Return a fully-qualified projectLocationEffectiveSecurityHealthAnalyticsCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
effectiveSecurityHealthAnalyticsCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectLocationEventThreatDetectionCustomModulePath(project, location, eventThreatDetectionCustomModule)
projectLocationEventThreatDetectionCustomModulePath(project: string, location: string, eventThreatDetectionCustomModule: string): string;
Return a fully-qualified projectLocationEventThreatDetectionCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
eventThreatDetectionCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectLocationSecurityHealthAnalyticsCustomModulePath(project, location, securityHealthAnalyticsCustomModule)
projectLocationSecurityHealthAnalyticsCustomModulePath(project: string, location: string, securityHealthAnalyticsCustomModule: string): string;
Return a fully-qualified projectLocationSecurityHealthAnalyticsCustomModule resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
securityHealthAnalyticsCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectSourceFindingPath(project, source, finding)
projectSourceFindingPath(project: string, source: string, finding: string): string;
Return a fully-qualified projectSourceFinding resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
simulateSecurityHealthAnalyticsCustomModule(request, options)
simulateSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse,
(protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]>;
Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
Parameters | |
---|---|
Name | Description |
request |
ISimulateSecurityHealthAnalyticsCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse,
(protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The relative resource name of the organization, project, or
* folder. For more information about relative resource names, see Relative
* Resource
* Name (https://cloud.google.com/apis/design/resource_names#relative_resource_name)
* Example: `organizations/{organization_id}`.
*/
// const parent = 'abc123'
/**
* Required. The custom configuration that you need to test.
*/
// const customConfig = {}
/**
* Required. Resource data to simulate custom module against.
*/
// const resource = {}
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callSimulateSecurityHealthAnalyticsCustomModule() {
// Construct request
const request = {
parent,
customConfig,
resource,
};
// Run request
const response = await securitycentermanagementClient.simulateSecurityHealthAnalyticsCustomModule(request);
console.log(response);
}
callSimulateSecurityHealthAnalyticsCustomModule();
simulateSecurityHealthAnalyticsCustomModule(request, options, callback)
simulateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISimulateSecurityHealthAnalyticsCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
simulateSecurityHealthAnalyticsCustomModule(request, callback)
simulateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISimulateSecurityHealthAnalyticsCustomModuleRequest
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.ISimulateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateEventThreatDetectionCustomModule(request, options)
updateEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]>;
Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
Parameters | |
---|---|
Name | Description |
request |
IUpdateEventThreatDetectionCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* 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. Field mask is used to specify the fields to be overwritten in the
* EventThreatDetectionCustomModule resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The module being updated
*/
// const eventThreatDetectionCustomModule = {}
/**
* Optional. When set to true, only validations (including IAM checks) will
* done for the request (module will not be updated). An OK response indicates
* the request is valid while an error response indicates the request is
* invalid. Note that a subsequent request to actually update the module could
* still fail because 1. the state could have changed (e.g. IAM permission
* lost) or
* 2. A failure occurred while trying to update the module.
*/
// const validateOnly = true
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callUpdateEventThreatDetectionCustomModule() {
// Construct request
const request = {
updateMask,
eventThreatDetectionCustomModule,
};
// Run request
const response = await securitycentermanagementClient.updateEventThreatDetectionCustomModule(request);
console.log(response);
}
callUpdateEventThreatDetectionCustomModule();
updateEventThreatDetectionCustomModule(request, options, callback)
updateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateEventThreatDetectionCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateEventThreatDetectionCustomModule(request, callback)
updateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateEventThreatDetectionCustomModuleRequest
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IEventThreatDetectionCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateSecurityHealthAnalyticsCustomModule(request, options)
updateSecurityHealthAnalyticsCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]>;
Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
Parameters | |
---|---|
Name | Description |
request |
IUpdateSecurityHealthAnalyticsCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule,
(protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* 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 list of fields to be updated. The only fields that can be
* updated are `enablement_state` and `custom_config`. If empty or set to the
* wildcard value `*`, both `enablement_state` and `custom_config` are
* updated.
*/
// const updateMask = {}
/**
* Required. The resource being updated
*/
// const securityHealthAnalyticsCustomModule = {}
/**
* Optional. When set to true, only validations (including IAM checks) will
* done for the request (module will not be updated). An OK response indicates
* the request is valid while an error response indicates the request is
* invalid. Note that a subsequent request to actually update the module could
* still fail because 1. the state could have changed (e.g. IAM permission
* lost) or
* 2. A failure occurred while trying to update the module.
*/
// const validateOnly = true
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callUpdateSecurityHealthAnalyticsCustomModule() {
// Construct request
const request = {
updateMask,
securityHealthAnalyticsCustomModule,
};
// Run request
const response = await securitycentermanagementClient.updateSecurityHealthAnalyticsCustomModule(request);
console.log(response);
}
callUpdateSecurityHealthAnalyticsCustomModule();
updateSecurityHealthAnalyticsCustomModule(request, options, callback)
updateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateSecurityHealthAnalyticsCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateSecurityHealthAnalyticsCustomModule(request, callback)
updateSecurityHealthAnalyticsCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateSecurityHealthAnalyticsCustomModuleRequest
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule, protos.google.cloud.securitycentermanagement.v1.IUpdateSecurityHealthAnalyticsCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
validateEventThreatDetectionCustomModule(request, options)
validateEventThreatDetectionCustomModule(request?: protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse,
(protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]>;
Validates the given Event Threat Detection custom module.
Parameters | |
---|---|
Name | Description |
request |
IValidateEventThreatDetectionCustomModuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse,
(protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the parent to validate the Custom Module under.
* Its format is:
* * "organizations/{organization}/locations/{location}".
*/
// const parent = 'abc123'
/**
* Required. The raw text of the module's contents. Used to generate error
* messages.
*/
// const rawText = 'abc123'
/**
* Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
*/
// const type = 'abc123'
// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} = require('@google-cloud/securitycentermanagement').v1;
// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();
async function callValidateEventThreatDetectionCustomModule() {
// Construct request
const request = {
parent,
rawText,
type,
};
// Run request
const response = await securitycentermanagementClient.validateEventThreatDetectionCustomModule(request);
console.log(response);
}
callValidateEventThreatDetectionCustomModule();
validateEventThreatDetectionCustomModule(request, options, callback)
validateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IValidateEventThreatDetectionCustomModuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
validateEventThreatDetectionCustomModule(request, callback)
validateEventThreatDetectionCustomModule(request: protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest, callback: Callback<protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IValidateEventThreatDetectionCustomModuleRequest
|
callback |
Callback<protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleResponse, protos.google.cloud.securitycentermanagement.v1.IValidateEventThreatDetectionCustomModuleRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |