Class protos.google.cloud.optimization.v1.OptimizeToursResponse (2.1.1)

Represents an OptimizeToursResponse.

Package

Constructors

(constructor)(properties)

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

Constructs a new OptimizeToursResponse.

Parameter

Name	Description
properties	`IOptimizeToursResponse` Properties to set

Properties

metrics

public metrics?: (google.cloud.optimization.v1.OptimizeToursResponse.IMetrics|null);

OptimizeToursResponse metrics.

requestLabel

public requestLabel: string;

OptimizeToursResponse requestLabel.

routes

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

OptimizeToursResponse routes.

skippedShipments

public skippedShipments: google.cloud.optimization.v1.ISkippedShipment[];

OptimizeToursResponse skippedShipments.

totalCost

public totalCost: number;

OptimizeToursResponse totalCost.

validationErrors

public validationErrors: google.cloud.optimization.v1.IOptimizeToursValidationError[];

OptimizeToursResponse validationErrors.

Methods

create(properties)

public static create(properties?: google.cloud.optimization.v1.IOptimizeToursResponse): google.cloud.optimization.v1.OptimizeToursResponse;

Creates a new OptimizeToursResponse instance using the specified properties.

Parameter

Name	Description
properties	`IOptimizeToursResponse` Properties to set

Returns

Type	Description
google.cloud.optimization.v1.OptimizeToursResponse	OptimizeToursResponse instance

decode(reader, length)

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

Decodes an OptimizeToursResponse message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.optimization.v1.OptimizeToursResponse	OptimizeToursResponse

decodeDelimited(reader)

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

Decodes an OptimizeToursResponse message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.optimization.v1.OptimizeToursResponse	OptimizeToursResponse

encode(message, writer)

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

Encodes the specified OptimizeToursResponse message. Does not implicitly messages.

Parameters

Name	Description
message	`IOptimizeToursResponse` OptimizeToursResponse 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.cloud.optimization.v1.IOptimizeToursResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IOptimizeToursResponse` OptimizeToursResponse 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.cloud.optimization.v1.OptimizeToursResponse;

Creates an OptimizeToursResponse 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
google.cloud.optimization.v1.OptimizeToursResponse	OptimizeToursResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for OptimizeToursResponse

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

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.optimization.v1.OptimizeToursResponse` OptimizeToursResponse
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 an OptimizeToursResponse 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