V2 APIs for Security Center service. v2
Package
@google-cloud/security-centerConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of SecurityCenterClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
securityCenterStub
securityCenterStub?: Promise<{
[name: string]: Function;
}>;
servicePath
static get servicePath(): string;
The DNS address for this API service.
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
attackPathPath(organization, simulation, valuedResource, attackPath)
attackPathPath(organization: string, simulation: string, valuedResource: string, attackPath: string): string;
Return a fully-qualified attackPath resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
simulation |
string
|
valuedResource |
string
|
attackPath |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
batchCreateResourceValueConfigs(request, options)
batchCreateResourceValueConfigs(request?: protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsResponse,
(protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsRequest | undefined),
{} | undefined
]>;
Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation.
Parameters | |
---|---|
Name | Description |
request |
IBatchCreateResourceValueConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsResponse,
(protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing BatchCreateResourceValueConfigsResponse. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the new ResourceValueConfig's parent.
* The parent field in the CreateResourceValueConfigRequest
* messages must either be empty or match this field.
*/
// const parent = 'abc123'
/**
* Required. The resource value configs to be created.
*/
// const requests = [1,2,3,4]
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callBatchCreateResourceValueConfigs() {
// Construct request
const request = {
parent,
requests,
};
// Run request
const response = await securitycenterClient.batchCreateResourceValueConfigs(request);
console.log(response);
}
callBatchCreateResourceValueConfigs();
batchCreateResourceValueConfigs(request, options, callback)
batchCreateResourceValueConfigs(request: protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsResponse, protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IBatchCreateResourceValueConfigsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsResponse, protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
batchCreateResourceValueConfigs(request, callback)
batchCreateResourceValueConfigs(request: protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsResponse, protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IBatchCreateResourceValueConfigsRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsResponse, protos.google.cloud.securitycenter.v2.IBatchCreateResourceValueConfigsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
bulkMuteFindings(request, options)
bulkMuteFindings(request?: protos.google.cloud.securitycenter.v2.IBulkMuteFindingsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.securitycenter.v2.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Kicks off an LRO to bulk mute findings for a parent based on a filter. If no location is specified, findings are muted in global. The parent can be either an organization, folder, or project. The findings matched by the filter will be muted after the LRO is done.
Parameters | |
---|---|
Name | Description |
request |
IBulkMuteFindingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.securitycenter.v2.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent, at which bulk action needs to be applied. If no
* location is specified, findings are updated in global. The following list
* shows some examples:
* + `organizations/[organization_id]`
* + `organizations/[organization_id]/locations/[location_id]`
* + `folders/[folder_id]`
* + `folders/[folder_id]/locations/[location_id]`
* + `projects/[project_id]`
* + `projects/[project_id]/locations/[location_id]`
*/
// const parent = 'abc123'
/**
* Expression that identifies findings that should be updated.
* The expression is a list of zero or more restrictions combined
* via logical operators `AND` and `OR`. Parentheses are supported, and `OR`
* has higher precedence than `AND`.
* Restrictions have the form `
bulkMuteFindings(request, options, callback)
bulkMuteFindings(request: protos.google.cloud.securitycenter.v2.IBulkMuteFindingsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.securitycenter.v2.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IBulkMuteFindingsRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.securitycenter.v2.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
bulkMuteFindings(request, callback)
bulkMuteFindings(request: protos.google.cloud.securitycenter.v2.IBulkMuteFindingsRequest, callback: Callback<LROperation<protos.google.cloud.securitycenter.v2.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IBulkMuteFindingsRequest
|
callback |
Callback<LROperation<protos.google.cloud.securitycenter.v2.IBulkMuteFindingsResponse, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkBulkMuteFindingsProgress(name)
checkBulkMuteFindingsProgress(name: string): Promise<LROperation<protos.google.cloud.securitycenter.v2.BulkMuteFindingsResponse, protos.google.protobuf.Empty>>;
Check the status of the long running operation returned by bulkMuteFindings()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.securitycenter.v2.BulkMuteFindingsResponse, protos.google.protobuf.Empty>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent, at which bulk action needs to be applied. If no
* location is specified, findings are updated in global. The following list
* shows some examples:
* + `organizations/[organization_id]`
* + `organizations/[organization_id]/locations/[location_id]`
* + `folders/[folder_id]`
* + `folders/[folder_id]/locations/[location_id]`
* + `projects/[project_id]`
* + `projects/[project_id]/locations/[location_id]`
*/
// const parent = 'abc123'
/**
* Expression that identifies findings that should be updated.
* The expression is a list of zero or more restrictions combined
* via logical operators `AND` and `OR`. Parentheses are supported, and `OR`
* has higher precedence than `AND`.
* Restrictions have the form `
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createBigQueryExport(request, options)
createBigQueryExport(request?: protos.google.cloud.securitycenter.v2.ICreateBigQueryExportRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IBigQueryExport,
(protos.google.cloud.securitycenter.v2.ICreateBigQueryExportRequest | undefined),
{} | undefined
]>;
Creates a BigQuery export.
Parameters | |
---|---|
Name | Description |
request |
ICreateBigQueryExportRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IBigQueryExport,
(protos.google.cloud.securitycenter.v2.ICreateBigQueryExportRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing BigQueryExport. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource of the new BigQuery export. Its
* format is "organizations/[organization_id]/locations/[location_id]",
* "folders/[folder_id]/locations/[location_id]", or
* "projects/[project_id]/locations/[location_id]".
*/
// const parent = 'abc123'
/**
* Required. The BigQuery export being created.
*/
// const bigQueryExport = {}
/**
* Required. Unique identifier provided by the client within the parent scope.
* It must consist of only lowercase letters, numbers, and hyphens, must start
* with a letter, must end with either a letter or a number, and must be 63
* characters or less.
*/
// const bigQueryExportId = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callCreateBigQueryExport() {
// Construct request
const request = {
parent,
bigQueryExport,
bigQueryExportId,
};
// Run request
const response = await securitycenterClient.createBigQueryExport(request);
console.log(response);
}
callCreateBigQueryExport();
createBigQueryExport(request, options, callback)
createBigQueryExport(request: protos.google.cloud.securitycenter.v2.ICreateBigQueryExportRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.ICreateBigQueryExportRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateBigQueryExportRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.ICreateBigQueryExportRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createBigQueryExport(request, callback)
createBigQueryExport(request: protos.google.cloud.securitycenter.v2.ICreateBigQueryExportRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.ICreateBigQueryExportRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateBigQueryExportRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.ICreateBigQueryExportRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createFinding(request, options)
createFinding(request?: protos.google.cloud.securitycenter.v2.ICreateFindingRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IFinding,
protos.google.cloud.securitycenter.v2.ICreateFindingRequest | undefined,
{} | undefined
]>;
Creates a finding in a location. The corresponding source must exist for finding creation to succeed.
Parameters | |
---|---|
Name | Description |
request |
ICreateFindingRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IFinding,
protos.google.cloud.securitycenter.v2.ICreateFindingRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the new finding's parent. The following list
* shows some examples of the format:
* +
* `organizations/[organization_id]/sources/[source_id]`
* +
* `organizations/[organization_id]/sources/[source_id]/locations/[location_id]`
*/
// const parent = 'abc123'
/**
* Required. Unique identifier provided by the client within the parent scope.
* It must be alphanumeric and less than or equal to 32 characters and
* greater than 0 characters in length.
*/
// const findingId = 'abc123'
/**
* Required. The Finding being created. The name and security_marks will be
* ignored as they are both output only fields on this resource.
*/
// const finding = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callCreateFinding() {
// Construct request
const request = {
parent,
findingId,
finding,
};
// Run request
const response = await securitycenterClient.createFinding(request);
console.log(response);
}
callCreateFinding();
createFinding(request, options, callback)
createFinding(request: protos.google.cloud.securitycenter.v2.ICreateFindingRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ICreateFindingRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateFindingRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ICreateFindingRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createFinding(request, callback)
createFinding(request: protos.google.cloud.securitycenter.v2.ICreateFindingRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ICreateFindingRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateFindingRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ICreateFindingRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createMuteConfig(request, options)
createMuteConfig(request?: protos.google.cloud.securitycenter.v2.ICreateMuteConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IMuteConfig,
(protos.google.cloud.securitycenter.v2.ICreateMuteConfigRequest | undefined),
{} | undefined
]>;
Creates a mute config.
Parameters | |
---|---|
Name | Description |
request |
ICreateMuteConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IMuteConfig,
(protos.google.cloud.securitycenter.v2.ICreateMuteConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the new mute configs's parent. Its format is
* "organizations/[organization_id]/locations/[location_id]",
* "folders/[folder_id]/locations/[location_id]", or
* "projects/[project_id]/locations/[location_id]".
*/
// const parent = 'abc123'
/**
* Required. The mute config being created.
*/
// const muteConfig = {}
/**
* Required. Unique identifier provided by the client within the parent scope.
* It must consist of only lowercase letters, numbers, and hyphens, must start
* with a letter, must end with either a letter or a number, and must be 63
* characters or less.
*/
// const muteConfigId = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callCreateMuteConfig() {
// Construct request
const request = {
parent,
muteConfig,
muteConfigId,
};
// Run request
const response = await securitycenterClient.createMuteConfig(request);
console.log(response);
}
callCreateMuteConfig();
createMuteConfig(request, options, callback)
createMuteConfig(request: protos.google.cloud.securitycenter.v2.ICreateMuteConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.ICreateMuteConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateMuteConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.ICreateMuteConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createMuteConfig(request, callback)
createMuteConfig(request: protos.google.cloud.securitycenter.v2.ICreateMuteConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.ICreateMuteConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateMuteConfigRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.ICreateMuteConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createNotificationConfig(request, options)
createNotificationConfig(request?: protos.google.cloud.securitycenter.v2.ICreateNotificationConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.INotificationConfig,
(protos.google.cloud.securitycenter.v2.ICreateNotificationConfigRequest | undefined),
{} | undefined
]>;
Creates a notification config.
Parameters | |
---|---|
Name | Description |
request |
ICreateNotificationConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.INotificationConfig,
(protos.google.cloud.securitycenter.v2.ICreateNotificationConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the new notification config's parent. Its format
* is "organizations/[organization_id]/locations/[location_id]",
* "folders/[folder_id]/locations/[location_id]", or
* "projects/[project_id]/locations/[location_id]".
*/
// const parent = 'abc123'
/**
* Required.
* Unique identifier provided by the client within the parent scope.
* It must be between 1 and 128 characters and contain alphanumeric
* characters, underscores, or hyphens only.
*/
// const configId = 'abc123'
/**
* Required. The notification config being created. The name and the service
* account will be ignored as they are both output only fields on this
* resource.
*/
// const notificationConfig = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callCreateNotificationConfig() {
// Construct request
const request = {
parent,
configId,
notificationConfig,
};
// Run request
const response = await securitycenterClient.createNotificationConfig(request);
console.log(response);
}
callCreateNotificationConfig();
createNotificationConfig(request, options, callback)
createNotificationConfig(request: protos.google.cloud.securitycenter.v2.ICreateNotificationConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.ICreateNotificationConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateNotificationConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.ICreateNotificationConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createNotificationConfig(request, callback)
createNotificationConfig(request: protos.google.cloud.securitycenter.v2.ICreateNotificationConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.ICreateNotificationConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateNotificationConfigRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.ICreateNotificationConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createSource(request, options)
createSource(request?: protos.google.cloud.securitycenter.v2.ICreateSourceRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.ISource,
protos.google.cloud.securitycenter.v2.ICreateSourceRequest | undefined,
{} | undefined
]>;
Creates a source.
Parameters | |
---|---|
Name | Description |
request |
ICreateSourceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.ISource,
protos.google.cloud.securitycenter.v2.ICreateSourceRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Source. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the new source's parent. Its format should be
* "organizations/[organization_id]".
*/
// const parent = 'abc123'
/**
* Required. The Source being created, only the display_name and description
* will be used. All other fields will be ignored.
*/
// const source = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callCreateSource() {
// Construct request
const request = {
parent,
source,
};
// Run request
const response = await securitycenterClient.createSource(request);
console.log(response);
}
callCreateSource();
createSource(request, options, callback)
createSource(request: protos.google.cloud.securitycenter.v2.ICreateSourceRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.ICreateSourceRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateSourceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.ICreateSourceRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createSource(request, callback)
createSource(request: protos.google.cloud.securitycenter.v2.ICreateSourceRequest, callback: Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.ICreateSourceRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateSourceRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.ICreateSourceRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteBigQueryExport(request, options)
deleteBigQueryExport(request?: protos.google.cloud.securitycenter.v2.IDeleteBigQueryExportRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycenter.v2.IDeleteBigQueryExportRequest | undefined),
{} | undefined
]>;
Deletes an existing BigQuery export.
Parameters | |
---|---|
Name | Description |
request |
IDeleteBigQueryExportRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycenter.v2.IDeleteBigQueryExportRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the BigQuery export to delete. The following list
* shows some examples of the format:
* +
* `organizations/{organization}/locations/{location}/bigQueryExports/{export_id}`
* + `folders/{folder}/locations/{location}/bigQueryExports/{export_id}`
* + `projects/{project}/locations/{location}/bigQueryExports/{export_id}`
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callDeleteBigQueryExport() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.deleteBigQueryExport(request);
console.log(response);
}
callDeleteBigQueryExport();
deleteBigQueryExport(request, options, callback)
deleteBigQueryExport(request: protos.google.cloud.securitycenter.v2.IDeleteBigQueryExportRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteBigQueryExportRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteBigQueryExportRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteBigQueryExportRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteBigQueryExport(request, callback)
deleteBigQueryExport(request: protos.google.cloud.securitycenter.v2.IDeleteBigQueryExportRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteBigQueryExportRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteBigQueryExportRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteBigQueryExportRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteMuteConfig(request, options)
deleteMuteConfig(request?: protos.google.cloud.securitycenter.v2.IDeleteMuteConfigRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycenter.v2.IDeleteMuteConfigRequest | undefined),
{} | undefined
]>;
Deletes an existing mute config. If no location is specified, default is global.
Parameters | |
---|---|
Name | Description |
request |
IDeleteMuteConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycenter.v2.IDeleteMuteConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the mute config to delete. The following list shows some
* examples of the format:
* + `organizations/{organization}/muteConfigs/{config_id}`
* +
* `organizations/{organization}/locations/{location}/muteConfigs/{config_id}`
* + `folders/{folder}/muteConfigs/{config_id}`
* + `folders/{folder}/locations/{location}/muteConfigs/{config_id}`
* + `projects/{project}/muteConfigs/{config_id}`
* + `projects/{project}/locations/{location}/muteConfigs/{config_id}`
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callDeleteMuteConfig() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.deleteMuteConfig(request);
console.log(response);
}
callDeleteMuteConfig();
deleteMuteConfig(request, options, callback)
deleteMuteConfig(request: protos.google.cloud.securitycenter.v2.IDeleteMuteConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteMuteConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteMuteConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteMuteConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteMuteConfig(request, callback)
deleteMuteConfig(request: protos.google.cloud.securitycenter.v2.IDeleteMuteConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteMuteConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteMuteConfigRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteMuteConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteNotificationConfig(request, options)
deleteNotificationConfig(request?: protos.google.cloud.securitycenter.v2.IDeleteNotificationConfigRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycenter.v2.IDeleteNotificationConfigRequest | undefined),
{} | undefined
]>;
Deletes a notification config.
Parameters | |
---|---|
Name | Description |
request |
IDeleteNotificationConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycenter.v2.IDeleteNotificationConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the notification config to delete. The following list
* shows some examples of the format:
* +
* `organizations/[organization_id]/locations/[location_id]/notificationConfigs/[config_id]`
* +
* `folders/[folder_id]/locations/[location_id]notificationConfigs/[config_id]`
* +
* `projects/[project_id]/locations/[location_id]notificationConfigs/[config_id]`
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callDeleteNotificationConfig() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.deleteNotificationConfig(request);
console.log(response);
}
callDeleteNotificationConfig();
deleteNotificationConfig(request, options, callback)
deleteNotificationConfig(request: protos.google.cloud.securitycenter.v2.IDeleteNotificationConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteNotificationConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteNotificationConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteNotificationConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteNotificationConfig(request, callback)
deleteNotificationConfig(request: protos.google.cloud.securitycenter.v2.IDeleteNotificationConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteNotificationConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteNotificationConfigRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteNotificationConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteOperation(request, options, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
deleteResourceValueConfig(request, options)
deleteResourceValueConfig(request?: protos.google.cloud.securitycenter.v2.IDeleteResourceValueConfigRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycenter.v2.IDeleteResourceValueConfigRequest | undefined),
{} | undefined
]>;
Deletes a ResourceValueConfig.
Parameters | |
---|---|
Name | Description |
request |
IDeleteResourceValueConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.securitycenter.v2.IDeleteResourceValueConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the ResourceValueConfig to delete
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callDeleteResourceValueConfig() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.deleteResourceValueConfig(request);
console.log(response);
}
callDeleteResourceValueConfig();
deleteResourceValueConfig(request, options, callback)
deleteResourceValueConfig(request: protos.google.cloud.securitycenter.v2.IDeleteResourceValueConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteResourceValueConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteResourceValueConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteResourceValueConfig(request, callback)
deleteResourceValueConfig(request: protos.google.cloud.securitycenter.v2.IDeleteResourceValueConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteResourceValueConfigRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.securitycenter.v2.IDeleteResourceValueConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
folderAssetSecurityMarksPath(folder, asset)
folderAssetSecurityMarksPath(folder: string, asset: string): string;
Return a fully-qualified folderAssetSecurityMarks resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
asset |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderConstraintNamePath(folder, constraintName)
folderConstraintNamePath(folder: string, constraintName: string): string;
Return a fully-qualified folderConstraintName resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
constraintName |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderLocationExportPath(folder, location, exportParam)
folderLocationExportPath(folder: string, location: string, exportParam: string): string;
Return a fully-qualified folderLocationExport resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
exportParam |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderLocationMuteConfigPath(folder, location, muteConfig)
folderLocationMuteConfigPath(folder: string, location: string, muteConfig: string): string;
Return a fully-qualified folderLocationMuteConfig resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
muteConfig |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderLocationNotificationConfigPath(folder, location, notificationConfig)
folderLocationNotificationConfigPath(folder: string, location: string, notificationConfig: string): string;
Return a fully-qualified folderLocationNotificationConfig resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
location |
string
|
notificationConfig |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderMuteConfigPath(folder, muteConfig)
folderMuteConfigPath(folder: string, muteConfig: string): string;
Return a fully-qualified folderMuteConfig resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
muteConfig |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderSourceFindingExternalsystemPath(folder, source, finding, externalsystem)
folderSourceFindingExternalsystemPath(folder: string, source: string, finding: string, externalsystem: string): string;
Return a fully-qualified folderSourceFindingExternalsystem resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
finding |
string
|
externalsystem |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderSourceFindingPath(folder, source, finding)
folderSourceFindingPath(folder: string, source: string, finding: string): string;
Return a fully-qualified folderSourceFinding resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderSourceFindingSecurityMarksPath(folder, source, finding)
folderSourceFindingSecurityMarksPath(folder: string, source: string, finding: string): string;
Return a fully-qualified folderSourceFindingSecurityMarks resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderSourceLocationFindingExternalsystemPath(folder, source, location, finding, externalsystem)
folderSourceLocationFindingExternalsystemPath(folder: string, source: string, location: string, finding: string, externalsystem: string): string;
Return a fully-qualified folderSourceLocationFindingExternalsystem resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
location |
string
|
finding |
string
|
externalsystem |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderSourceLocationFindingPath(folder, source, location, finding)
folderSourceLocationFindingPath(folder: string, source: string, location: string, finding: string): string;
Return a fully-qualified folderSourceLocationFinding resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
location |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderSourceLocationFindingSecurityMarksPath(folder, source, location, finding)
folderSourceLocationFindingSecurityMarksPath(folder: string, source: string, location: string, finding: string): string;
Return a fully-qualified folderSourceLocationFindingSecurityMarks resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
location |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
folderSourcePath(folder, source)
folderSourcePath(folder: string, source: string): string;
Return a fully-qualified folderSource resource name string.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
getBigQueryExport(request, options)
getBigQueryExport(request?: protos.google.cloud.securitycenter.v2.IGetBigQueryExportRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IBigQueryExport,
(protos.google.cloud.securitycenter.v2.IGetBigQueryExportRequest | undefined),
{} | undefined
]>;
Gets a BigQuery export.
Parameters | |
---|---|
Name | Description |
request |
IGetBigQueryExportRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IBigQueryExport,
(protos.google.cloud.securitycenter.v2.IGetBigQueryExportRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing BigQueryExport. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the BigQuery export to retrieve. The following list shows
* some examples of the format:
* +
* `organizations/{organization}/locations/{location}/bigQueryExports/{export_id}`
* + `folders/{folder}/locations/{location}/bigQueryExports/{export_id}`
* + `projects/{project}locations/{location}//bigQueryExports/{export_id}`
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callGetBigQueryExport() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.getBigQueryExport(request);
console.log(response);
}
callGetBigQueryExport();
getBigQueryExport(request, options, callback)
getBigQueryExport(request: protos.google.cloud.securitycenter.v2.IGetBigQueryExportRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.IGetBigQueryExportRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetBigQueryExportRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.IGetBigQueryExportRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getBigQueryExport(request, callback)
getBigQueryExport(request: protos.google.cloud.securitycenter.v2.IGetBigQueryExportRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.IGetBigQueryExportRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetBigQueryExportRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.IGetBigQueryExportRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getIamPolicy(request, options)
getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.IGetIamPolicyRequest | undefined,
{} | undefined
]>;
Gets the access control policy on the specified Source.
Parameters | |
---|---|
Name | Description |
request |
IGetIamPolicyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.IGetIamPolicyRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to
* `GetIamPolicy`.
*/
// const options = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callGetIamPolicy() {
// Construct request
const request = {
resource,
};
// Run request
const response = await securitycenterClient.getIamPolicy(request);
console.log(response);
}
callGetIamPolicy();
getIamPolicy(request, options, callback)
getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetIamPolicyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getIamPolicy(request, callback)
getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetIamPolicyRequest
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getMuteConfig(request, options)
getMuteConfig(request?: protos.google.cloud.securitycenter.v2.IGetMuteConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IMuteConfig,
protos.google.cloud.securitycenter.v2.IGetMuteConfigRequest | undefined,
{} | undefined
]>;
Gets a mute config. If no location is specified, default is global.
Parameters | |
---|---|
Name | Description |
request |
IGetMuteConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IMuteConfig,
protos.google.cloud.securitycenter.v2.IGetMuteConfigRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the mute config to retrieve. The following list shows
* some examples of the format:
* + `organizations/{organization}/muteConfigs/{config_id}`
* +
* `organizations/{organization}/locations/{location}/muteConfigs/{config_id}`
* + `folders/{folder}/muteConfigs/{config_id}`
* + `folders/{folder}/locations/{location}/muteConfigs/{config_id}`
* + `projects/{project}/muteConfigs/{config_id}`
* + `projects/{project}/locations/{location}/muteConfigs/{config_id}`
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callGetMuteConfig() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.getMuteConfig(request);
console.log(response);
}
callGetMuteConfig();
getMuteConfig(request, options, callback)
getMuteConfig(request: protos.google.cloud.securitycenter.v2.IGetMuteConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.IGetMuteConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetMuteConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.IGetMuteConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getMuteConfig(request, callback)
getMuteConfig(request: protos.google.cloud.securitycenter.v2.IGetMuteConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.IGetMuteConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetMuteConfigRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.IGetMuteConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getNotificationConfig(request, options)
getNotificationConfig(request?: protos.google.cloud.securitycenter.v2.IGetNotificationConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.INotificationConfig,
(protos.google.cloud.securitycenter.v2.IGetNotificationConfigRequest | undefined),
{} | undefined
]>;
Gets a notification config.
Parameters | |
---|---|
Name | Description |
request |
IGetNotificationConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.INotificationConfig,
(protos.google.cloud.securitycenter.v2.IGetNotificationConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the notification config to get. The following list shows
* some examples of the format:
* +
* `organizations/[organization_id]/locations/[location_id]/notificationConfigs/[config_id]`
* +
* `folders/[folder_id]/locations/[location_id]/notificationConfigs/[config_id]`
* +
* `projects/[project_id]/locations/[location_id]/notificationConfigs/[config_id]`
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callGetNotificationConfig() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.getNotificationConfig(request);
console.log(response);
}
callGetNotificationConfig();
getNotificationConfig(request, options, callback)
getNotificationConfig(request: protos.google.cloud.securitycenter.v2.IGetNotificationConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.IGetNotificationConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetNotificationConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.IGetNotificationConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getNotificationConfig(request, callback)
getNotificationConfig(request: protos.google.cloud.securitycenter.v2.IGetNotificationConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.IGetNotificationConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetNotificationConfigRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.IGetNotificationConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getOperation(request, options, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
GetOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<[protos.google.longrunning.Operation]> |
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
getProjectId()
getProjectId(): Promise<string>;
Returns | |
---|---|
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter | |
---|---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns | |
---|---|
Type | Description |
void |
getResourceValueConfig(request, options)
getResourceValueConfig(request?: protos.google.cloud.securitycenter.v2.IGetResourceValueConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IResourceValueConfig,
(protos.google.cloud.securitycenter.v2.IGetResourceValueConfigRequest | undefined),
{} | undefined
]>;
Gets a ResourceValueConfig.
Parameters | |
---|---|
Name | Description |
request |
IGetResourceValueConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IResourceValueConfig,
(protos.google.cloud.securitycenter.v2.IGetResourceValueConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource value config to retrieve. Its format is
* organizations/{organization}/resourceValueConfigs/{config_id}.
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callGetResourceValueConfig() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.getResourceValueConfig(request);
console.log(response);
}
callGetResourceValueConfig();
getResourceValueConfig(request, options, callback)
getResourceValueConfig(request: protos.google.cloud.securitycenter.v2.IGetResourceValueConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IResourceValueConfig, protos.google.cloud.securitycenter.v2.IGetResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetResourceValueConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IResourceValueConfig, protos.google.cloud.securitycenter.v2.IGetResourceValueConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getResourceValueConfig(request, callback)
getResourceValueConfig(request: protos.google.cloud.securitycenter.v2.IGetResourceValueConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IResourceValueConfig, protos.google.cloud.securitycenter.v2.IGetResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetResourceValueConfigRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IResourceValueConfig, protos.google.cloud.securitycenter.v2.IGetResourceValueConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getSimulation(request, options)
getSimulation(request?: protos.google.cloud.securitycenter.v2.IGetSimulationRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.ISimulation,
protos.google.cloud.securitycenter.v2.IGetSimulationRequest | undefined,
{} | undefined
]>;
Get the simulation by name or the latest simulation for the given organization.
Parameters | |
---|---|
Name | Description |
request |
IGetSimulationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.ISimulation,
protos.google.cloud.securitycenter.v2.IGetSimulationRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Simulation. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The organization name or simulation name of this simulation
* Valid format:
* "organizations/{organization}/simulations/latest"
* "organizations/{organization}/simulations/{simulation}"
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callGetSimulation() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.getSimulation(request);
console.log(response);
}
callGetSimulation();
getSimulation(request, options, callback)
getSimulation(request: protos.google.cloud.securitycenter.v2.IGetSimulationRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.ISimulation, protos.google.cloud.securitycenter.v2.IGetSimulationRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetSimulationRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.ISimulation, protos.google.cloud.securitycenter.v2.IGetSimulationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getSimulation(request, callback)
getSimulation(request: protos.google.cloud.securitycenter.v2.IGetSimulationRequest, callback: Callback<protos.google.cloud.securitycenter.v2.ISimulation, protos.google.cloud.securitycenter.v2.IGetSimulationRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetSimulationRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.ISimulation, protos.google.cloud.securitycenter.v2.IGetSimulationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getSource(request, options)
getSource(request?: protos.google.cloud.securitycenter.v2.IGetSourceRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.ISource,
protos.google.cloud.securitycenter.v2.IGetSourceRequest | undefined,
{} | undefined
]>;
Gets a source.
Parameters | |
---|---|
Name | Description |
request |
IGetSourceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.ISource,
protos.google.cloud.securitycenter.v2.IGetSourceRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Source. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Relative resource name of the source. Its format is
* "organizations/[organization_id]/source/[source_id]".
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callGetSource() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.getSource(request);
console.log(response);
}
callGetSource();
getSource(request, options, callback)
getSource(request: protos.google.cloud.securitycenter.v2.IGetSourceRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.IGetSourceRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetSourceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.IGetSourceRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getSource(request, callback)
getSource(request: protos.google.cloud.securitycenter.v2.IGetSourceRequest, callback: Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.IGetSourceRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetSourceRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.IGetSourceRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getValuedResource(request, options)
getValuedResource(request?: protos.google.cloud.securitycenter.v2.IGetValuedResourceRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IValuedResource,
(protos.google.cloud.securitycenter.v2.IGetValuedResourceRequest | undefined),
{} | undefined
]>;
Get the valued resource by name
Parameters | |
---|---|
Name | Description |
request |
IGetValuedResourceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IValuedResource,
(protos.google.cloud.securitycenter.v2.IGetValuedResourceRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of this valued resource
* Valid format:
* "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"
*/
// const name = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callGetValuedResource() {
// Construct request
const request = {
name,
};
// Run request
const response = await securitycenterClient.getValuedResource(request);
console.log(response);
}
callGetValuedResource();
getValuedResource(request, options, callback)
getValuedResource(request: protos.google.cloud.securitycenter.v2.IGetValuedResourceRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IValuedResource, protos.google.cloud.securitycenter.v2.IGetValuedResourceRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetValuedResourceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IValuedResource, protos.google.cloud.securitycenter.v2.IGetValuedResourceRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getValuedResource(request, callback)
getValuedResource(request: protos.google.cloud.securitycenter.v2.IGetValuedResourceRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IValuedResource, protos.google.cloud.securitycenter.v2.IGetValuedResourceRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetValuedResourceRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IValuedResource, protos.google.cloud.securitycenter.v2.IGetValuedResourceRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
groupFindings(request, options)
groupFindings(request?: protos.google.cloud.securitycenter.v2.IGroupFindingsRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IGroupResult[],
protos.google.cloud.securitycenter.v2.IGroupFindingsRequest | null,
protos.google.cloud.securitycenter.v2.IGroupFindingsResponse
]>;
Filters an organization or source's findings and groups them by their specified properties in a location. If no location is specified, findings are assumed to be in global
To group across all sources provide a -
as the source id. The following list shows some examples:
/v2/organizations/{organization_id}/sources/-/findings
+/v2/organizations/{organization_id}/sources/-/locations/{location_id}/findings
+/v2/folders/{folder_id}/sources/-/findings
+/v2/folders/{folder_id}/sources/-/locations/{location_id}/findings
+/v2/projects/{project_id}/sources/-/findings
+/v2/projects/{project_id}/sources/-/locations/{location_id}/findings
Parameters | |
---|---|
Name | Description |
request |
IGroupFindingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IGroupResult[],
protos.google.cloud.securitycenter.v2.IGroupFindingsRequest | null,
protos.google.cloud.securitycenter.v2.IGroupFindingsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of GroupResult. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
groupFindings(request, options, callback)
groupFindings(request: protos.google.cloud.securitycenter.v2.IGroupFindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IGroupFindingsRequest, protos.google.cloud.securitycenter.v2.IGroupFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IGroupResult>): void;
Parameters | |
---|---|
Name | Description |
request |
IGroupFindingsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IGroupFindingsRequest, protos.google.cloud.securitycenter.v2.IGroupFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IGroupResult>
|
Returns | |
---|---|
Type | Description |
void |
groupFindings(request, callback)
groupFindings(request: protos.google.cloud.securitycenter.v2.IGroupFindingsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IGroupFindingsRequest, protos.google.cloud.securitycenter.v2.IGroupFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IGroupResult>): void;
Parameters | |
---|---|
Name | Description |
request |
IGroupFindingsRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IGroupFindingsRequest, protos.google.cloud.securitycenter.v2.IGroupFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IGroupResult>
|
Returns | |
---|---|
Type | Description |
void |
groupFindingsAsync(request, options)
groupFindingsAsync(request?: protos.google.cloud.securitycenter.v2.IGroupFindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v2.IGroupResult>;
Equivalent to groupFindings
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IGroupFindingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycenter.v2.IGroupResult> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing GroupResult. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the source to groupBy. If no location is specified,
* finding is assumed to be in global.
* The following list shows some examples:
* + `organizations/[organization_id]/sources/[source_id]`
* +
* `organizations/[organization_id]/sources/[source_id]/locations/[location_id]`
* + `folders/[folder_id]/sources/[source_id]`
* + `folders/[folder_id]/sources/[source_id]/locations/[location_id]`
* + `projects/[project_id]/sources/[source_id]`
* + `projects/[project_id]/sources/[source_id]/locations/[location_id]`
* To groupBy across all sources provide a source_id of `-`. The following
* list shows some examples:
* + `organizations/{organization_id}/sources/-`
* + `organizations/{organization_id}/sources/-/locations/[location_id]`
* + `folders/{folder_id}/sources/-`
* + `folders/{folder_id}/sources/-/locations/[location_id]`
* + `projects/{project_id}/sources/-`
* + `projects/{project_id}/sources/-/locations/[location_id]`
*/
// const parent = 'abc123'
/**
* Expression that defines the filter to apply across findings.
* The expression is a list of one or more restrictions combined via logical
* operators `AND` and `OR`.
* Parentheses are supported, and `OR` has higher precedence than `AND`.
* Restrictions have the form `
groupFindingsStream(request, options)
groupFindingsStream(request?: protos.google.cloud.securitycenter.v2.IGroupFindingsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IGroupFindingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing GroupResult on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
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. |
listAttackPaths(request, options)
listAttackPaths(request?: protos.google.cloud.securitycenter.v2.IListAttackPathsRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IAttackPath[],
protos.google.cloud.securitycenter.v2.IListAttackPathsRequest | null,
protos.google.cloud.securitycenter.v2.IListAttackPathsResponse
]>;
Lists the attack paths for a set of simulation results or valued resources and filter.
Parameters | |
---|---|
Name | Description |
request |
IListAttackPathsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IAttackPath[],
protos.google.cloud.securitycenter.v2.IListAttackPathsRequest | null,
protos.google.cloud.securitycenter.v2.IListAttackPathsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listAttackPaths(request, options, callback)
listAttackPaths(request: protos.google.cloud.securitycenter.v2.IListAttackPathsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListAttackPathsRequest, protos.google.cloud.securitycenter.v2.IListAttackPathsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IAttackPath>): void;
Parameters | |
---|---|
Name | Description |
request |
IListAttackPathsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListAttackPathsRequest, protos.google.cloud.securitycenter.v2.IListAttackPathsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IAttackPath>
|
Returns | |
---|---|
Type | Description |
void |
listAttackPaths(request, callback)
listAttackPaths(request: protos.google.cloud.securitycenter.v2.IListAttackPathsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListAttackPathsRequest, protos.google.cloud.securitycenter.v2.IListAttackPathsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IAttackPath>): void;
Parameters | |
---|---|
Name | Description |
request |
IListAttackPathsRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListAttackPathsRequest, protos.google.cloud.securitycenter.v2.IListAttackPathsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IAttackPath>
|
Returns | |
---|---|
Type | Description |
void |
listAttackPathsAsync(request, options)
listAttackPathsAsync(request?: protos.google.cloud.securitycenter.v2.IListAttackPathsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v2.IAttackPath>;
Equivalent to listAttackPaths
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListAttackPathsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycenter.v2.IAttackPath> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of parent to list attack paths.
* Valid formats:
* "organizations/{organization}",
* "organizations/{organization}/simulations/{simulation}"
* "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"
* "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"
*/
// const parent = 'abc123'
/**
* The filter expression that filters the attack path in the response.
* Supported fields:
* * `valued_resources` supports =
*/
// const filter = 'abc123'
/**
* The value returned by the last `ListAttackPathsResponse`; indicates
* that this is a continuation of a prior `ListAttackPaths` call, and
* that the system should return the next page of data.
*/
// const pageToken = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListAttackPaths() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listAttackPathsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAttackPaths();
listAttackPathsStream(request, options)
listAttackPathsStream(request?: protos.google.cloud.securitycenter.v2.IListAttackPathsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListAttackPathsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listBigQueryExports(request, options)
listBigQueryExports(request?: protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IBigQueryExport[],
protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest | null,
protos.google.cloud.securitycenter.v2.IListBigQueryExportsResponse
]>;
Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
Parameters | |
---|---|
Name | Description |
request |
IListBigQueryExportsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IBigQueryExport[],
protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest | null,
protos.google.cloud.securitycenter.v2.IListBigQueryExportsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of BigQueryExport. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listBigQueryExports(request, options, callback)
listBigQueryExports(request: protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest, protos.google.cloud.securitycenter.v2.IListBigQueryExportsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IBigQueryExport>): void;
Parameters | |
---|---|
Name | Description |
request |
IListBigQueryExportsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest, protos.google.cloud.securitycenter.v2.IListBigQueryExportsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IBigQueryExport>
|
Returns | |
---|---|
Type | Description |
void |
listBigQueryExports(request, callback)
listBigQueryExports(request: protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest, protos.google.cloud.securitycenter.v2.IListBigQueryExportsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IBigQueryExport>): void;
Parameters | |
---|---|
Name | Description |
request |
IListBigQueryExportsRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest, protos.google.cloud.securitycenter.v2.IListBigQueryExportsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IBigQueryExport>
|
Returns | |
---|---|
Type | Description |
void |
listBigQueryExportsAsync(request, options)
listBigQueryExportsAsync(request?: protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v2.IBigQueryExport>;
Equivalent to listBigQueryExports
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListBigQueryExportsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycenter.v2.IBigQueryExport> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing BigQueryExport. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent, which owns the collection of BigQuery exports. Its
* format is "organizations/[organization_id]/locations/[location_id]",
* "folders/[folder_id]/locations/[location_id]", or
* "projects/[project_id]/locations/[location_id]".
*/
// const parent = 'abc123'
/**
* The maximum number of configs to return. The service may return fewer than
* this value.
* If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListBigQueryExports` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListBigQueryExports`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListBigQueryExports() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listBigQueryExportsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListBigQueryExports();
listBigQueryExportsStream(request, options)
listBigQueryExportsStream(request?: protos.google.cloud.securitycenter.v2.IListBigQueryExportsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListBigQueryExportsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing BigQueryExport on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listFindings(request, options)
listFindings(request?: protos.google.cloud.securitycenter.v2.IListFindingsRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.ListFindingsResponse.IListFindingsResult[],
protos.google.cloud.securitycenter.v2.IListFindingsRequest | null,
protos.google.cloud.securitycenter.v2.IListFindingsResponse
]>;
Lists an organization or source's findings.
To list across all sources for a given location provide a -
as the source id. If no location is specified, finding are assumed to be in global. The following list shows some examples:
/v2/organizations/{organization_id}/sources/-/findings
+/v2/organizations/{organization_id}/sources/-/locations/{location_id}/findings
Parameters | |
---|---|
Name | Description |
request |
IListFindingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.ListFindingsResponse.IListFindingsResult[],
protos.google.cloud.securitycenter.v2.IListFindingsRequest | null,
protos.google.cloud.securitycenter.v2.IListFindingsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listFindings(request, options, callback)
listFindings(request: protos.google.cloud.securitycenter.v2.IListFindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListFindingsRequest, protos.google.cloud.securitycenter.v2.IListFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v2.ListFindingsResponse.IListFindingsResult>): void;
Parameters | |
---|---|
Name | Description |
request |
IListFindingsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListFindingsRequest, protos.google.cloud.securitycenter.v2.IListFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v2.ListFindingsResponse.IListFindingsResult>
|
Returns | |
---|---|
Type | Description |
void |
listFindings(request, callback)
listFindings(request: protos.google.cloud.securitycenter.v2.IListFindingsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListFindingsRequest, protos.google.cloud.securitycenter.v2.IListFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v2.ListFindingsResponse.IListFindingsResult>): void;
Parameters | |
---|---|
Name | Description |
request |
IListFindingsRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListFindingsRequest, protos.google.cloud.securitycenter.v2.IListFindingsResponse | null | undefined, protos.google.cloud.securitycenter.v2.ListFindingsResponse.IListFindingsResult>
|
Returns | |
---|---|
Type | Description |
void |
listFindingsAsync(request, options)
listFindingsAsync(request?: protos.google.cloud.securitycenter.v2.IListFindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v2.ListFindingsResponse.IListFindingsResult>;
Equivalent to listFindings
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListFindingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycenter.v2.ListFindingsResponse.IListFindingsResult> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the source the findings belong to. If no location is
* specified, the default is global. The following list shows some examples:
* + `organizations/[organization_id]/sources/[source_id]`
* +
* `organizations/[organization_id]/sources/[source_id]/locations/[location_id]`
* + `folders/[folder_id]/sources/[source_id]`
* + `folders/[folder_id]/sources/[source_id]/locations/[location_id]`
* + `projects/[project_id]/sources/[source_id]`
* + `projects/[project_id]/sources/[source_id]/locations/[location_id]`
* To list across all sources provide a source_id of `-`. The following
* list shows some examples:
* + `organizations/{organization_id}/sources/-`
* + `organizations/{organization_id}/sources/-/locations/{location_id}`
* + `folders/{folder_id}/sources/-`
* + `folders/{folder_id}/sources/-locations/{location_id}`
* + `projects/{projects_id}/sources/-`
* + `projects/{projects_id}/sources/-/locations/{location_id}`
*/
// const parent = 'abc123'
/**
* Expression that defines the filter to apply across findings.
* The expression is a list of one or more restrictions combined via logical
* operators `AND` and `OR`.
* Parentheses are supported, and `OR` has higher precedence than `AND`.
* Restrictions have the form `
listFindingsStream(request, options)
listFindingsStream(request?: protos.google.cloud.securitycenter.v2.IListFindingsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListFindingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listMuteConfigs(request, options)
listMuteConfigs(request?: protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IMuteConfig[],
protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest | null,
protos.google.cloud.securitycenter.v2.IListMuteConfigsResponse
]>;
Lists mute configs. If no location is specified, default is global.
Parameters | |
---|---|
Name | Description |
request |
IListMuteConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IMuteConfig[],
protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest | null,
protos.google.cloud.securitycenter.v2.IListMuteConfigsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listMuteConfigs(request, options, callback)
listMuteConfigs(request: protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest, protos.google.cloud.securitycenter.v2.IListMuteConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IMuteConfig>): void;
Parameters | |
---|---|
Name | Description |
request |
IListMuteConfigsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest, protos.google.cloud.securitycenter.v2.IListMuteConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IMuteConfig>
|
Returns | |
---|---|
Type | Description |
void |
listMuteConfigs(request, callback)
listMuteConfigs(request: protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest, protos.google.cloud.securitycenter.v2.IListMuteConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IMuteConfig>): void;
Parameters | |
---|---|
Name | Description |
request |
IListMuteConfigsRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest, protos.google.cloud.securitycenter.v2.IListMuteConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IMuteConfig>
|
Returns | |
---|---|
Type | Description |
void |
listMuteConfigsAsync(request, options)
listMuteConfigsAsync(request?: protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v2.IMuteConfig>;
Equivalent to listMuteConfigs
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListMuteConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycenter.v2.IMuteConfig> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent, which owns the collection of mute configs. Its format
* is "organizations/[organization_id]", "folders/[folder_id]",
* "projects/[project_id]",
* "organizations/[organization_id]/locations/[location_id]",
* "folders/[folder_id]/locations/[location_id]",
* "projects/[project_id]/locations/[location_id]".
*/
// const parent = 'abc123'
/**
* The maximum number of configs to return. The service may return fewer than
* this value.
* If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListMuteConfigs` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListMuteConfigs` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListMuteConfigs() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listMuteConfigsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListMuteConfigs();
listMuteConfigsStream(request, options)
listMuteConfigsStream(request?: protos.google.cloud.securitycenter.v2.IListMuteConfigsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListMuteConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listNotificationConfigs(request, options)
listNotificationConfigs(request?: protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.INotificationConfig[],
protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest | null,
protos.google.cloud.securitycenter.v2.IListNotificationConfigsResponse
]>;
Lists notification configs.
Parameters | |
---|---|
Name | Description |
request |
IListNotificationConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.INotificationConfig[],
protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest | null,
protos.google.cloud.securitycenter.v2.IListNotificationConfigsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listNotificationConfigs(request, options, callback)
listNotificationConfigs(request: protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest, protos.google.cloud.securitycenter.v2.IListNotificationConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.INotificationConfig>): void;
Parameters | |
---|---|
Name | Description |
request |
IListNotificationConfigsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest, protos.google.cloud.securitycenter.v2.IListNotificationConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.INotificationConfig>
|
Returns | |
---|---|
Type | Description |
void |
listNotificationConfigs(request, callback)
listNotificationConfigs(request: protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest, protos.google.cloud.securitycenter.v2.IListNotificationConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.INotificationConfig>): void;
Parameters | |
---|---|
Name | Description |
request |
IListNotificationConfigsRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest, protos.google.cloud.securitycenter.v2.IListNotificationConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.INotificationConfig>
|
Returns | |
---|---|
Type | Description |
void |
listNotificationConfigsAsync(request, options)
listNotificationConfigsAsync(request?: protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v2.INotificationConfig>;
Equivalent to listNotificationConfigs
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListNotificationConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycenter.v2.INotificationConfig> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent in which to list the notification
* configurations. Its format is
* "organizations/[organization_id]/locations/[location_id]",
* "folders/[folder_id]/locations/[location_id]", or
* "projects/[project_id]/locations/[location_id]".
*/
// const parent = 'abc123'
/**
* The value returned by the last `ListNotificationConfigsResponse`; indicates
* that this is a continuation of a prior `ListNotificationConfigs` call, and
* that the system should return the next page of data.
*/
// const pageToken = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListNotificationConfigs() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listNotificationConfigsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListNotificationConfigs();
listNotificationConfigsStream(request, options)
listNotificationConfigsStream(request?: protos.google.cloud.securitycenter.v2.IListNotificationConfigsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListNotificationConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters | |
---|---|
Name | Description |
request |
ListOperationsRequest
The request object that will be sent. |
options |
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.longrunning.ListOperationsResponse> | {Object} An iterable Object that conforms to iteration protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
listResourceValueConfigs(request, options)
listResourceValueConfigs(request?: protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IResourceValueConfig[],
protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest | null,
protos.google.cloud.securitycenter.v2.IListResourceValueConfigsResponse
]>;
Lists all ResourceValueConfigs.
Parameters | |
---|---|
Name | Description |
request |
IListResourceValueConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IResourceValueConfig[],
protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest | null,
protos.google.cloud.securitycenter.v2.IListResourceValueConfigsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listResourceValueConfigs(request, options, callback)
listResourceValueConfigs(request: protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest, protos.google.cloud.securitycenter.v2.IListResourceValueConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IResourceValueConfig>): void;
Parameters | |
---|---|
Name | Description |
request |
IListResourceValueConfigsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest, protos.google.cloud.securitycenter.v2.IListResourceValueConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IResourceValueConfig>
|
Returns | |
---|---|
Type | Description |
void |
listResourceValueConfigs(request, callback)
listResourceValueConfigs(request: protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest, protos.google.cloud.securitycenter.v2.IListResourceValueConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IResourceValueConfig>): void;
Parameters | |
---|---|
Name | Description |
request |
IListResourceValueConfigsRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest, protos.google.cloud.securitycenter.v2.IListResourceValueConfigsResponse | null | undefined, protos.google.cloud.securitycenter.v2.IResourceValueConfig>
|
Returns | |
---|---|
Type | Description |
void |
listResourceValueConfigsAsync(request, options)
listResourceValueConfigsAsync(request?: protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v2.IResourceValueConfig>;
Equivalent to listResourceValueConfigs
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListResourceValueConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycenter.v2.IResourceValueConfig> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent, which owns the collection of resource value configs.
* Its format is
* "organizations/[organization_id]"
*/
// const parent = 'abc123'
/**
* The maximum number of configs to return. The service may return fewer than
* this value.
* If unspecified, at most 10 configs will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListResourceValueConfigs` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListResourceValueConfigs` must match the call that provided the
* page token.
* page_size can be specified, and the new page_size will be used.
*/
// const pageToken = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListResourceValueConfigs() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listResourceValueConfigsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListResourceValueConfigs();
listResourceValueConfigsStream(request, options)
listResourceValueConfigsStream(request?: protos.google.cloud.securitycenter.v2.IListResourceValueConfigsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListResourceValueConfigsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listSources(request, options)
listSources(request?: protos.google.cloud.securitycenter.v2.IListSourcesRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.ISource[],
protos.google.cloud.securitycenter.v2.IListSourcesRequest | null,
protos.google.cloud.securitycenter.v2.IListSourcesResponse
]>;
Lists all sources belonging to an organization.
Parameters | |
---|---|
Name | Description |
request |
IListSourcesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.ISource[],
protos.google.cloud.securitycenter.v2.IListSourcesRequest | null,
protos.google.cloud.securitycenter.v2.IListSourcesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of Source. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listSources(request, options, callback)
listSources(request: protos.google.cloud.securitycenter.v2.IListSourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListSourcesRequest, protos.google.cloud.securitycenter.v2.IListSourcesResponse | null | undefined, protos.google.cloud.securitycenter.v2.ISource>): void;
Parameters | |
---|---|
Name | Description |
request |
IListSourcesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListSourcesRequest, protos.google.cloud.securitycenter.v2.IListSourcesResponse | null | undefined, protos.google.cloud.securitycenter.v2.ISource>
|
Returns | |
---|---|
Type | Description |
void |
listSources(request, callback)
listSources(request: protos.google.cloud.securitycenter.v2.IListSourcesRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListSourcesRequest, protos.google.cloud.securitycenter.v2.IListSourcesResponse | null | undefined, protos.google.cloud.securitycenter.v2.ISource>): void;
Parameters | |
---|---|
Name | Description |
request |
IListSourcesRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListSourcesRequest, protos.google.cloud.securitycenter.v2.IListSourcesResponse | null | undefined, protos.google.cloud.securitycenter.v2.ISource>
|
Returns | |
---|---|
Type | Description |
void |
listSourcesAsync(request, options)
listSourcesAsync(request?: protos.google.cloud.securitycenter.v2.IListSourcesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v2.ISource>;
Equivalent to listSources
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListSourcesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycenter.v2.ISource> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Source. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the parent of sources to list. Its format should
* be "organizations/[organization_id]", "folders/[folder_id]", or
* "projects/[project_id]".
*/
// const parent = 'abc123'
/**
* The value returned by the last `ListSourcesResponse`; indicates
* that this is a continuation of a prior `ListSources` call, and
* that the system should return the next page of data.
*/
// const pageToken = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListSources() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listSourcesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListSources();
listSourcesStream(request, options)
listSourcesStream(request?: protos.google.cloud.securitycenter.v2.IListSourcesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListSourcesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing Source on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listValuedResources(request, options)
listValuedResources(request?: protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IValuedResource[],
protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest | null,
protos.google.cloud.securitycenter.v2.IListValuedResourcesResponse
]>;
Lists the valued resources for a set of simulation results and filter.
Parameters | |
---|---|
Name | Description |
request |
IListValuedResourcesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IValuedResource[],
protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest | null,
protos.google.cloud.securitycenter.v2.IListValuedResourcesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listValuedResources(request, options, callback)
listValuedResources(request: protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest, protos.google.cloud.securitycenter.v2.IListValuedResourcesResponse | null | undefined, protos.google.cloud.securitycenter.v2.IValuedResource>): void;
Parameters | |
---|---|
Name | Description |
request |
IListValuedResourcesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest, protos.google.cloud.securitycenter.v2.IListValuedResourcesResponse | null | undefined, protos.google.cloud.securitycenter.v2.IValuedResource>
|
Returns | |
---|---|
Type | Description |
void |
listValuedResources(request, callback)
listValuedResources(request: protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest, callback: PaginationCallback<protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest, protos.google.cloud.securitycenter.v2.IListValuedResourcesResponse | null | undefined, protos.google.cloud.securitycenter.v2.IValuedResource>): void;
Parameters | |
---|---|
Name | Description |
request |
IListValuedResourcesRequest
|
callback |
PaginationCallback<protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest, protos.google.cloud.securitycenter.v2.IListValuedResourcesResponse | null | undefined, protos.google.cloud.securitycenter.v2.IValuedResource>
|
Returns | |
---|---|
Type | Description |
void |
listValuedResourcesAsync(request, options)
listValuedResourcesAsync(request?: protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.securitycenter.v2.IValuedResource>;
Equivalent to listValuedResources
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListValuedResourcesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.securitycenter.v2.IValuedResource> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of parent to list exposed resources.
* Valid formats:
* "organizations/{organization}",
* "organizations/{organization}/simulations/{simulation}"
* "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"
*/
// const parent = 'abc123'
/**
* The filter expression that filters the valued resources in the response.
* Supported fields:
* * `resource_value` supports =
* * `resource_type` supports =
*/
// const filter = 'abc123'
/**
* The value returned by the last `ListValuedResourcesResponse`; indicates
* that this is a continuation of a prior `ListValuedResources` call, and
* that the system should return the next page of data.
*/
// const pageToken = 'abc123'
/**
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*/
// const pageSize = 1234
/**
* Optional. The fields by which to order the valued resources response.
* Supported fields:
* * `exposed_score`
* * `resource_value`
* * `resource_type`
* Values should be a comma separated list of fields. For example:
* `exposed_score,resource_value`.
* The default sorting order is descending. To specify ascending or descending
* order for a field, append a " ASC" or a " DESC" suffix, respectively; for
* example: `exposed_score DESC`.
*/
// const orderBy = 'abc123'
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callListValuedResources() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = securitycenterClient.listValuedResourcesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListValuedResources();
listValuedResourcesStream(request, options)
listValuedResourcesStream(request?: protos.google.cloud.securitycenter.v2.IListValuedResourcesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListValuedResourcesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
matchAssetFromFolderAssetSecurityMarksName(folderAssetSecurityMarksName)
matchAssetFromFolderAssetSecurityMarksName(folderAssetSecurityMarksName: string): string | number;
Parse the asset from FolderAssetSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
folderAssetSecurityMarksName |
string
A fully-qualified path representing folder_asset_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the asset. |
matchAssetFromOrganizationAssetSecurityMarksName(organizationAssetSecurityMarksName)
matchAssetFromOrganizationAssetSecurityMarksName(organizationAssetSecurityMarksName: string): string | number;
Parse the asset from OrganizationAssetSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
organizationAssetSecurityMarksName |
string
A fully-qualified path representing organization_asset_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the asset. |
matchAssetFromProjectAssetSecurityMarksName(projectAssetSecurityMarksName)
matchAssetFromProjectAssetSecurityMarksName(projectAssetSecurityMarksName: string): string | number;
Parse the asset from ProjectAssetSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
projectAssetSecurityMarksName |
string
A fully-qualified path representing project_asset_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the asset. |
matchAttackPathFromAttackPathName(attackPathName)
matchAttackPathFromAttackPathName(attackPathName: string): string | number;
Parse the attack_path from AttackPath resource.
Parameter | |
---|---|
Name | Description |
attackPathName |
string
A fully-qualified path representing AttackPath resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the attack_path. |
matchConstraintNameFromFolderConstraintNameName(folderConstraintNameName)
matchConstraintNameFromFolderConstraintNameName(folderConstraintNameName: string): string | number;
Parse the constraint_name from FolderConstraintName resource.
Parameter | |
---|---|
Name | Description |
folderConstraintNameName |
string
A fully-qualified path representing folder_constraint_name resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the constraint_name. |
matchConstraintNameFromOrganizationConstraintNameName(organizationConstraintNameName)
matchConstraintNameFromOrganizationConstraintNameName(organizationConstraintNameName: string): string | number;
Parse the constraint_name from OrganizationConstraintName resource.
Parameter | |
---|---|
Name | Description |
organizationConstraintNameName |
string
A fully-qualified path representing organization_constraint_name resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the constraint_name. |
matchConstraintNameFromProjectConstraintNameName(projectConstraintNameName)
matchConstraintNameFromProjectConstraintNameName(projectConstraintNameName: string): string | number;
Parse the constraint_name from ProjectConstraintName resource.
Parameter | |
---|---|
Name | Description |
projectConstraintNameName |
string
A fully-qualified path representing project_constraint_name resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the constraint_name. |
matchExportFromFolderLocationExportName(folderLocationExportName)
matchExportFromFolderLocationExportName(folderLocationExportName: string): string | number;
Parse the export from FolderLocationExport resource.
Parameter | |
---|---|
Name | Description |
folderLocationExportName |
string
A fully-qualified path representing folder_location_export resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the export. |
matchExportFromOrganizationLocationExportName(organizationLocationExportName)
matchExportFromOrganizationLocationExportName(organizationLocationExportName: string): string | number;
Parse the export from OrganizationLocationExport resource.
Parameter | |
---|---|
Name | Description |
organizationLocationExportName |
string
A fully-qualified path representing organization_location_export resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the export. |
matchExportFromProjectLocationExportName(projectLocationExportName)
matchExportFromProjectLocationExportName(projectLocationExportName: string): string | number;
Parse the export from ProjectLocationExport resource.
Parameter | |
---|---|
Name | Description |
projectLocationExportName |
string
A fully-qualified path representing project_location_export resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the export. |
matchExternalsystemFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName)
matchExternalsystemFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName: string): string | number;
Parse the externalsystem from FolderSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingExternalsystemName |
string
A fully-qualified path representing folder_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the externalsystem. |
matchExternalsystemFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName)
matchExternalsystemFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName: string): string | number;
Parse the externalsystem from FolderSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing folder_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the externalsystem. |
matchExternalsystemFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName)
matchExternalsystemFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName: string): string | number;
Parse the externalsystem from OrganizationSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingExternalsystemName |
string
A fully-qualified path representing organization_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the externalsystem. |
matchExternalsystemFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName)
matchExternalsystemFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName: string): string | number;
Parse the externalsystem from OrganizationSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing organization_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the externalsystem. |
matchExternalsystemFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName)
matchExternalsystemFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName: string): string | number;
Parse the externalsystem from ProjectSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingExternalsystemName |
string
A fully-qualified path representing project_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the externalsystem. |
matchExternalsystemFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName)
matchExternalsystemFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName: string): string | number;
Parse the externalsystem from ProjectSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing project_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the externalsystem. |
matchFindingFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName)
matchFindingFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName: string): string | number;
Parse the finding from FolderSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingExternalsystemName |
string
A fully-qualified path representing folder_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromFolderSourceFindingName(folderSourceFindingName)
matchFindingFromFolderSourceFindingName(folderSourceFindingName: string): string | number;
Parse the finding from FolderSourceFinding resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingName |
string
A fully-qualified path representing folder_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName)
matchFindingFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName: string): string | number;
Parse the finding from FolderSourceFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingSecurityMarksName |
string
A fully-qualified path representing folder_source_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName)
matchFindingFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName: string): string | number;
Parse the finding from FolderSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing folder_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromFolderSourceLocationFindingName(folderSourceLocationFindingName)
matchFindingFromFolderSourceLocationFindingName(folderSourceLocationFindingName: string): string | number;
Parse the finding from FolderSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingName |
string
A fully-qualified path representing folder_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName)
matchFindingFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName: string): string | number;
Parse the finding from FolderSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing folder_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName)
matchFindingFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName: string): string | number;
Parse the finding from OrganizationSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingExternalsystemName |
string
A fully-qualified path representing organization_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromOrganizationSourceFindingName(organizationSourceFindingName)
matchFindingFromOrganizationSourceFindingName(organizationSourceFindingName: string): string | number;
Parse the finding from OrganizationSourceFinding resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingName |
string
A fully-qualified path representing organization_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName)
matchFindingFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName: string): string | number;
Parse the finding from OrganizationSourceFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingSecurityMarksName |
string
A fully-qualified path representing organization_source_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName)
matchFindingFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName: string): string | number;
Parse the finding from OrganizationSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing organization_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName)
matchFindingFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName: string): string | number;
Parse the finding from OrganizationSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingName |
string
A fully-qualified path representing organization_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName)
matchFindingFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName: string): string | number;
Parse the finding from OrganizationSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing organization_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName)
matchFindingFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName: string): string | number;
Parse the finding from ProjectSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingExternalsystemName |
string
A fully-qualified path representing project_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromProjectSourceFindingName(projectSourceFindingName)
matchFindingFromProjectSourceFindingName(projectSourceFindingName: string): string | number;
Parse the finding from ProjectSourceFinding resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingName |
string
A fully-qualified path representing project_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName)
matchFindingFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName: string): string | number;
Parse the finding from ProjectSourceFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingSecurityMarksName |
string
A fully-qualified path representing project_source_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName)
matchFindingFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName: string): string | number;
Parse the finding from ProjectSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing project_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromProjectSourceLocationFindingName(projectSourceLocationFindingName)
matchFindingFromProjectSourceLocationFindingName(projectSourceLocationFindingName: string): string | number;
Parse the finding from ProjectSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingName |
string
A fully-qualified path representing project_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFindingFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName)
matchFindingFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName: string): string | number;
Parse the finding from ProjectSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing project_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the finding. |
matchFolderFromFolderAssetSecurityMarksName(folderAssetSecurityMarksName)
matchFolderFromFolderAssetSecurityMarksName(folderAssetSecurityMarksName: string): string | number;
Parse the folder from FolderAssetSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
folderAssetSecurityMarksName |
string
A fully-qualified path representing folder_asset_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderConstraintNameName(folderConstraintNameName)
matchFolderFromFolderConstraintNameName(folderConstraintNameName: string): string | number;
Parse the folder from FolderConstraintName resource.
Parameter | |
---|---|
Name | Description |
folderConstraintNameName |
string
A fully-qualified path representing folder_constraint_name resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderLocationExportName(folderLocationExportName)
matchFolderFromFolderLocationExportName(folderLocationExportName: string): string | number;
Parse the folder from FolderLocationExport resource.
Parameter | |
---|---|
Name | Description |
folderLocationExportName |
string
A fully-qualified path representing folder_location_export resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderLocationMuteConfigName(folderLocationMuteConfigName)
matchFolderFromFolderLocationMuteConfigName(folderLocationMuteConfigName: string): string | number;
Parse the folder from FolderLocationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
folderLocationMuteConfigName |
string
A fully-qualified path representing folder_location_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderLocationNotificationConfigName(folderLocationNotificationConfigName)
matchFolderFromFolderLocationNotificationConfigName(folderLocationNotificationConfigName: string): string | number;
Parse the folder from FolderLocationNotificationConfig resource.
Parameter | |
---|---|
Name | Description |
folderLocationNotificationConfigName |
string
A fully-qualified path representing folder_location_notification_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderMuteConfigName(folderMuteConfigName)
matchFolderFromFolderMuteConfigName(folderMuteConfigName: string): string | number;
Parse the folder from FolderMuteConfig resource.
Parameter | |
---|---|
Name | Description |
folderMuteConfigName |
string
A fully-qualified path representing folder_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName)
matchFolderFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName: string): string | number;
Parse the folder from FolderSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingExternalsystemName |
string
A fully-qualified path representing folder_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderSourceFindingName(folderSourceFindingName)
matchFolderFromFolderSourceFindingName(folderSourceFindingName: string): string | number;
Parse the folder from FolderSourceFinding resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingName |
string
A fully-qualified path representing folder_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName)
matchFolderFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName: string): string | number;
Parse the folder from FolderSourceFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingSecurityMarksName |
string
A fully-qualified path representing folder_source_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName)
matchFolderFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName: string): string | number;
Parse the folder from FolderSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing folder_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderSourceLocationFindingName(folderSourceLocationFindingName)
matchFolderFromFolderSourceLocationFindingName(folderSourceLocationFindingName: string): string | number;
Parse the folder from FolderSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingName |
string
A fully-qualified path representing folder_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName)
matchFolderFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName: string): string | number;
Parse the folder from FolderSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing folder_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchFolderFromFolderSourceName(folderSourceName)
matchFolderFromFolderSourceName(folderSourceName: string): string | number;
Parse the folder from FolderSource resource.
Parameter | |
---|---|
Name | Description |
folderSourceName |
string
A fully-qualified path representing folder_source resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the folder. |
matchLocationFromFolderLocationExportName(folderLocationExportName)
matchLocationFromFolderLocationExportName(folderLocationExportName: string): string | number;
Parse the location from FolderLocationExport resource.
Parameter | |
---|---|
Name | Description |
folderLocationExportName |
string
A fully-qualified path representing folder_location_export resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromFolderLocationMuteConfigName(folderLocationMuteConfigName)
matchLocationFromFolderLocationMuteConfigName(folderLocationMuteConfigName: string): string | number;
Parse the location from FolderLocationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
folderLocationMuteConfigName |
string
A fully-qualified path representing folder_location_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromFolderLocationNotificationConfigName(folderLocationNotificationConfigName)
matchLocationFromFolderLocationNotificationConfigName(folderLocationNotificationConfigName: string): string | number;
Parse the location from FolderLocationNotificationConfig resource.
Parameter | |
---|---|
Name | Description |
folderLocationNotificationConfigName |
string
A fully-qualified path representing folder_location_notification_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName)
matchLocationFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName: string): string | number;
Parse the location from FolderSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing folder_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromFolderSourceLocationFindingName(folderSourceLocationFindingName)
matchLocationFromFolderSourceLocationFindingName(folderSourceLocationFindingName: string): string | number;
Parse the location from FolderSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingName |
string
A fully-qualified path representing folder_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName)
matchLocationFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName: string): string | number;
Parse the location from FolderSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing folder_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromOrganizationLocationExportName(organizationLocationExportName)
matchLocationFromOrganizationLocationExportName(organizationLocationExportName: string): string | number;
Parse the location from OrganizationLocationExport resource.
Parameter | |
---|---|
Name | Description |
organizationLocationExportName |
string
A fully-qualified path representing organization_location_export resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName)
matchLocationFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName: string): string | number;
Parse the location from OrganizationLocationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
organizationLocationMuteConfigName |
string
A fully-qualified path representing organization_location_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
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. |
matchLocationFromOrganizationLocationNotificationConfigName(organizationLocationNotificationConfigName)
matchLocationFromOrganizationLocationNotificationConfigName(organizationLocationNotificationConfigName: string): string | number;
Parse the location from OrganizationLocationNotificationConfig resource.
Parameter | |
---|---|
Name | Description |
organizationLocationNotificationConfigName |
string
A fully-qualified path representing organization_location_notification_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName)
matchLocationFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName: string): string | number;
Parse the location from OrganizationSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing organization_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName)
matchLocationFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName: string): string | number;
Parse the location from OrganizationSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingName |
string
A fully-qualified path representing organization_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName)
matchLocationFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName: string): string | number;
Parse the location from OrganizationSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing organization_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationExportName(projectLocationExportName)
matchLocationFromProjectLocationExportName(projectLocationExportName: string): string | number;
Parse the location from ProjectLocationExport resource.
Parameter | |
---|---|
Name | Description |
projectLocationExportName |
string
A fully-qualified path representing project_location_export resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationMuteConfigName(projectLocationMuteConfigName)
matchLocationFromProjectLocationMuteConfigName(projectLocationMuteConfigName: string): string | number;
Parse the location from ProjectLocationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
projectLocationMuteConfigName |
string
A fully-qualified path representing project_location_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationNotificationConfigName(projectLocationNotificationConfigName)
matchLocationFromProjectLocationNotificationConfigName(projectLocationNotificationConfigName: string): string | number;
Parse the location from ProjectLocationNotificationConfig resource.
Parameter | |
---|---|
Name | Description |
projectLocationNotificationConfigName |
string
A fully-qualified path representing project_location_notification_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName)
matchLocationFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName: string): string | number;
Parse the location from ProjectSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing project_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectSourceLocationFindingName(projectSourceLocationFindingName)
matchLocationFromProjectSourceLocationFindingName(projectSourceLocationFindingName: string): string | number;
Parse the location from ProjectSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingName |
string
A fully-qualified path representing project_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName)
matchLocationFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName: string): string | number;
Parse the location from ProjectSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing project_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchMuteConfigFromFolderLocationMuteConfigName(folderLocationMuteConfigName)
matchMuteConfigFromFolderLocationMuteConfigName(folderLocationMuteConfigName: string): string | number;
Parse the mute_config from FolderLocationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
folderLocationMuteConfigName |
string
A fully-qualified path representing folder_location_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the mute_config. |
matchMuteConfigFromFolderMuteConfigName(folderMuteConfigName)
matchMuteConfigFromFolderMuteConfigName(folderMuteConfigName: string): string | number;
Parse the mute_config from FolderMuteConfig resource.
Parameter | |
---|---|
Name | Description |
folderMuteConfigName |
string
A fully-qualified path representing folder_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the mute_config. |
matchMuteConfigFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName)
matchMuteConfigFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName: string): string | number;
Parse the mute_config from OrganizationLocationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
organizationLocationMuteConfigName |
string
A fully-qualified path representing organization_location_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the mute_config. |
matchMuteConfigFromOrganizationMuteConfigName(organizationMuteConfigName)
matchMuteConfigFromOrganizationMuteConfigName(organizationMuteConfigName: string): string | number;
Parse the mute_config from OrganizationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
organizationMuteConfigName |
string
A fully-qualified path representing organization_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the mute_config. |
matchMuteConfigFromProjectLocationMuteConfigName(projectLocationMuteConfigName)
matchMuteConfigFromProjectLocationMuteConfigName(projectLocationMuteConfigName: string): string | number;
Parse the mute_config from ProjectLocationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
projectLocationMuteConfigName |
string
A fully-qualified path representing project_location_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the mute_config. |
matchMuteConfigFromProjectMuteConfigName(projectMuteConfigName)
matchMuteConfigFromProjectMuteConfigName(projectMuteConfigName: string): string | number;
Parse the mute_config from ProjectMuteConfig resource.
Parameter | |
---|---|
Name | Description |
projectMuteConfigName |
string
A fully-qualified path representing project_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the mute_config. |
matchNotificationConfigFromFolderLocationNotificationConfigName(folderLocationNotificationConfigName)
matchNotificationConfigFromFolderLocationNotificationConfigName(folderLocationNotificationConfigName: string): string | number;
Parse the notification_config from FolderLocationNotificationConfig resource.
Parameter | |
---|---|
Name | Description |
folderLocationNotificationConfigName |
string
A fully-qualified path representing folder_location_notification_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the notification_config. |
matchNotificationConfigFromOrganizationLocationNotificationConfigName(organizationLocationNotificationConfigName)
matchNotificationConfigFromOrganizationLocationNotificationConfigName(organizationLocationNotificationConfigName: string): string | number;
Parse the notification_config from OrganizationLocationNotificationConfig resource.
Parameter | |
---|---|
Name | Description |
organizationLocationNotificationConfigName |
string
A fully-qualified path representing organization_location_notification_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the notification_config. |
matchNotificationConfigFromProjectLocationNotificationConfigName(projectLocationNotificationConfigName)
matchNotificationConfigFromProjectLocationNotificationConfigName(projectLocationNotificationConfigName: string): string | number;
Parse the notification_config from ProjectLocationNotificationConfig resource.
Parameter | |
---|---|
Name | Description |
projectLocationNotificationConfigName |
string
A fully-qualified path representing project_location_notification_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the notification_config. |
matchOrganizationFromAttackPathName(attackPathName)
matchOrganizationFromAttackPathName(attackPathName: string): string | number;
Parse the organization from AttackPath resource.
Parameter | |
---|---|
Name | Description |
attackPathName |
string
A fully-qualified path representing AttackPath resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationAssetSecurityMarksName(organizationAssetSecurityMarksName)
matchOrganizationFromOrganizationAssetSecurityMarksName(organizationAssetSecurityMarksName: string): string | number;
Parse the organization from OrganizationAssetSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
organizationAssetSecurityMarksName |
string
A fully-qualified path representing organization_asset_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationConstraintNameName(organizationConstraintNameName)
matchOrganizationFromOrganizationConstraintNameName(organizationConstraintNameName: string): string | number;
Parse the organization from OrganizationConstraintName resource.
Parameter | |
---|---|
Name | Description |
organizationConstraintNameName |
string
A fully-qualified path representing organization_constraint_name resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationLocationExportName(organizationLocationExportName)
matchOrganizationFromOrganizationLocationExportName(organizationLocationExportName: string): string | number;
Parse the organization from OrganizationLocationExport resource.
Parameter | |
---|---|
Name | Description |
organizationLocationExportName |
string
A fully-qualified path representing organization_location_export resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName)
matchOrganizationFromOrganizationLocationMuteConfigName(organizationLocationMuteConfigName: string): string | number;
Parse the organization from OrganizationLocationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
organizationLocationMuteConfigName |
string
A fully-qualified path representing organization_location_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
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. |
matchOrganizationFromOrganizationLocationNotificationConfigName(organizationLocationNotificationConfigName)
matchOrganizationFromOrganizationLocationNotificationConfigName(organizationLocationNotificationConfigName: string): string | number;
Parse the organization from OrganizationLocationNotificationConfig resource.
Parameter | |
---|---|
Name | Description |
organizationLocationNotificationConfigName |
string
A fully-qualified path representing organization_location_notification_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationMuteConfigName(organizationMuteConfigName)
matchOrganizationFromOrganizationMuteConfigName(organizationMuteConfigName: string): string | number;
Parse the organization from OrganizationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
organizationMuteConfigName |
string
A fully-qualified path representing organization_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationName(organizationName)
matchOrganizationFromOrganizationName(organizationName: string): string | number;
Parse the organization from Organization resource.
Parameter | |
---|---|
Name | Description |
organizationName |
string
A fully-qualified path representing Organization resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName)
matchOrganizationFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName: string): string | number;
Parse the organization from OrganizationSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingExternalsystemName |
string
A fully-qualified path representing organization_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationSourceFindingName(organizationSourceFindingName)
matchOrganizationFromOrganizationSourceFindingName(organizationSourceFindingName: string): string | number;
Parse the organization from OrganizationSourceFinding resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingName |
string
A fully-qualified path representing organization_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName)
matchOrganizationFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName: string): string | number;
Parse the organization from OrganizationSourceFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingSecurityMarksName |
string
A fully-qualified path representing organization_source_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName)
matchOrganizationFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName: string): string | number;
Parse the organization from OrganizationSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing organization_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName)
matchOrganizationFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName: string): string | number;
Parse the organization from OrganizationSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingName |
string
A fully-qualified path representing organization_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName)
matchOrganizationFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName: string): string | number;
Parse the organization from OrganizationSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing organization_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromOrganizationSourceName(organizationSourceName)
matchOrganizationFromOrganizationSourceName(organizationSourceName: string): string | number;
Parse the organization from OrganizationSource resource.
Parameter | |
---|---|
Name | Description |
organizationSourceName |
string
A fully-qualified path representing organization_source resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromResourceValueConfigName(resourceValueConfigName)
matchOrganizationFromResourceValueConfigName(resourceValueConfigName: string): string | number;
Parse the organization from ResourceValueConfig resource.
Parameter | |
---|---|
Name | Description |
resourceValueConfigName |
string
A fully-qualified path representing ResourceValueConfig resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromSimulationName(simulationName)
matchOrganizationFromSimulationName(simulationName: string): string | number;
Parse the organization from Simulation resource.
Parameter | |
---|---|
Name | Description |
simulationName |
string
A fully-qualified path representing Simulation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchOrganizationFromValuedResourceName(valuedResourceName)
matchOrganizationFromValuedResourceName(valuedResourceName: string): string | number;
Parse the organization from ValuedResource resource.
Parameter | |
---|---|
Name | Description |
valuedResourceName |
string
A fully-qualified path representing ValuedResource resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the organization. |
matchProjectFromProjectAssetSecurityMarksName(projectAssetSecurityMarksName)
matchProjectFromProjectAssetSecurityMarksName(projectAssetSecurityMarksName: string): string | number;
Parse the project from ProjectAssetSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
projectAssetSecurityMarksName |
string
A fully-qualified path representing project_asset_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectConstraintNameName(projectConstraintNameName)
matchProjectFromProjectConstraintNameName(projectConstraintNameName: string): string | number;
Parse the project from ProjectConstraintName resource.
Parameter | |
---|---|
Name | Description |
projectConstraintNameName |
string
A fully-qualified path representing project_constraint_name resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationExportName(projectLocationExportName)
matchProjectFromProjectLocationExportName(projectLocationExportName: string): string | number;
Parse the project from ProjectLocationExport resource.
Parameter | |
---|---|
Name | Description |
projectLocationExportName |
string
A fully-qualified path representing project_location_export resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationMuteConfigName(projectLocationMuteConfigName)
matchProjectFromProjectLocationMuteConfigName(projectLocationMuteConfigName: string): string | number;
Parse the project from ProjectLocationMuteConfig resource.
Parameter | |
---|---|
Name | Description |
projectLocationMuteConfigName |
string
A fully-qualified path representing project_location_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationNotificationConfigName(projectLocationNotificationConfigName)
matchProjectFromProjectLocationNotificationConfigName(projectLocationNotificationConfigName: string): string | number;
Parse the project from ProjectLocationNotificationConfig resource.
Parameter | |
---|---|
Name | Description |
projectLocationNotificationConfigName |
string
A fully-qualified path representing project_location_notification_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectMuteConfigName(projectMuteConfigName)
matchProjectFromProjectMuteConfigName(projectMuteConfigName: string): string | number;
Parse the project from ProjectMuteConfig resource.
Parameter | |
---|---|
Name | Description |
projectMuteConfigName |
string
A fully-qualified path representing project_mute_config resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName)
matchProjectFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName: string): string | number;
Parse the project from ProjectSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingExternalsystemName |
string
A fully-qualified path representing project_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectSourceFindingName(projectSourceFindingName)
matchProjectFromProjectSourceFindingName(projectSourceFindingName: string): string | number;
Parse the project from ProjectSourceFinding resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingName |
string
A fully-qualified path representing project_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName)
matchProjectFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName: string): string | number;
Parse the project from ProjectSourceFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingSecurityMarksName |
string
A fully-qualified path representing project_source_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName)
matchProjectFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName: string): string | number;
Parse the project from ProjectSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing project_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectSourceLocationFindingName(projectSourceLocationFindingName)
matchProjectFromProjectSourceLocationFindingName(projectSourceLocationFindingName: string): string | number;
Parse the project from ProjectSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingName |
string
A fully-qualified path representing project_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName)
matchProjectFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName: string): string | number;
Parse the project from ProjectSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing project_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectSourceName(projectSourceName)
matchProjectFromProjectSourceName(projectSourceName: string): string | number;
Parse the project from ProjectSource resource.
Parameter | |
---|---|
Name | Description |
projectSourceName |
string
A fully-qualified path representing project_source resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchResourceValueConfigFromResourceValueConfigName(resourceValueConfigName)
matchResourceValueConfigFromResourceValueConfigName(resourceValueConfigName: string): string | number;
Parse the resource_value_config from ResourceValueConfig resource.
Parameter | |
---|---|
Name | Description |
resourceValueConfigName |
string
A fully-qualified path representing ResourceValueConfig resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the resource_value_config. |
matchSimulationFromAttackPathName(attackPathName)
matchSimulationFromAttackPathName(attackPathName: string): string | number;
Parse the simulation from AttackPath resource.
Parameter | |
---|---|
Name | Description |
attackPathName |
string
A fully-qualified path representing AttackPath resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the simulation. |
matchSimulationFromSimulationName(simulationName)
matchSimulationFromSimulationName(simulationName: string): string | number;
Parse the simulation from Simulation resource.
Parameter | |
---|---|
Name | Description |
simulationName |
string
A fully-qualified path representing Simulation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the simulation. |
matchSimulationFromValuedResourceName(valuedResourceName)
matchSimulationFromValuedResourceName(valuedResourceName: string): string | number;
Parse the simulation from ValuedResource resource.
Parameter | |
---|---|
Name | Description |
valuedResourceName |
string
A fully-qualified path representing ValuedResource resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the simulation. |
matchSourceFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName)
matchSourceFromFolderSourceFindingExternalsystemName(folderSourceFindingExternalsystemName: string): string | number;
Parse the source from FolderSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingExternalsystemName |
string
A fully-qualified path representing folder_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromFolderSourceFindingName(folderSourceFindingName)
matchSourceFromFolderSourceFindingName(folderSourceFindingName: string): string | number;
Parse the source from FolderSourceFinding resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingName |
string
A fully-qualified path representing folder_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName)
matchSourceFromFolderSourceFindingSecurityMarksName(folderSourceFindingSecurityMarksName: string): string | number;
Parse the source from FolderSourceFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
folderSourceFindingSecurityMarksName |
string
A fully-qualified path representing folder_source_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName)
matchSourceFromFolderSourceLocationFindingExternalsystemName(folderSourceLocationFindingExternalsystemName: string): string | number;
Parse the source from FolderSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing folder_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromFolderSourceLocationFindingName(folderSourceLocationFindingName)
matchSourceFromFolderSourceLocationFindingName(folderSourceLocationFindingName: string): string | number;
Parse the source from FolderSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingName |
string
A fully-qualified path representing folder_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName)
matchSourceFromFolderSourceLocationFindingSecurityMarksName(folderSourceLocationFindingSecurityMarksName: string): string | number;
Parse the source from FolderSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
folderSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing folder_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromFolderSourceName(folderSourceName)
matchSourceFromFolderSourceName(folderSourceName: string): string | number;
Parse the source from FolderSource resource.
Parameter | |
---|---|
Name | Description |
folderSourceName |
string
A fully-qualified path representing folder_source resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName)
matchSourceFromOrganizationSourceFindingExternalsystemName(organizationSourceFindingExternalsystemName: string): string | number;
Parse the source from OrganizationSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingExternalsystemName |
string
A fully-qualified path representing organization_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromOrganizationSourceFindingName(organizationSourceFindingName)
matchSourceFromOrganizationSourceFindingName(organizationSourceFindingName: string): string | number;
Parse the source from OrganizationSourceFinding resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingName |
string
A fully-qualified path representing organization_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName)
matchSourceFromOrganizationSourceFindingSecurityMarksName(organizationSourceFindingSecurityMarksName: string): string | number;
Parse the source from OrganizationSourceFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
organizationSourceFindingSecurityMarksName |
string
A fully-qualified path representing organization_source_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName)
matchSourceFromOrganizationSourceLocationFindingExternalsystemName(organizationSourceLocationFindingExternalsystemName: string): string | number;
Parse the source from OrganizationSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing organization_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName)
matchSourceFromOrganizationSourceLocationFindingName(organizationSourceLocationFindingName: string): string | number;
Parse the source from OrganizationSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingName |
string
A fully-qualified path representing organization_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName)
matchSourceFromOrganizationSourceLocationFindingSecurityMarksName(organizationSourceLocationFindingSecurityMarksName: string): string | number;
Parse the source from OrganizationSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
organizationSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing organization_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromOrganizationSourceName(organizationSourceName)
matchSourceFromOrganizationSourceName(organizationSourceName: string): string | number;
Parse the source from OrganizationSource resource.
Parameter | |
---|---|
Name | Description |
organizationSourceName |
string
A fully-qualified path representing organization_source resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName)
matchSourceFromProjectSourceFindingExternalsystemName(projectSourceFindingExternalsystemName: string): string | number;
Parse the source from ProjectSourceFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingExternalsystemName |
string
A fully-qualified path representing project_source_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromProjectSourceFindingName(projectSourceFindingName)
matchSourceFromProjectSourceFindingName(projectSourceFindingName: string): string | number;
Parse the source from ProjectSourceFinding resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingName |
string
A fully-qualified path representing project_source_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName)
matchSourceFromProjectSourceFindingSecurityMarksName(projectSourceFindingSecurityMarksName: string): string | number;
Parse the source from ProjectSourceFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
projectSourceFindingSecurityMarksName |
string
A fully-qualified path representing project_source_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName)
matchSourceFromProjectSourceLocationFindingExternalsystemName(projectSourceLocationFindingExternalsystemName: string): string | number;
Parse the source from ProjectSourceLocationFindingExternalsystem resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingExternalsystemName |
string
A fully-qualified path representing project_source_location_finding_externalsystem resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromProjectSourceLocationFindingName(projectSourceLocationFindingName)
matchSourceFromProjectSourceLocationFindingName(projectSourceLocationFindingName: string): string | number;
Parse the source from ProjectSourceLocationFinding resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingName |
string
A fully-qualified path representing project_source_location_finding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName)
matchSourceFromProjectSourceLocationFindingSecurityMarksName(projectSourceLocationFindingSecurityMarksName: string): string | number;
Parse the source from ProjectSourceLocationFindingSecurityMarks resource.
Parameter | |
---|---|
Name | Description |
projectSourceLocationFindingSecurityMarksName |
string
A fully-qualified path representing project_source_location_finding_securityMarks resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchSourceFromProjectSourceName(projectSourceName)
matchSourceFromProjectSourceName(projectSourceName: string): string | number;
Parse the source from ProjectSource resource.
Parameter | |
---|---|
Name | Description |
projectSourceName |
string
A fully-qualified path representing project_source resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the source. |
matchValuedResourceFromAttackPathName(attackPathName)
matchValuedResourceFromAttackPathName(attackPathName: string): string | number;
Parse the valued_resource from AttackPath resource.
Parameter | |
---|---|
Name | Description |
attackPathName |
string
A fully-qualified path representing AttackPath resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the valued_resource. |
matchValuedResourceFromValuedResourceName(valuedResourceName)
matchValuedResourceFromValuedResourceName(valuedResourceName: string): string | number;
Parse the valued_resource from ValuedResource resource.
Parameter | |
---|---|
Name | Description |
valuedResourceName |
string
A fully-qualified path representing ValuedResource resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the valued_resource. |
organizationAssetSecurityMarksPath(organization, asset)
organizationAssetSecurityMarksPath(organization: string, asset: string): string;
Return a fully-qualified organizationAssetSecurityMarks resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
asset |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationConstraintNamePath(organization, constraintName)
organizationConstraintNamePath(organization: string, constraintName: string): string;
Return a fully-qualified organizationConstraintName resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
constraintName |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationLocationExportPath(organization, location, exportParam)
organizationLocationExportPath(organization: string, location: string, exportParam: string): string;
Return a fully-qualified organizationLocationExport resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
exportParam |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationLocationMuteConfigPath(organization, location, muteConfig)
organizationLocationMuteConfigPath(organization: string, location: string, muteConfig: string): string;
Return a fully-qualified organizationLocationMuteConfig resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
muteConfig |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationLocationNotificationConfigPath(organization, location, notificationConfig)
organizationLocationNotificationConfigPath(organization: string, location: string, notificationConfig: string): string;
Return a fully-qualified organizationLocationNotificationConfig resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
location |
string
|
notificationConfig |
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. |
organizationMuteConfigPath(organization, muteConfig)
organizationMuteConfigPath(organization: string, muteConfig: string): string;
Return a fully-qualified organizationMuteConfig resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
muteConfig |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
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. |
organizationSourceFindingExternalsystemPath(organization, source, finding, externalsystem)
organizationSourceFindingExternalsystemPath(organization: string, source: string, finding: string, externalsystem: string): string;
Return a fully-qualified organizationSourceFindingExternalsystem resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
finding |
string
|
externalsystem |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationSourceFindingPath(organization, source, finding)
organizationSourceFindingPath(organization: string, source: string, finding: string): string;
Return a fully-qualified organizationSourceFinding resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationSourceFindingSecurityMarksPath(organization, source, finding)
organizationSourceFindingSecurityMarksPath(organization: string, source: string, finding: string): string;
Return a fully-qualified organizationSourceFindingSecurityMarks resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationSourceLocationFindingExternalsystemPath(organization, source, location, finding, externalsystem)
organizationSourceLocationFindingExternalsystemPath(organization: string, source: string, location: string, finding: string, externalsystem: string): string;
Return a fully-qualified organizationSourceLocationFindingExternalsystem resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
location |
string
|
finding |
string
|
externalsystem |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationSourceLocationFindingPath(organization, source, location, finding)
organizationSourceLocationFindingPath(organization: string, source: string, location: string, finding: string): string;
Return a fully-qualified organizationSourceLocationFinding resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
location |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationSourceLocationFindingSecurityMarksPath(organization, source, location, finding)
organizationSourceLocationFindingSecurityMarksPath(organization: string, source: string, location: string, finding: string): string;
Return a fully-qualified organizationSourceLocationFindingSecurityMarks resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
location |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
organizationSourcePath(organization, source)
organizationSourcePath(organization: string, source: string): string;
Return a fully-qualified organizationSource resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectAssetSecurityMarksPath(project, asset)
projectAssetSecurityMarksPath(project: string, asset: string): string;
Return a fully-qualified projectAssetSecurityMarks resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
asset |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectConstraintNamePath(project, constraintName)
projectConstraintNamePath(project: string, constraintName: string): string;
Return a fully-qualified projectConstraintName resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
constraintName |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectLocationExportPath(project, location, exportParam)
projectLocationExportPath(project: string, location: string, exportParam: string): string;
Return a fully-qualified projectLocationExport resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
exportParam |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectLocationMuteConfigPath(project, location, muteConfig)
projectLocationMuteConfigPath(project: string, location: string, muteConfig: string): string;
Return a fully-qualified projectLocationMuteConfig resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
muteConfig |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectLocationNotificationConfigPath(project, location, notificationConfig)
projectLocationNotificationConfigPath(project: string, location: string, notificationConfig: string): string;
Return a fully-qualified projectLocationNotificationConfig resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
notificationConfig |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectMuteConfigPath(project, muteConfig)
projectMuteConfigPath(project: string, muteConfig: string): string;
Return a fully-qualified projectMuteConfig resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
muteConfig |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectSourceFindingExternalsystemPath(project, source, finding, externalsystem)
projectSourceFindingExternalsystemPath(project: string, source: string, finding: string, externalsystem: string): string;
Return a fully-qualified projectSourceFindingExternalsystem resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
finding |
string
|
externalsystem |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectSourceFindingPath(project, source, finding)
projectSourceFindingPath(project: string, source: string, finding: string): string;
Return a fully-qualified projectSourceFinding resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectSourceFindingSecurityMarksPath(project, source, finding)
projectSourceFindingSecurityMarksPath(project: string, source: string, finding: string): string;
Return a fully-qualified projectSourceFindingSecurityMarks resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectSourceLocationFindingExternalsystemPath(project, source, location, finding, externalsystem)
projectSourceLocationFindingExternalsystemPath(project: string, source: string, location: string, finding: string, externalsystem: string): string;
Return a fully-qualified projectSourceLocationFindingExternalsystem resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
location |
string
|
finding |
string
|
externalsystem |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectSourceLocationFindingPath(project, source, location, finding)
projectSourceLocationFindingPath(project: string, source: string, location: string, finding: string): string;
Return a fully-qualified projectSourceLocationFinding resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
location |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectSourceLocationFindingSecurityMarksPath(project, source, location, finding)
projectSourceLocationFindingSecurityMarksPath(project: string, source: string, location: string, finding: string): string;
Return a fully-qualified projectSourceLocationFindingSecurityMarks resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
location |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectSourcePath(project, source)
projectSourcePath(project: string, source: string): string;
Return a fully-qualified projectSource resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
resourceValueConfigPath(organization, resourceValueConfig)
resourceValueConfigPath(organization: string, resourceValueConfig: string): string;
Return a fully-qualified resourceValueConfig resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
resourceValueConfig |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
setFindingState(request, options)
setFindingState(request?: protos.google.cloud.securitycenter.v2.ISetFindingStateRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IFinding,
protos.google.cloud.securitycenter.v2.ISetFindingStateRequest | undefined,
{} | undefined
]>;
Updates the state of a finding. If no location is specified, finding is assumed to be in global
Parameters | |
---|---|
Name | Description |
request |
ISetFindingStateRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IFinding,
protos.google.cloud.securitycenter.v2.ISetFindingStateRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The relative resource
* name (https://cloud.google.com/apis/design/resource_names#relative_resource_name)
* of the finding. If no location is specified, finding is assumed to be in
* global. The following list shows some examples:
* +
* `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`
* +
* `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`
* + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`
* +
* `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`
* + `projects/{project_id}/sources/{source_id}/findings/{finding_id}`
* +
* `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`
*/
// const name = 'abc123'
/**
* Required. The desired State of the finding.
*/
// const state = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callSetFindingState() {
// Construct request
const request = {
name,
state,
};
// Run request
const response = await securitycenterClient.setFindingState(request);
console.log(response);
}
callSetFindingState();
setFindingState(request, options, callback)
setFindingState(request: protos.google.cloud.securitycenter.v2.ISetFindingStateRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ISetFindingStateRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISetFindingStateRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ISetFindingStateRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
setFindingState(request, callback)
setFindingState(request: protos.google.cloud.securitycenter.v2.ISetFindingStateRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ISetFindingStateRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISetFindingStateRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ISetFindingStateRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
setIamPolicy(request, options)
setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.ISetIamPolicyRequest | undefined,
{} | undefined
]>;
Sets the access control policy on the specified Source.
Parameters | |
---|---|
Name | Description |
request |
ISetIamPolicyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.ISetIamPolicyRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size of
* the policy is limited to a few 10s of KB. An empty policy is a
* valid policy but certain Cloud Platform services (such as Projects)
* might reject them.
*/
// const policy = {}
/**
* OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
* the fields in the mask will be modified. If no mask is provided, the
* following default mask is used:
* `paths: "bindings, etag"`
*/
// const updateMask = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callSetIamPolicy() {
// Construct request
const request = {
resource,
policy,
};
// Run request
const response = await securitycenterClient.setIamPolicy(request);
console.log(response);
}
callSetIamPolicy();
setIamPolicy(request, options, callback)
setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISetIamPolicyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
setIamPolicy(request, callback)
setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISetIamPolicyRequest
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
setMute(request, options)
setMute(request?: protos.google.cloud.securitycenter.v2.ISetMuteRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IFinding,
protos.google.cloud.securitycenter.v2.ISetMuteRequest | undefined,
{} | undefined
]>;
Updates the mute state of a finding. If no location is specified, finding is assumed to be in global
Parameters | |
---|---|
Name | Description |
request |
ISetMuteRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IFinding,
protos.google.cloud.securitycenter.v2.ISetMuteRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The relative resource
* name (https://cloud.google.com/apis/design/resource_names#relative_resource_name)
* of the finding. If no location is specified, finding is assumed to be in
* global. The following list shows some examples:
* +
* `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`
* +
* `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`
* + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`
* +
* `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`
* + `projects/{project_id}/sources/{source_id}/findings/{finding_id}`
* +
* `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`
*/
// const name = 'abc123'
/**
* Required. The desired state of the Mute.
*/
// const mute = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callSetMute() {
// Construct request
const request = {
name,
mute,
};
// Run request
const response = await securitycenterClient.setMute(request);
console.log(response);
}
callSetMute();
setMute(request, options, callback)
setMute(request: protos.google.cloud.securitycenter.v2.ISetMuteRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ISetMuteRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISetMuteRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ISetMuteRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
setMute(request, callback)
setMute(request: protos.google.cloud.securitycenter.v2.ISetMuteRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ISetMuteRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISetMuteRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.ISetMuteRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
simulationPath(organization, simulation)
simulationPath(organization: string, simulation: string): string;
Return a fully-qualified simulation resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
simulation |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
testIamPermissions(request, options)
testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[
protos.google.iam.v1.ITestIamPermissionsResponse,
protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
{} | undefined
]>;
Returns the permissions that a caller has on the specified source.
Parameters | |
---|---|
Name | Description |
request |
ITestIamPermissionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.iam.v1.ITestIamPermissionsResponse,
protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
*/
// const permissions = ['abc','def']
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callTestIamPermissions() {
// Construct request
const request = {
resource,
permissions,
};
// Run request
const response = await securitycenterClient.testIamPermissions(request);
console.log(response);
}
callTestIamPermissions();
testIamPermissions(request, options, callback)
testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ITestIamPermissionsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
testIamPermissions(request, callback)
testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ITestIamPermissionsRequest
|
callback |
Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateBigQueryExport(request, options)
updateBigQueryExport(request?: protos.google.cloud.securitycenter.v2.IUpdateBigQueryExportRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IBigQueryExport,
(protos.google.cloud.securitycenter.v2.IUpdateBigQueryExportRequest | undefined),
{} | undefined
]>;
Updates a BigQuery export.
Parameters | |
---|---|
Name | Description |
request |
IUpdateBigQueryExportRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IBigQueryExport,
(protos.google.cloud.securitycenter.v2.IUpdateBigQueryExportRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing BigQueryExport. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The BigQuery export being updated.
*/
// const bigQueryExport = {}
/**
* The list of fields to be updated.
* If empty all mutable fields will be updated.
*/
// const updateMask = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callUpdateBigQueryExport() {
// Construct request
const request = {
bigQueryExport,
};
// Run request
const response = await securitycenterClient.updateBigQueryExport(request);
console.log(response);
}
callUpdateBigQueryExport();
updateBigQueryExport(request, options, callback)
updateBigQueryExport(request: protos.google.cloud.securitycenter.v2.IUpdateBigQueryExportRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.IUpdateBigQueryExportRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateBigQueryExportRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.IUpdateBigQueryExportRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateBigQueryExport(request, callback)
updateBigQueryExport(request: protos.google.cloud.securitycenter.v2.IUpdateBigQueryExportRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.IUpdateBigQueryExportRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateBigQueryExportRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IBigQueryExport, protos.google.cloud.securitycenter.v2.IUpdateBigQueryExportRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateExternalSystem(request, options)
updateExternalSystem(request?: protos.google.cloud.securitycenter.v2.IUpdateExternalSystemRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IExternalSystem,
(protos.google.cloud.securitycenter.v2.IUpdateExternalSystemRequest | undefined),
{} | undefined
]>;
Updates external system. This is for a given finding. If no location is specified, finding is assumed to be in global
Parameters | |
---|---|
Name | Description |
request |
IUpdateExternalSystemRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IExternalSystem,
(protos.google.cloud.securitycenter.v2.IUpdateExternalSystemRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The external system resource to update.
*/
// const externalSystem = {}
/**
* The FieldMask to use when updating the external system resource.
* If empty all mutable fields will be updated.
*/
// const updateMask = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callUpdateExternalSystem() {
// Construct request
const request = {
externalSystem,
};
// Run request
const response = await securitycenterClient.updateExternalSystem(request);
console.log(response);
}
callUpdateExternalSystem();
updateExternalSystem(request, options, callback)
updateExternalSystem(request: protos.google.cloud.securitycenter.v2.IUpdateExternalSystemRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IExternalSystem, protos.google.cloud.securitycenter.v2.IUpdateExternalSystemRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateExternalSystemRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IExternalSystem, protos.google.cloud.securitycenter.v2.IUpdateExternalSystemRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateExternalSystem(request, callback)
updateExternalSystem(request: protos.google.cloud.securitycenter.v2.IUpdateExternalSystemRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IExternalSystem, protos.google.cloud.securitycenter.v2.IUpdateExternalSystemRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateExternalSystemRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IExternalSystem, protos.google.cloud.securitycenter.v2.IUpdateExternalSystemRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateFinding(request, options)
updateFinding(request?: protos.google.cloud.securitycenter.v2.IUpdateFindingRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IFinding,
protos.google.cloud.securitycenter.v2.IUpdateFindingRequest | undefined,
{} | undefined
]>;
Creates or updates a finding. If no location is specified, finding is assumed to be in global. The corresponding source must exist for a finding creation to succeed.
Parameters | |
---|---|
Name | Description |
request |
IUpdateFindingRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IFinding,
protos.google.cloud.securitycenter.v2.IUpdateFindingRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The finding resource to update or create if it does not already
* exist. parent, security_marks, and update_time will be ignored.
* In the case of creation, the finding id portion of the name must be
* alphanumeric and less than or equal to 32 characters and greater than 0
* characters in length.
*/
// const finding = {}
/**
* The FieldMask to use when updating the finding resource. This field should
* not be specified when creating a finding.
* When updating a finding, an empty mask is treated as updating all mutable
* fields and replacing source_properties. Individual source_properties can
* be added/updated by using "source_properties.
updateFinding(request, options, callback)
updateFinding(request: protos.google.cloud.securitycenter.v2.IUpdateFindingRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.IUpdateFindingRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateFindingRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.IUpdateFindingRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateFinding(request, callback)
updateFinding(request: protos.google.cloud.securitycenter.v2.IUpdateFindingRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.IUpdateFindingRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateFindingRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IFinding, protos.google.cloud.securitycenter.v2.IUpdateFindingRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateMuteConfig(request, options)
updateMuteConfig(request?: protos.google.cloud.securitycenter.v2.IUpdateMuteConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IMuteConfig,
(protos.google.cloud.securitycenter.v2.IUpdateMuteConfigRequest | undefined),
{} | undefined
]>;
Updates a mute config. If no location is specified, default is global.
Parameters | |
---|---|
Name | Description |
request |
IUpdateMuteConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IMuteConfig,
(protos.google.cloud.securitycenter.v2.IUpdateMuteConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The mute config being updated.
*/
// const muteConfig = {}
/**
* The list of fields to be updated.
* If empty all mutable fields will be updated.
*/
// const updateMask = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callUpdateMuteConfig() {
// Construct request
const request = {
muteConfig,
};
// Run request
const response = await securitycenterClient.updateMuteConfig(request);
console.log(response);
}
callUpdateMuteConfig();
updateMuteConfig(request, options, callback)
updateMuteConfig(request: protos.google.cloud.securitycenter.v2.IUpdateMuteConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.IUpdateMuteConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateMuteConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.IUpdateMuteConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateMuteConfig(request, callback)
updateMuteConfig(request: protos.google.cloud.securitycenter.v2.IUpdateMuteConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.IUpdateMuteConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateMuteConfigRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IMuteConfig, protos.google.cloud.securitycenter.v2.IUpdateMuteConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateNotificationConfig(request, options)
updateNotificationConfig(request?: protos.google.cloud.securitycenter.v2.IUpdateNotificationConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.INotificationConfig,
(protos.google.cloud.securitycenter.v2.IUpdateNotificationConfigRequest | undefined),
{} | undefined
]>;
Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
Parameters | |
---|---|
Name | Description |
request |
IUpdateNotificationConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.INotificationConfig,
(protos.google.cloud.securitycenter.v2.IUpdateNotificationConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The notification config to update.
*/
// const notificationConfig = {}
/**
* The FieldMask to use when updating the notification config.
* If empty all mutable fields will be updated.
*/
// const updateMask = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callUpdateNotificationConfig() {
// Construct request
const request = {
notificationConfig,
};
// Run request
const response = await securitycenterClient.updateNotificationConfig(request);
console.log(response);
}
callUpdateNotificationConfig();
updateNotificationConfig(request, options, callback)
updateNotificationConfig(request: protos.google.cloud.securitycenter.v2.IUpdateNotificationConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.IUpdateNotificationConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateNotificationConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.IUpdateNotificationConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateNotificationConfig(request, callback)
updateNotificationConfig(request: protos.google.cloud.securitycenter.v2.IUpdateNotificationConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.IUpdateNotificationConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateNotificationConfigRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.INotificationConfig, protos.google.cloud.securitycenter.v2.IUpdateNotificationConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateResourceValueConfig(request, options)
updateResourceValueConfig(request?: protos.google.cloud.securitycenter.v2.IUpdateResourceValueConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.IResourceValueConfig,
(protos.google.cloud.securitycenter.v2.IUpdateResourceValueConfigRequest | undefined),
{} | undefined
]>;
Updates an existing ResourceValueConfigs with new rules.
Parameters | |
---|---|
Name | Description |
request |
IUpdateResourceValueConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.IResourceValueConfig,
(protos.google.cloud.securitycenter.v2.IUpdateResourceValueConfigRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource value config being updated.
*/
// const resourceValueConfig = {}
/**
* The list of fields to be updated.
* If empty all mutable fields will be updated.
*/
// const updateMask = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callUpdateResourceValueConfig() {
// Construct request
const request = {
resourceValueConfig,
};
// Run request
const response = await securitycenterClient.updateResourceValueConfig(request);
console.log(response);
}
callUpdateResourceValueConfig();
updateResourceValueConfig(request, options, callback)
updateResourceValueConfig(request: protos.google.cloud.securitycenter.v2.IUpdateResourceValueConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.IResourceValueConfig, protos.google.cloud.securitycenter.v2.IUpdateResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateResourceValueConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IResourceValueConfig, protos.google.cloud.securitycenter.v2.IUpdateResourceValueConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateResourceValueConfig(request, callback)
updateResourceValueConfig(request: protos.google.cloud.securitycenter.v2.IUpdateResourceValueConfigRequest, callback: Callback<protos.google.cloud.securitycenter.v2.IResourceValueConfig, protos.google.cloud.securitycenter.v2.IUpdateResourceValueConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateResourceValueConfigRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.IResourceValueConfig, protos.google.cloud.securitycenter.v2.IUpdateResourceValueConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateSecurityMarks(request, options)
updateSecurityMarks(request?: protos.google.cloud.securitycenter.v2.IUpdateSecurityMarksRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.ISecurityMarks,
(protos.google.cloud.securitycenter.v2.IUpdateSecurityMarksRequest | undefined),
{} | undefined
]>;
Updates security marks. For Finding Security marks, if no location is specified, finding is assumed to be in global. Assets Security Marks can only be accessed through global endpoint.
Parameters | |
---|---|
Name | Description |
request |
IUpdateSecurityMarksRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.ISecurityMarks,
(protos.google.cloud.securitycenter.v2.IUpdateSecurityMarksRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing SecurityMarks. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The security marks resource to update.
*/
// const securityMarks = {}
/**
* The FieldMask to use when updating the security marks resource.
* The field mask must not contain duplicate fields.
* If empty or set to "marks", all marks will be replaced. Individual
* marks can be updated using "marks.
updateSecurityMarks(request, options, callback)
updateSecurityMarks(request: protos.google.cloud.securitycenter.v2.IUpdateSecurityMarksRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.ISecurityMarks, protos.google.cloud.securitycenter.v2.IUpdateSecurityMarksRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateSecurityMarksRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.ISecurityMarks, protos.google.cloud.securitycenter.v2.IUpdateSecurityMarksRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateSecurityMarks(request, callback)
updateSecurityMarks(request: protos.google.cloud.securitycenter.v2.IUpdateSecurityMarksRequest, callback: Callback<protos.google.cloud.securitycenter.v2.ISecurityMarks, protos.google.cloud.securitycenter.v2.IUpdateSecurityMarksRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateSecurityMarksRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.ISecurityMarks, protos.google.cloud.securitycenter.v2.IUpdateSecurityMarksRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateSource(request, options)
updateSource(request?: protos.google.cloud.securitycenter.v2.IUpdateSourceRequest, options?: CallOptions): Promise<[
protos.google.cloud.securitycenter.v2.ISource,
protos.google.cloud.securitycenter.v2.IUpdateSourceRequest | undefined,
{} | undefined
]>;
Updates a source.
Parameters | |
---|---|
Name | Description |
request |
IUpdateSourceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.securitycenter.v2.ISource,
protos.google.cloud.securitycenter.v2.IUpdateSourceRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Source. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The source resource to update.
*/
// const source = {}
/**
* The FieldMask to use when updating the source resource.
* If empty all mutable fields will be updated.
*/
// const updateMask = {}
// Imports the Securitycenter library
const {SecurityCenterClient} = require('@google-cloud/securitycenter').v2;
// Instantiates a client
const securitycenterClient = new SecurityCenterClient();
async function callUpdateSource() {
// Construct request
const request = {
source,
};
// Run request
const response = await securitycenterClient.updateSource(request);
console.log(response);
}
callUpdateSource();
updateSource(request, options, callback)
updateSource(request: protos.google.cloud.securitycenter.v2.IUpdateSourceRequest, options: CallOptions, callback: Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.IUpdateSourceRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateSourceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.IUpdateSourceRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateSource(request, callback)
updateSource(request: protos.google.cloud.securitycenter.v2.IUpdateSourceRequest, callback: Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.IUpdateSourceRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateSourceRequest
|
callback |
Callback<protos.google.cloud.securitycenter.v2.ISource, protos.google.cloud.securitycenter.v2.IUpdateSourceRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
valuedResourcePath(organization, simulation, valuedResource)
valuedResourcePath(organization: string, simulation: string, valuedResource: string): string;
Return a fully-qualified valuedResource resource name string.
Parameters | |
---|---|
Name | Description |
organization |
string
|
simulation |
string
|
valuedResource |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |