Package com.google.cloud.optimization.v1

Class OptimizeToursResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.optimization.v1.OptimizeToursResponse

All Implemented Interfaces:

OptimizeToursResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class OptimizeToursResponse
extends com.google.protobuf.GeneratedMessageV3
implements OptimizeToursResponseOrBuilder

 Response after solving a tour optimization problem containing the routes
 followed by each vehicle, the shipments which have been skipped and the
 overall cost of the solution.
 

Protobuf type google.cloud.optimization.v1.OptimizeToursResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OptimizeToursResponse.Builder	Response after solving a tour optimization problem containing the routes followed by each vehicle, the shipments which have been skipped and the overall cost of the solution.
static class	OptimizeToursResponse.Metrics	Overall metrics, aggregated over all routes.
static interface	OptimizeToursResponse.MetricsOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	METRICS_FIELD_NUMBER
static int	REQUEST_LABEL_FIELD_NUMBER
static int	ROUTES_FIELD_NUMBER
static int	SKIPPED_SHIPMENTS_FIELD_NUMBER
static int	TOTAL_COST_FIELD_NUMBER
static int	VALIDATION_ERRORS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static OptimizeToursResponse	getDefaultInstance()
OptimizeToursResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
OptimizeToursResponse.Metrics	getMetrics()	Duration, distance and usage metrics for this solution.
OptimizeToursResponse.MetricsOrBuilder	getMetricsOrBuilder()	Duration, distance and usage metrics for this solution.
com.google.protobuf.Parser<OptimizeToursResponse>	getParserForType()
String	getRequestLabel()	Copy of the [OptimizeToursRequest.label][google.cloud.optimization.v1.OptimizeToursRequest.label], if a label was specified in the request.
com.google.protobuf.ByteString	getRequestLabelBytes()	Copy of the [OptimizeToursRequest.label][google.cloud.optimization.v1.OptimizeToursRequest.label], if a label was specified in the request.
ShipmentRoute	getRoutes(int index)	Routes computed for each vehicle; the i-th route corresponds to the i-th vehicle in the model.
int	getRoutesCount()	Routes computed for each vehicle; the i-th route corresponds to the i-th vehicle in the model.
List<ShipmentRoute>	getRoutesList()	Routes computed for each vehicle; the i-th route corresponds to the i-th vehicle in the model.
ShipmentRouteOrBuilder	getRoutesOrBuilder(int index)	Routes computed for each vehicle; the i-th route corresponds to the i-th vehicle in the model.
List<? extends ShipmentRouteOrBuilder>	getRoutesOrBuilderList()	Routes computed for each vehicle; the i-th route corresponds to the i-th vehicle in the model.
int	getSerializedSize()
SkippedShipment	getSkippedShipments(int index)	The list of all shipments skipped.
int	getSkippedShipmentsCount()	The list of all shipments skipped.
List<SkippedShipment>	getSkippedShipmentsList()	The list of all shipments skipped.
SkippedShipmentOrBuilder	getSkippedShipmentsOrBuilder(int index)	The list of all shipments skipped.
List<? extends SkippedShipmentOrBuilder>	getSkippedShipmentsOrBuilderList()	The list of all shipments skipped.
double	getTotalCost()	Deprecated. google.cloud.optimization.v1.OptimizeToursResponse.total_cost is deprecated.
OptimizeToursValidationError	getValidationErrors(int index)	List of all the validation errors that we were able to detect independently.
int	getValidationErrorsCount()	List of all the validation errors that we were able to detect independently.
List<OptimizeToursValidationError>	getValidationErrorsList()	List of all the validation errors that we were able to detect independently.
OptimizeToursValidationErrorOrBuilder	getValidationErrorsOrBuilder(int index)	List of all the validation errors that we were able to detect independently.
List<? extends OptimizeToursValidationErrorOrBuilder>	getValidationErrorsOrBuilderList()	List of all the validation errors that we were able to detect independently.
int	hashCode()
boolean	hasMetrics()	Duration, distance and usage metrics for this solution.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static OptimizeToursResponse.Builder	newBuilder()
static OptimizeToursResponse.Builder	newBuilder(OptimizeToursResponse prototype)
OptimizeToursResponse.Builder	newBuilderForType()
protected OptimizeToursResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static OptimizeToursResponse	parseDelimitedFrom(InputStream input)
static OptimizeToursResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OptimizeToursResponse	parseFrom(byte[] data)
static OptimizeToursResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OptimizeToursResponse	parseFrom(com.google.protobuf.ByteString data)
static OptimizeToursResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OptimizeToursResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static OptimizeToursResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OptimizeToursResponse	parseFrom(InputStream input)
static OptimizeToursResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OptimizeToursResponse	parseFrom(ByteBuffer data)
static OptimizeToursResponse	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OptimizeToursResponse>	parser()
OptimizeToursResponse.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail

ROUTES_FIELD_NUMBER

