Represents a Value.
Package
@google-cloud/retailConstructors
(constructor)(properties)
constructor(properties?: google.protobuf.IValue);Constructs a new Value.
| Name | Description |
| properties |
IValue
Properties to set |
Properties
boolValue
public boolValue?: (boolean|null);Value boolValue.
kind
public kind?: ("nullValue"|"numberValue"|"stringValue"|"boolValue"|"structValue"|"listValue");Value kind.
listValue
public listValue?: (google.protobuf.IListValue|null);Value listValue.
nullValue
public nullValue?: (google.protobuf.NullValue|keyof typeof google.protobuf.NullValue|null);Value nullValue.
numberValue
public numberValue?: (number|null);Value numberValue.
stringValue
public stringValue?: (string|null);Value stringValue.
structValue
public structValue?: (google.protobuf.IStruct|null);Value structValue.
Methods
create(properties)
public static create(properties?: google.protobuf.IValue): google.protobuf.Value;Creates a new Value instance using the specified properties.
| Name | Description |
| properties |
IValue
Properties to set |
| Type | Description |
| google.protobuf.Value | Value instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.protobuf.Value;Decodes a Value message from the specified reader or buffer.
| Name | Description |
| reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| length |
number
Message length if known beforehand |
| Type | Description |
| google.protobuf.Value | Value |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.protobuf.Value;Decodes a Value message from the specified reader or buffer, length delimited.
| Name | Description |
| reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Type | Description |
| google.protobuf.Value | Value |
encode(message, writer)
public static encode(message: google.protobuf.IValue, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Value message. Does not implicitly messages.
| Name | Description |
| message |
IValue
Value message or plain object to encode |
| writer |
$protobuf.Writer
Writer to encode to |
| Type | Description |
| $protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.protobuf.IValue, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Value message, length delimited. Does not implicitly messages.
| Name | Description |
| message |
IValue
Value message or plain object to encode |
| writer |
$protobuf.Writer
Writer to encode to |
| Type | Description |
| $protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.protobuf.Value;Creates a Value message from a plain object. Also converts values to their respective internal types.
| Name | Description |
| object |
{ [k: string]: any }
Plain object |
| Type | Description |
| google.protobuf.Value | Value |
toJSON()
public toJSON(): { [k: string]: any };Converts this Value to JSON.
| Type | Description |
| { [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.protobuf.Value, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Value message. Also converts values to other types if specified.
| Name | Description |
| message |
google.protobuf.Value
Value |
| options |
$protobuf.IConversionOptions
Conversion options |
| Type | Description |
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Value message.
| Name | Description |
| message |
{ [k: string]: any }
Plain object to verify |
| Type | Description |
| (string|null) |
|