Class protos.google.privacy.dlp.v2.RedactImageRequest (3.4.0)

Represents a RedactImageRequest.

Package

Constructors

(constructor)(properties)

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

Constructs a new RedactImageRequest.

Parameter

Name	Description
properties	`google.privacy.dlp.v2.IRedactImageRequest` Properties to set

Properties

byteItem

public byteItem?: (google.privacy.dlp.v2.IByteContentItem|null);

RedactImageRequest byteItem.

imageRedactionConfigs

public imageRedactionConfigs: google.privacy.dlp.v2.RedactImageRequest.IImageRedactionConfig[];

RedactImageRequest imageRedactionConfigs.

includeFindings

public includeFindings: boolean;

RedactImageRequest includeFindings.

inspectConfig

public inspectConfig?: (google.privacy.dlp.v2.IInspectConfig|null);

RedactImageRequest inspectConfig.

locationId

public locationId: string;

RedactImageRequest locationId.

parent

public parent: string;

RedactImageRequest parent.

Methods

create(properties)

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

Creates a new RedactImageRequest instance using the specified properties.

Parameter

Name	Description
properties	`google.privacy.dlp.v2.IRedactImageRequest` Properties to set

Returns

Type	Description
google.privacy.dlp.v2.RedactImageRequest	RedactImageRequest instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified RedactImageRequest message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`google.privacy.dlp.v2.IRedactImageRequest` RedactImageRequest 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;

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

toJSON()

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

Converts this RedactImageRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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