Class protos.google.cloud.optimization.v1.Shipment.Load (2.1.1)

Stay organized with collections Save and categorize content based on your preferences.

Represents a Load.

Package

@google-cloud/optimization

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.optimization.v1.Shipment.ILoad);

Constructs a new Load.

Parameter
NameDescription
properties ILoad

Properties to set

Properties

amount

public amount: (number|Long|string);

Load amount.

Methods

create(properties)

public static create(properties?: google.cloud.optimization.v1.Shipment.ILoad): google.cloud.optimization.v1.Shipment.Load;

Creates a new Load instance using the specified properties.

Parameter
NameDescription
properties ILoad

Properties to set

Returns
TypeDescription
google.cloud.optimization.v1.Shipment.Load

Load instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.optimization.v1.Shipment.Load;

Decodes a Load 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.cloud.optimization.v1.Shipment.Load

Load

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.optimization.v1.Shipment.Load;

Decodes a Load message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.optimization.v1.Shipment.Load

Load

encode(message, writer)

public static encode(message: google.cloud.optimization.v1.Shipment.ILoad, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Load message. Does not implicitly messages.

Parameters
NameDescription
message ILoad

Load 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.cloud.optimization.v1.Shipment.ILoad, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ILoad

Load 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.cloud.optimization.v1.Shipment.Load;

Creates a Load message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.optimization.v1.Shipment.Load

Load

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Load

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Load to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.optimization.v1.Shipment.Load, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.cloud.optimization.v1.Shipment.Load

Load

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