Package com.google.cloud.optimization.v1

Class OptimizeToursResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated public final class OptimizeToursResponse extends com.google.protobuf.GeneratedMessage 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:

  • Field Details

    • ROUTES_FIELD_NUMBER

      public static final int ROUTES_FIELD_NUMBER
      See Also:

    • REQUEST_LABEL_FIELD_NUMBER

      public static final int REQUEST_LABEL_FIELD_NUMBER
      See Also:

    • SKIPPED_SHIPMENTS_FIELD_NUMBER

      public static final int SKIPPED_SHIPMENTS_FIELD_NUMBER
      See Also:

    • VALIDATION_ERRORS_FIELD_NUMBER

      public static final int VALIDATION_ERRORS_FIELD_NUMBER
      See Also:

    • METRICS_FIELD_NUMBER

      public static final int METRICS_FIELD_NUMBER
      See Also:

    • TOTAL_COST_FIELD_NUMBER

      public static final int TOTAL_COST_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public OptimizeToursResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder