Class protos.google.privacy.dlp.v2.Action (4.4.2)

Represents an Action.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new Action.

Parameter
NameDescription
properties IAction

Properties to set

Properties

action

public action?: ("saveFindings"|"pubSub"|"publishSummaryToCscc"|"publishFindingsToCloudDataCatalog"|"deidentify"|"jobNotificationEmails"|"publishToStackdriver");

Action action.

deidentify

public deidentify?: (google.privacy.dlp.v2.Action.IDeidentify|null);

Action deidentify.

jobNotificationEmails

public jobNotificationEmails?: (google.privacy.dlp.v2.Action.IJobNotificationEmails|null);

Action jobNotificationEmails.

publishFindingsToCloudDataCatalog

public publishFindingsToCloudDataCatalog?: (google.privacy.dlp.v2.Action.IPublishFindingsToCloudDataCatalog|null);

Action publishFindingsToCloudDataCatalog.

publishSummaryToCscc

public publishSummaryToCscc?: (google.privacy.dlp.v2.Action.IPublishSummaryToCscc|null);

Action publishSummaryToCscc.

publishToStackdriver

public publishToStackdriver?: (google.privacy.dlp.v2.Action.IPublishToStackdriver|null);

Action publishToStackdriver.

pubSub

public pubSub?: (google.privacy.dlp.v2.Action.IPublishToPubSub|null);

Action pubSub.

saveFindings

public saveFindings?: (google.privacy.dlp.v2.Action.ISaveFindings|null);

Action saveFindings.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IAction): google.privacy.dlp.v2.Action;

Creates a new Action instance using the specified properties.

Parameter
NameDescription
properties IAction

Properties to set

Returns
TypeDescription
google.privacy.dlp.v2.Action

Action instance

decode(reader, length)

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

Decodes an Action message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.privacy.dlp.v2.Action

Action

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.privacy.dlp.v2.Action

Action

encode(message, writer)

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

Encodes the specified Action message. Does not implicitly messages.

Parameters
NameDescription
message IAction

Action 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.privacy.dlp.v2.IAction, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IAction

Action 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.privacy.dlp.v2.Action;

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

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

Plain object

Returns
TypeDescription
google.privacy.dlp.v2.Action

Action

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Action

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.privacy.dlp.v2.Action

Action

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an Action 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