Class protos.google.maps.routeoptimization.v1.TimeWindow (0.2.0)

Represents a TimeWindow.

Package

@googlemaps/routeoptimization

Constructors

(constructor)(properties)

constructor(properties?: google.maps.routeoptimization.v1.ITimeWindow);

Constructs a new TimeWindow.

Parameter
Name Description
properties ITimeWindow

Properties to set

Properties

_costPerHourAfterSoftEndTime

public _costPerHourAfterSoftEndTime?: "costPerHourAfterSoftEndTime";

TimeWindow _costPerHourAfterSoftEndTime.

_costPerHourBeforeSoftStartTime

public _costPerHourBeforeSoftStartTime?: "costPerHourBeforeSoftStartTime";

TimeWindow _costPerHourBeforeSoftStartTime.

costPerHourAfterSoftEndTime

public costPerHourAfterSoftEndTime?: (number|null);

TimeWindow costPerHourAfterSoftEndTime.

costPerHourBeforeSoftStartTime

public costPerHourBeforeSoftStartTime?: (number|null);

TimeWindow costPerHourBeforeSoftStartTime.

endTime

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

TimeWindow endTime.

softEndTime

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

TimeWindow softEndTime.

softStartTime

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

TimeWindow softStartTime.

startTime

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

TimeWindow startTime.

Methods

create(properties)

public static create(properties?: google.maps.routeoptimization.v1.ITimeWindow): google.maps.routeoptimization.v1.TimeWindow;

Creates a new TimeWindow instance using the specified properties.

Parameter
Name Description
properties ITimeWindow

Properties to set

Returns
Type Description
TimeWindow

TimeWindow instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.routeoptimization.v1.TimeWindow;

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

TimeWindow

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.routeoptimization.v1.TimeWindow;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
TimeWindow

TimeWindow

encode(message, writer)

public static encode(message: google.maps.routeoptimization.v1.ITimeWindow, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TimeWindow message. Does not implicitly messages.

Parameters
Name Description
message ITimeWindow

TimeWindow 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.maps.routeoptimization.v1.ITimeWindow, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ITimeWindow

TimeWindow 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.maps.routeoptimization.v1.TimeWindow;

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

TimeWindow

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TimeWindow

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 TimeWindow to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.maps.routeoptimization.v1.TimeWindow, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message TimeWindow

TimeWindow

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