public static final int ROUTES_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_LABEL_FIELD_NUMBER

public static final int REQUEST_LABEL_FIELD_NUMBER

See Also:

Constant Field Values

SKIPPED_SHIPMENTS_FIELD_NUMBER

public static final int SKIPPED_SHIPMENTS_FIELD_NUMBER

See Also:

Constant Field Values

VALIDATION_ERRORS_FIELD_NUMBER

public static final int VALIDATION_ERRORS_FIELD_NUMBER

See Also:

Constant Field Values

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_COST_FIELD_NUMBER

public static final int TOTAL_COST_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getRoutesList

public List<ShipmentRoute> getRoutesList()

 Routes computed for each vehicle; the i-th route corresponds to the i-th
 vehicle in the model.
 

repeated .google.cloud.optimization.v1.ShipmentRoute routes = 1;

Specified by:

getRoutesList in interface OptimizeToursResponseOrBuilder

getRoutesOrBuilderList

public List<? extends ShipmentRouteOrBuilder> getRoutesOrBuilderList()

 Routes computed for each vehicle; the i-th route corresponds to the i-th
 vehicle in the model.
 

repeated .google.cloud.optimization.v1.ShipmentRoute routes = 1;

Specified by:

getRoutesOrBuilderList in interface OptimizeToursResponseOrBuilder

getRoutesCount

public int getRoutesCount()

 Routes computed for each vehicle; the i-th route corresponds to the i-th
 vehicle in the model.
 

repeated .google.cloud.optimization.v1.ShipmentRoute routes = 1;

Specified by:

getRoutesCount in interface OptimizeToursResponseOrBuilder

getRoutes

public ShipmentRoute getRoutes(int index)

 Routes computed for each vehicle; the i-th route corresponds to the i-th
 vehicle in the model.
 

repeated .google.cloud.optimization.v1.ShipmentRoute routes = 1;

Specified by:

getRoutes in interface OptimizeToursResponseOrBuilder

getRoutesOrBuilder

public ShipmentRouteOrBuilder getRoutesOrBuilder(int index)

 Routes computed for each vehicle; the i-th route corresponds to the i-th
 vehicle in the model.
 

repeated .google.cloud.optimization.v1.ShipmentRoute routes = 1;

Specified by:

getRoutesOrBuilder in interface OptimizeToursResponseOrBuilder

getRequestLabel

public String getRequestLabel()

 Copy of the
 [OptimizeToursRequest.label][google.cloud.optimization.v1.OptimizeToursRequest.label],
 if a label was specified in the request.
 

string request_label = 3;

Specified by:

getRequestLabel in interface OptimizeToursResponseOrBuilder

Returns:

The requestLabel.

getRequestLabelBytes

public com.google.protobuf.ByteString getRequestLabelBytes()

 Copy of the
 [OptimizeToursRequest.label][google.cloud.optimization.v1.OptimizeToursRequest.label],
 if a label was specified in the request.
 

string request_label = 3;

Specified by:

getRequestLabelBytes in interface OptimizeToursResponseOrBuilder

Returns:

The bytes for requestLabel.

getSkippedShipmentsList

public List<SkippedShipment> getSkippedShipmentsList()

 The list of all shipments skipped.
 

repeated .google.cloud.optimization.v1.SkippedShipment skipped_shipments = 4;

Specified by:

getSkippedShipmentsList in interface OptimizeToursResponseOrBuilder

getSkippedShipmentsOrBuilderList

public List<? extends SkippedShipmentOrBuilder> getSkippedShipmentsOrBuilderList()

 The list of all shipments skipped.
 

repeated .google.cloud.optimization.v1.SkippedShipment skipped_shipments = 4;

Specified by:

getSkippedShipmentsOrBuilderList in interface OptimizeToursResponseOrBuilder

getSkippedShipmentsCount

public int getSkippedShipmentsCount()

 The list of all shipments skipped.
 

repeated .google.cloud.optimization.v1.SkippedShipment skipped_shipments = 4;

Specified by:

getSkippedShipmentsCount in interface OptimizeToursResponseOrBuilder

getSkippedShipments

public SkippedShipment getSkippedShipments(int index)

 The list of all shipments skipped.
 

repeated .google.cloud.optimization.v1.SkippedShipment skipped_shipments = 4;

Specified by:

getSkippedShipments in interface OptimizeToursResponseOrBuilder

getSkippedShipmentsOrBuilder

public SkippedShipmentOrBuilder getSkippedShipmentsOrBuilder(int index)

 The list of all shipments skipped.
 

repeated .google.cloud.optimization.v1.SkippedShipment skipped_shipments = 4;

Specified by:

getSkippedShipmentsOrBuilder in interface OptimizeToursResponseOrBuilder

getValidationErrorsList

public List<OptimizeToursValidationError> getValidationErrorsList()

 List of all the validation errors that we were able to detect
 independently. See the "MULTIPLE ERRORS" explanation for the
 [OptimizeToursValidationError][google.cloud.optimization.v1.OptimizeToursValidationError]
 message.
 

