Class protos.google.privacy.dlp.v2.DiscoveryConfig (5.3.0)

Represents a DiscoveryConfig.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new DiscoveryConfig.

Parameter
NameDescription
properties IDiscoveryConfig

Properties to set

Properties

actions

public actions: google.privacy.dlp.v2.IDataProfileAction[];

DiscoveryConfig actions.

createTime

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

DiscoveryConfig createTime.

displayName

public displayName: string;

DiscoveryConfig displayName.

errors

public errors: google.privacy.dlp.v2.IError[];

DiscoveryConfig errors.

inspectTemplates

public inspectTemplates: string[];

DiscoveryConfig inspectTemplates.

lastRunTime

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

DiscoveryConfig lastRunTime.

name

public name: string;

DiscoveryConfig name.

orgConfig

public orgConfig?: (google.privacy.dlp.v2.DiscoveryConfig.IOrgConfig|null);

DiscoveryConfig orgConfig.

status

public status: (google.privacy.dlp.v2.DiscoveryConfig.Status|keyof typeof google.privacy.dlp.v2.DiscoveryConfig.Status);

DiscoveryConfig status.

targets

public targets: google.privacy.dlp.v2.IDiscoveryTarget[];

DiscoveryConfig targets.

updateTime

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

DiscoveryConfig updateTime.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IDiscoveryConfig): google.privacy.dlp.v2.DiscoveryConfig;

Creates a new DiscoveryConfig instance using the specified properties.

Parameter
NameDescription
properties IDiscoveryConfig

Properties to set

Returns
TypeDescription
DiscoveryConfig

DiscoveryConfig instance

decode(reader, length)

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

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

DiscoveryConfig

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
DiscoveryConfig

DiscoveryConfig

encode(message, writer)

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

Encodes the specified DiscoveryConfig message. Does not implicitly messages.

Parameters
NameDescription
message IDiscoveryConfig

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

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

Parameters
NameDescription
message IDiscoveryConfig

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

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

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

Plain object

Returns
TypeDescription
DiscoveryConfig

DiscoveryConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DiscoveryConfig

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message DiscoveryConfig

DiscoveryConfig

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