Class protos.google.privacy.dlp.v2.Value

Represents a Value.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new Value.

Parameter
NameDescription
properties IValue

Properties to set

Properties

booleanValue

public booleanValue?: (boolean|null);

Value booleanValue.

dateValue

public dateValue?: (google.type.IDate|null);

Value dateValue.

dayOfWeekValue

public dayOfWeekValue?: (google.type.DayOfWeek|keyof typeof google.type.DayOfWeek|null);

Value dayOfWeekValue.

floatValue

public floatValue?: (number|null);

Value floatValue.

integerValue

public integerValue?: (number|Long|string|null);

Value integerValue.

stringValue

public stringValue?: (string|null);

Value stringValue.

timestampValue

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

Value timestampValue.

timeValue

public timeValue?: (google.type.ITimeOfDay|null);

Value timeValue.

type

public type?: ("integerValue"|"floatValue"|"stringValue"|"booleanValue"|"timestampValue"|"timeValue"|"dateValue"|"dayOfWeekValue");

Value type.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IValue): google.privacy.dlp.v2.Value;

Creates a new Value instance using the specified properties.

Parameter
NameDescription
properties IValue

Properties to set

Returns
TypeDescription
google.privacy.dlp.v2.Value

Value instance

decode(reader, length)

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

Decodes a Value 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.Value

Value

decodeDelimited(reader)

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

Decodes a Value 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.Value

Value

encode(message, writer)

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

Encodes the specified Value message. Does not implicitly messages.

Parameters
NameDescription
message IValue

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

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

Parameters
NameDescription
message IValue

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

Creates a Value 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.Value

Value

toJSON()

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

Converts this Value to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

Value

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