Class protos.google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig (3.2.1)

Represents an ImageRedactionConfig.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new ImageRedactionConfig.

Parameter
Name Description
properties IImageRedactionConfig

Properties to set

Properties

infoType

public infoType?: (google.privacy.dlp.v2.IInfoType|null);

ImageRedactionConfig infoType.

redactAllText

public redactAllText?: (boolean|null);

ImageRedactionConfig redactAllText.

redactionColor

public redactionColor?: (google.privacy.dlp.v2.IColor|null);

ImageRedactionConfig redactionColor.

target

public target?: ("infoType"|"redactAllText");

ImageRedactionConfig target.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.RedactImageRequest.IImageRedactionConfig): google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig;

Creates a new ImageRedactionConfig instance using the specified properties.

Parameter
Name Description
properties IImageRedactionConfig

Properties to set
Returns
Type Description
google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig

ImageRedactionConfig instance

decode(reader, length)

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

Decodes an ImageRedactionConfig 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.RedactImageRequest.ImageRedactionConfig

ImageRedactionConfig

decodeDelimited(reader)

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

Decodes an ImageRedactionConfig 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.RedactImageRequest.ImageRedactionConfig

ImageRedactionConfig

encode(message, writer)

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

Encodes the specified ImageRedactionConfig message. Does not implicitly messages.

Parameters
Name Description
message IImageRedactionConfig

ImageRedactionConfig 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.RedactImageRequest.IImageRedactionConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IImageRedactionConfig

ImageRedactionConfig 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.RedactImageRequest.ImageRedactionConfig;

Creates an ImageRedactionConfig 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.RedactImageRequest.ImageRedactionConfig

ImageRedactionConfig

toJSON()

public toJSON(): { [k: string]: any };

Converts this ImageRedactionConfig to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig

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