Class protos.google.privacy.dlp.v2.DataProfileAction.PubSubNotification (4.2.0)

Represents a PubSubNotification.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.privacy.dlp.v2.DataProfileAction.IPubSubNotification);

Constructs a new PubSubNotification.

Parameter

Name	Description
properties	`IPubSubNotification` Properties to set

Properties

detailOfMessage

public detailOfMessage: (google.privacy.dlp.v2.DataProfileAction.PubSubNotification.DetailLevel|keyof typeof google.privacy.dlp.v2.DataProfileAction.PubSubNotification.DetailLevel);

PubSubNotification detailOfMessage.

event

public event: (google.privacy.dlp.v2.DataProfileAction.EventType|keyof typeof google.privacy.dlp.v2.DataProfileAction.EventType);

PubSubNotification event.

pubsubCondition

public pubsubCondition?: (google.privacy.dlp.v2.IDataProfilePubSubCondition|null);

PubSubNotification pubsubCondition.

topic

public topic: string;

PubSubNotification topic.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.DataProfileAction.IPubSubNotification): google.privacy.dlp.v2.DataProfileAction.PubSubNotification;

Creates a new PubSubNotification instance using the specified properties.

Parameter

Name	Description
properties	`IPubSubNotification` Properties to set

Returns

Type	Description
google.privacy.dlp.v2.DataProfileAction.PubSubNotification	PubSubNotification instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.privacy.dlp.v2.DataProfileAction.PubSubNotification;

Decodes a PubSubNotification 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.privacy.dlp.v2.DataProfileAction.PubSubNotification	PubSubNotification

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.privacy.dlp.v2.DataProfileAction.PubSubNotification;

Decodes a PubSubNotification 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.privacy.dlp.v2.DataProfileAction.PubSubNotification	PubSubNotification

encode(message, writer)

public static encode(message: google.privacy.dlp.v2.DataProfileAction.IPubSubNotification, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PubSubNotification message. Does not implicitly messages.

Parameters

Name	Description
message	`IPubSubNotification` PubSubNotification 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.privacy.dlp.v2.DataProfileAction.IPubSubNotification, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IPubSubNotification` PubSubNotification 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.privacy.dlp.v2.DataProfileAction.PubSubNotification;

Creates a PubSubNotification 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.privacy.dlp.v2.DataProfileAction.PubSubNotification	PubSubNotification

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PubSubNotification

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

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.privacy.dlp.v2.DataProfileAction.PubSubNotification, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`google.privacy.dlp.v2.DataProfileAction.PubSubNotification` PubSubNotification
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 PubSubNotification 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