Represents a Finding.
Package
@google-cloud/security-centerConstructors
(constructor)(properties)
constructor(properties?: google.cloud.securitycenter.v1p1beta1.IFinding);Constructs a new Finding.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFinding
Properties to set |
Properties
canonicalName
public canonicalName: string;Finding canonicalName.
category
public category: string;Finding category.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Finding createTime.
eventTime
public eventTime?: (google.protobuf.ITimestamp|null);Finding eventTime.
externalUri
public externalUri: string;Finding externalUri.
name
public name: string;Finding name.
parent
public parent: string;Finding parent.
resourceName
public resourceName: string;Finding resourceName.
securityMarks
public securityMarks?: (google.cloud.securitycenter.v1p1beta1.ISecurityMarks|null);Finding securityMarks.
severity
public severity: (google.cloud.securitycenter.v1p1beta1.Finding.Severity|keyof typeof google.cloud.securitycenter.v1p1beta1.Finding.Severity);Finding severity.
sourceProperties
public sourceProperties: { [k: string]: google.protobuf.IValue };Finding sourceProperties.
state
public state: (google.cloud.securitycenter.v1p1beta1.Finding.State|keyof typeof google.cloud.securitycenter.v1p1beta1.Finding.State);Finding state.
Methods
create(properties)
public static create(properties?: google.cloud.securitycenter.v1p1beta1.IFinding): google.cloud.securitycenter.v1p1beta1.Finding;Creates a new Finding instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFinding
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.securitycenter.v1p1beta1.Finding | Finding instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.securitycenter.v1p1beta1.Finding;Decodes a Finding message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.cloud.securitycenter.v1p1beta1.Finding | Finding |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.securitycenter.v1p1beta1.Finding;Decodes a Finding message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.cloud.securitycenter.v1p1beta1.Finding | Finding |
encode(message, writer)
public static encode(message: google.cloud.securitycenter.v1p1beta1.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.v1p1beta1.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.v1p1beta1.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 |
google.cloud.securitycenter.v1p1beta1.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.v1p1beta1.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 |
google.cloud.securitycenter.v1p1beta1.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) |
|