Class protos.google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule (0.3.0)

Represents an EffectiveEventThreatDetectionCustomModule.

Package

@google-cloud/securitycentermanagement

Constructors

(constructor)(properties)

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

Constructs a new EffectiveEventThreatDetectionCustomModule.

Parameter
Name Description
properties IEffectiveEventThreatDetectionCustomModule

Properties to set

Properties

config

public config?: (google.protobuf.IStruct|null);

EffectiveEventThreatDetectionCustomModule config.

description

public description: string;

EffectiveEventThreatDetectionCustomModule description.

displayName

public displayName: string;

EffectiveEventThreatDetectionCustomModule displayName.

enablementState

public enablementState: (google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule.EnablementState|keyof typeof google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule.EnablementState);

EffectiveEventThreatDetectionCustomModule enablementState.

name

public name: string;

EffectiveEventThreatDetectionCustomModule name.

type

public type: string;

EffectiveEventThreatDetectionCustomModule type.

Methods

create(properties)

public static create(properties?: google.cloud.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule): google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule;

Creates a new EffectiveEventThreatDetectionCustomModule instance using the specified properties.

Parameter
Name Description
properties IEffectiveEventThreatDetectionCustomModule

Properties to set

Returns
Type Description
EffectiveEventThreatDetectionCustomModule

EffectiveEventThreatDetectionCustomModule instance

decode(reader, length)

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

Decodes an EffectiveEventThreatDetectionCustomModule 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
EffectiveEventThreatDetectionCustomModule

EffectiveEventThreatDetectionCustomModule

decodeDelimited(reader)

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

Decodes an EffectiveEventThreatDetectionCustomModule message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
EffectiveEventThreatDetectionCustomModule

EffectiveEventThreatDetectionCustomModule

encode(message, writer)

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

Encodes the specified EffectiveEventThreatDetectionCustomModule message. Does not implicitly messages.

Parameters
Name Description
message IEffectiveEventThreatDetectionCustomModule

EffectiveEventThreatDetectionCustomModule 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.securitycentermanagement.v1.IEffectiveEventThreatDetectionCustomModule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IEffectiveEventThreatDetectionCustomModule

EffectiveEventThreatDetectionCustomModule 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.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule;

Creates an EffectiveEventThreatDetectionCustomModule 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
EffectiveEventThreatDetectionCustomModule

EffectiveEventThreatDetectionCustomModule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EffectiveEventThreatDetectionCustomModule

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 EffectiveEventThreatDetectionCustomModule to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message EffectiveEventThreatDetectionCustomModule

EffectiveEventThreatDetectionCustomModule

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 an EffectiveEventThreatDetectionCustomModule message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not