Class protos.google.cloud.securitycentermanagement.v1.SimulatedFinding (0.1.0)

Represents a SimulatedFinding.

Package

@google-cloud/securitycentermanagement

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.securitycentermanagement.v1.ISimulatedFinding);

Constructs a new SimulatedFinding.

Parameter
NameDescription
properties ISimulatedFinding

Properties to set

Properties

category

public category: string;

SimulatedFinding category.

eventTime

public eventTime?: (google.protobuf.ITimestamp|null);

SimulatedFinding eventTime.

findingClass

public findingClass: (google.cloud.securitycentermanagement.v1.SimulatedFinding.FindingClass|keyof typeof google.cloud.securitycentermanagement.v1.SimulatedFinding.FindingClass);

SimulatedFinding findingClass.

name

public name: string;

SimulatedFinding name.

parent

public parent: string;

SimulatedFinding parent.

resourceName

public resourceName: string;

SimulatedFinding resourceName.

severity

public severity: (google.cloud.securitycentermanagement.v1.SimulatedFinding.Severity|keyof typeof google.cloud.securitycentermanagement.v1.SimulatedFinding.Severity);

SimulatedFinding severity.

sourceProperties

public sourceProperties: { [k: string]: google.protobuf.IValue };

SimulatedFinding sourceProperties.

state

public state: (google.cloud.securitycentermanagement.v1.SimulatedFinding.State|keyof typeof google.cloud.securitycentermanagement.v1.SimulatedFinding.State);

SimulatedFinding state.

Methods

create(properties)

public static create(properties?: google.cloud.securitycentermanagement.v1.ISimulatedFinding): google.cloud.securitycentermanagement.v1.SimulatedFinding;

Creates a new SimulatedFinding instance using the specified properties.

Parameter
NameDescription
properties ISimulatedFinding

Properties to set

Returns
TypeDescription
SimulatedFinding

SimulatedFinding instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.securitycentermanagement.v1.SimulatedFinding;

Decodes a SimulatedFinding message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
SimulatedFinding

SimulatedFinding

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.securitycentermanagement.v1.SimulatedFinding;

Decodes a SimulatedFinding message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SimulatedFinding

SimulatedFinding

encode(message, writer)

public static encode(message: google.cloud.securitycentermanagement.v1.ISimulatedFinding, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SimulatedFinding message. Does not implicitly messages.

Parameters
NameDescription
message ISimulatedFinding

SimulatedFinding message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.securitycentermanagement.v1.ISimulatedFinding, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SimulatedFinding message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message ISimulatedFinding

SimulatedFinding message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.securitycentermanagement.v1.SimulatedFinding;

Creates a SimulatedFinding message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
SimulatedFinding

SimulatedFinding

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SimulatedFinding

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this SimulatedFinding to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.securitycentermanagement.v1.SimulatedFinding, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a SimulatedFinding message. Also converts values to other types if specified.

Parameters
NameDescription
message SimulatedFinding

SimulatedFinding

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SimulatedFinding message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not