repeated .google.cloud.optimization.v1.OptimizeToursValidationError validation_errors = 5;

Specified by:

getValidationErrorsList in interface OptimizeToursResponseOrBuilder

getValidationErrorsOrBuilderList

public List<? extends OptimizeToursValidationErrorOrBuilder> getValidationErrorsOrBuilderList()

 List of all the validation errors that we were able to detect
 independently. See the "MULTIPLE ERRORS" explanation for the
 [OptimizeToursValidationError][google.cloud.optimization.v1.OptimizeToursValidationError]
 message.
 

repeated .google.cloud.optimization.v1.OptimizeToursValidationError validation_errors = 5;

Specified by:

getValidationErrorsOrBuilderList in interface OptimizeToursResponseOrBuilder

getValidationErrorsCount

public int getValidationErrorsCount()

 List of all the validation errors that we were able to detect
 independently. See the "MULTIPLE ERRORS" explanation for the
 [OptimizeToursValidationError][google.cloud.optimization.v1.OptimizeToursValidationError]
 message.
 

repeated .google.cloud.optimization.v1.OptimizeToursValidationError validation_errors = 5;

Specified by:

getValidationErrorsCount in interface OptimizeToursResponseOrBuilder

getValidationErrors

public OptimizeToursValidationError getValidationErrors(int index)

 List of all the validation errors that we were able to detect
 independently. See the "MULTIPLE ERRORS" explanation for the
 [OptimizeToursValidationError][google.cloud.optimization.v1.OptimizeToursValidationError]
 message.
 

repeated .google.cloud.optimization.v1.OptimizeToursValidationError validation_errors = 5;

Specified by:

getValidationErrors in interface OptimizeToursResponseOrBuilder

getValidationErrorsOrBuilder

public OptimizeToursValidationErrorOrBuilder getValidationErrorsOrBuilder(int index)

 List of all the validation errors that we were able to detect
 independently. See the "MULTIPLE ERRORS" explanation for the
 [OptimizeToursValidationError][google.cloud.optimization.v1.OptimizeToursValidationError]
 message.
 

repeated .google.cloud.optimization.v1.OptimizeToursValidationError validation_errors = 5;

Specified by:

getValidationErrorsOrBuilder in interface OptimizeToursResponseOrBuilder

hasMetrics

public boolean hasMetrics()

 Duration, distance and usage metrics for this solution.
 

.google.cloud.optimization.v1.OptimizeToursResponse.Metrics metrics = 6;

Specified by:

hasMetrics in interface OptimizeToursResponseOrBuilder

Returns:

Whether the metrics field is set.

getMetrics

public OptimizeToursResponse.Metrics getMetrics()

 Duration, distance and usage metrics for this solution.
 

.google.cloud.optimization.v1.OptimizeToursResponse.Metrics metrics = 6;

Specified by:

getMetrics in interface OptimizeToursResponseOrBuilder

Returns:

The metrics.

getMetricsOrBuilder

public OptimizeToursResponse.MetricsOrBuilder getMetricsOrBuilder()

 Duration, distance and usage metrics for this solution.
 

.google.cloud.optimization.v1.OptimizeToursResponse.Metrics metrics = 6;

Specified by:

getMetricsOrBuilder in interface OptimizeToursResponseOrBuilder

getTotalCost

@Deprecated
public double getTotalCost()

Deprecated.

google.cloud.optimization.v1.OptimizeToursResponse.total_cost is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=433

 Deprecated: Use
 [Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
 instead. Total cost of the solution. This takes into account all costs:
 costs per per hour and travel hour, fixed vehicle costs, unperformed
 shipment penalty costs, global duration cost, etc.
 

double total_cost = 2 [deprecated = true];

Specified by:

getTotalCost in interface OptimizeToursResponseOrBuilder

Returns:

The totalCost.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static OptimizeToursResponse parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OptimizeToursResponse parseFrom(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OptimizeToursResponse parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OptimizeToursResponse parseFrom(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OptimizeToursResponse parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OptimizeToursResponse parseFrom(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OptimizeToursResponse parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static OptimizeToursResponse parseFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static OptimizeToursResponse parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static OptimizeToursResponse parseDelimitedFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseFrom

public static OptimizeToursResponse parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static OptimizeToursResponse parseFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

newBuilderForType

public OptimizeToursResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static OptimizeToursResponse.Builder newBuilder()

newBuilder

public static OptimizeToursResponse.Builder newBuilder(OptimizeToursResponse prototype)

toBuilder

public OptimizeToursResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected OptimizeToursResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static OptimizeToursResponse getDefaultInstance()

parser

public static com.google.protobuf.Parser<OptimizeToursResponse> parser()

getParserForType

public com.google.protobuf.Parser<OptimizeToursResponse> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public OptimizeToursResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder