Represents a Finding.
Package
@google-cloud/security-centerConstructors
(constructor)(properties)
constructor(properties?: google.cloud.securitycenter.v2.IFinding);Constructs a new Finding.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFinding
Properties to set |
Properties
access
public access?: (google.cloud.securitycenter.v2.IAccess|null);Finding access.
application
public application?: (google.cloud.securitycenter.v2.IApplication|null);Finding application.
attackExposure
public attackExposure?: (google.cloud.securitycenter.v2.IAttackExposure|null);Finding attackExposure.
backupDisasterRecovery
public backupDisasterRecovery?: (google.cloud.securitycenter.v2.IBackupDisasterRecovery|null);Finding backupDisasterRecovery.
canonicalName
public canonicalName: string;Finding canonicalName.
category
public category: string;Finding category.
cloudArmor
public cloudArmor?: (google.cloud.securitycenter.v2.ICloudArmor|null);Finding cloudArmor.
cloudDlpDataProfile
public cloudDlpDataProfile?: (google.cloud.securitycenter.v2.ICloudDlpDataProfile|null);Finding cloudDlpDataProfile.
cloudDlpInspection
public cloudDlpInspection?: (google.cloud.securitycenter.v2.ICloudDlpInspection|null);Finding cloudDlpInspection.
compliances
public compliances: google.cloud.securitycenter.v2.ICompliance[];Finding compliances.
connections
public connections: google.cloud.securitycenter.v2.IConnection[];Finding connections.
contacts
public contacts: { [k: string]: google.cloud.securitycenter.v2.IContactDetails };Finding contacts.
containers
public containers: google.cloud.securitycenter.v2.IContainer[];Finding containers.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Finding createTime.
database
public database?: (google.cloud.securitycenter.v2.IDatabase|null);Finding database.
description
public description: string;Finding description.
eventTime
public eventTime?: (google.protobuf.ITimestamp|null);Finding eventTime.
exfiltration
public exfiltration?: (google.cloud.securitycenter.v2.IExfiltration|null);Finding exfiltration.
externalSystems
public externalSystems: { [k: string]: google.cloud.securitycenter.v2.IExternalSystem };Finding externalSystems.
externalUri
public externalUri: string;Finding externalUri.
files
public files: google.cloud.securitycenter.v2.IFile[];Finding files.
findingClass
public findingClass: (google.cloud.securitycenter.v2.Finding.FindingClass|keyof typeof google.cloud.securitycenter.v2.Finding.FindingClass);Finding findingClass.
groupMemberships
public groupMemberships: google.cloud.securitycenter.v2.IGroupMembership[];Finding groupMemberships.
iamBindings
public iamBindings: google.cloud.securitycenter.v2.IIamBinding[];Finding iamBindings.
indicator
public indicator?: (google.cloud.securitycenter.v2.IIndicator|null);Finding indicator.
kernelRootkit
public kernelRootkit?: (google.cloud.securitycenter.v2.IKernelRootkit|null);Finding kernelRootkit.
kubernetes
public kubernetes?: (google.cloud.securitycenter.v2.IKubernetes|null);Finding kubernetes.
loadBalancers
public loadBalancers: google.cloud.securitycenter.v2.ILoadBalancer[];Finding loadBalancers.
logEntries
public logEntries: google.cloud.securitycenter.v2.ILogEntry[];Finding logEntries.
mitreAttack
public mitreAttack?: (google.cloud.securitycenter.v2.IMitreAttack|null);Finding mitreAttack.
moduleName
public moduleName: string;Finding moduleName.
mute
public mute: (google.cloud.securitycenter.v2.Finding.Mute|keyof typeof google.cloud.securitycenter.v2.Finding.Mute);Finding mute.
muteInitiator
public muteInitiator: string;Finding muteInitiator.
muteUpdateTime
public muteUpdateTime?: (google.protobuf.ITimestamp|null);Finding muteUpdateTime.
name
public name: string;Finding name.
nextSteps
public nextSteps: string;Finding nextSteps.
notebook
public notebook?: (google.cloud.securitycenter.v2.INotebook|null);Finding notebook.
orgPolicies
public orgPolicies: google.cloud.securitycenter.v2.IOrgPolicy[];Finding orgPolicies.
parent
public parent: string;Finding parent.
parentDisplayName
public parentDisplayName: string;Finding parentDisplayName.
processes
public processes: google.cloud.securitycenter.v2.IProcess[];Finding processes.
resourceName
public resourceName: string;Finding resourceName.
securityMarks
public securityMarks?: (google.cloud.securitycenter.v2.ISecurityMarks|null);Finding securityMarks.
securityPosture
public securityPosture?: (google.cloud.securitycenter.v2.ISecurityPosture|null);Finding securityPosture.
severity
public severity: (google.cloud.securitycenter.v2.Finding.Severity|keyof typeof google.cloud.securitycenter.v2.Finding.Severity);Finding severity.
sourceProperties
public sourceProperties: { [k: string]: google.protobuf.IValue };Finding sourceProperties.
state
public state: (google.cloud.securitycenter.v2.Finding.State|keyof typeof google.cloud.securitycenter.v2.Finding.State);Finding state.
toxicCombination
public toxicCombination?: (google.cloud.securitycenter.v2.IToxicCombination|null);Finding toxicCombination.
vulnerability
public vulnerability?: (google.cloud.securitycenter.v2.IVulnerability|null);Finding vulnerability.
Methods
create(properties)
public static create(properties?: google.cloud.securitycenter.v2.IFinding): google.cloud.securitycenter.v2.Finding;Creates a new Finding instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFinding
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Finding |
Finding instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.securitycenter.v2.Finding;Decodes a Finding message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Finding |
Finding |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.securitycenter.v2.Finding;Decodes a Finding message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Finding |
Finding |
encode(message, writer)
public static encode(message: google.cloud.securitycenter.v2.IFinding, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Finding message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFinding
Finding message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.securitycenter.v2.IFinding, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Finding message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFinding
Finding message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.securitycenter.v2.Finding;Creates a Finding message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Finding |
Finding |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Finding
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Finding to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.securitycenter.v2.Finding, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Finding message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Finding
Finding |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Finding message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|