Class protos.google.cloud.optimization.v1.OptimizeToursRequest (2.2.2)

Represents an OptimizeToursRequest.

Package

@google-cloud/optimization

Constructors

(constructor)(properties)

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

Constructs a new OptimizeToursRequest.

Parameter
NameDescription
properties google.cloud.optimization.v1.IOptimizeToursRequest

Properties to set

Properties

_geodesicMetersPerSecond

public _geodesicMetersPerSecond?: "geodesicMetersPerSecond";

OptimizeToursRequest _geodesicMetersPerSecond.

_maxValidationErrors

public _maxValidationErrors?: "maxValidationErrors";

OptimizeToursRequest _maxValidationErrors.

allowLargeDeadlineDespiteInterruptionRisk

public allowLargeDeadlineDespiteInterruptionRisk: boolean;

OptimizeToursRequest allowLargeDeadlineDespiteInterruptionRisk.

considerRoadTraffic

public considerRoadTraffic: boolean;

OptimizeToursRequest considerRoadTraffic.

geodesicMetersPerSecond

public geodesicMetersPerSecond?: (number|null);

OptimizeToursRequest geodesicMetersPerSecond.

injectedFirstSolutionRoutes

public injectedFirstSolutionRoutes: google.cloud.optimization.v1.IShipmentRoute[];

OptimizeToursRequest injectedFirstSolutionRoutes.

injectedSolutionConstraint

public injectedSolutionConstraint?: (google.cloud.optimization.v1.IInjectedSolutionConstraint|null);

OptimizeToursRequest injectedSolutionConstraint.

interpretInjectedSolutionsUsingLabels

public interpretInjectedSolutionsUsingLabels: boolean;

OptimizeToursRequest interpretInjectedSolutionsUsingLabels.

label

public label: string;

OptimizeToursRequest label.

maxValidationErrors

public maxValidationErrors?: (number|null);

OptimizeToursRequest maxValidationErrors.

model

public model?: (google.cloud.optimization.v1.IShipmentModel|null);

OptimizeToursRequest model.

parent

public parent: string;

OptimizeToursRequest parent.

populatePolylines

public populatePolylines: boolean;

OptimizeToursRequest populatePolylines.

populateTransitionPolylines

public populateTransitionPolylines: boolean;

OptimizeToursRequest populateTransitionPolylines.

populateTravelStepPolylines

public populateTravelStepPolylines: boolean;

OptimizeToursRequest populateTravelStepPolylines.

refreshDetailsRoutes

public refreshDetailsRoutes: google.cloud.optimization.v1.IShipmentRoute[];

OptimizeToursRequest refreshDetailsRoutes.

searchMode

public searchMode: (google.cloud.optimization.v1.OptimizeToursRequest.SearchMode|keyof typeof google.cloud.optimization.v1.OptimizeToursRequest.SearchMode);

OptimizeToursRequest searchMode.

solvingMode

public solvingMode: (google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode|keyof typeof google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode);

OptimizeToursRequest solvingMode.

timeout

public timeout?: (google.protobuf.IDuration|null);

OptimizeToursRequest timeout.

useGeodesicDistances

public useGeodesicDistances: boolean;

OptimizeToursRequest useGeodesicDistances.

Methods

create(properties)

public static create(properties?: google.cloud.optimization.v1.IOptimizeToursRequest): google.cloud.optimization.v1.OptimizeToursRequest;

Creates a new OptimizeToursRequest instance using the specified properties.

Parameter
NameDescription
properties google.cloud.optimization.v1.IOptimizeToursRequest

Properties to set

Returns
TypeDescription
google.cloud.optimization.v1.OptimizeToursRequest

OptimizeToursRequest instance

decode(reader, length)

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

Decodes an OptimizeToursRequest 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.OptimizeToursRequest

OptimizeToursRequest

decodeDelimited(reader)

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

Decodes an OptimizeToursRequest 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.OptimizeToursRequest

OptimizeToursRequest

encode(message, writer)

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

Encodes the specified OptimizeToursRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.cloud.optimization.v1.IOptimizeToursRequest

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

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

Parameters
NameDescription
message google.cloud.optimization.v1.IOptimizeToursRequest

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

Creates an OptimizeToursRequest 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.OptimizeToursRequest

OptimizeToursRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for OptimizeToursRequest

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.optimization.v1.OptimizeToursRequest

OptimizeToursRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an OptimizeToursRequest 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