Represents a Weight.
Package
@google-shopping/notificationsConstructors
(constructor)(properties)
constructor(properties?: google.shopping.type.IWeight);
Constructs a new Weight.
Parameter | |
---|---|
Name | Description |
properties |
IWeight
Properties to set |
Properties
_amountMicros
public _amountMicros?: "amountMicros";
Weight _amountMicros.
amountMicros
public amountMicros?: (number|Long|string|null);
Weight amountMicros.
unit
public unit: (google.shopping.type.Weight.WeightUnit|keyof typeof google.shopping.type.Weight.WeightUnit);
Weight unit.
Methods
create(properties)
public static create(properties?: google.shopping.type.IWeight): google.shopping.type.Weight;
Creates a new Weight instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IWeight
Properties to set |
Returns | |
---|---|
Type | Description |
Weight |
Weight instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.type.Weight;
Decodes a Weight message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
Weight |
Weight |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.type.Weight;
Decodes a Weight message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Weight |
Weight |
encode(message, writer)
public static encode(message: google.shopping.type.IWeight, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Weight message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IWeight
Weight 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.shopping.type.IWeight, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Weight message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IWeight
Weight 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.shopping.type.Weight;
Creates a Weight 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 |
Weight |
Weight |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Weight
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Weight to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.shopping.type.Weight, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Weight message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Weight
Weight |
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 Weight message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|