Class protos.google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule (0.4.0)

Represents a SecurityHealthAnalyticsCustomModule.

Package

@google-cloud/securitycentermanagement

Constructors

(constructor)(properties)

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

Constructs a new SecurityHealthAnalyticsCustomModule.

Parameter
Name Description
properties ISecurityHealthAnalyticsCustomModule

Properties to set

Properties

ancestorModule

public ancestorModule: string;

SecurityHealthAnalyticsCustomModule ancestorModule.

customConfig

public customConfig?: (google.cloud.securitycentermanagement.v1.ICustomConfig|null);

SecurityHealthAnalyticsCustomModule customConfig.

displayName

public displayName: string;

SecurityHealthAnalyticsCustomModule displayName.

enablementState

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

SecurityHealthAnalyticsCustomModule enablementState.

lastEditor

public lastEditor: string;

SecurityHealthAnalyticsCustomModule lastEditor.

name

public name: string;

SecurityHealthAnalyticsCustomModule name.

updateTime

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

SecurityHealthAnalyticsCustomModule updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.securitycentermanagement.v1.ISecurityHealthAnalyticsCustomModule): google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule;

Creates a new SecurityHealthAnalyticsCustomModule instance using the specified properties.

Parameter
Name Description
properties ISecurityHealthAnalyticsCustomModule

Properties to set

Returns
Type Description
SecurityHealthAnalyticsCustomModule

SecurityHealthAnalyticsCustomModule instance

decode(reader, length)

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

Decodes a SecurityHealthAnalyticsCustomModule 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
SecurityHealthAnalyticsCustomModule

SecurityHealthAnalyticsCustomModule

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SecurityHealthAnalyticsCustomModule

SecurityHealthAnalyticsCustomModule

encode(message, writer)

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

Encodes the specified SecurityHealthAnalyticsCustomModule message. Does not implicitly messages.

Parameters
Name Description
message ISecurityHealthAnalyticsCustomModule

SecurityHealthAnalyticsCustomModule 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.ISecurityHealthAnalyticsCustomModule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISecurityHealthAnalyticsCustomModule

SecurityHealthAnalyticsCustomModule 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.SecurityHealthAnalyticsCustomModule;

Creates a SecurityHealthAnalyticsCustomModule 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
SecurityHealthAnalyticsCustomModule

SecurityHealthAnalyticsCustomModule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SecurityHealthAnalyticsCustomModule

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SecurityHealthAnalyticsCustomModule

SecurityHealthAnalyticsCustomModule

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 SecurityHealthAnalyticsCustomModule 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