Class FleetRoutingAsyncClient (0.1.1)

A service for optimizing vehicle tours.

Validity of certain types of fields:

• google.protobuf.Timestamp

  • Times are in Unix time: seconds since 1970-01-01T00:00:00+00:00.
  • seconds must be in [0, 253402300799], i.e. in [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
  • nanos must be unset or set to 0.

• google.protobuf.Duration

  • seconds must be in [0, 253402300799], i.e. in [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
  • nanos must be unset or set to 0.

• google.type.LatLng

  • latitude must be in [-90.0, 90.0].
  • longitude must be in [-180.0, 180.0].
  • at least one of latitude and longitude must be non-zero.

Returns the transport used by the client instance.

Instantiates the fleet routing client.

Optimizes vehicle tours for one or more OptimizeToursRequest messages as a batch.

This method is a Long Running Operation (LRO). The inputs for optimization (OptimizeToursRequest messages) and outputs (OptimizeToursResponse messages) are read/written from/to Cloud Storage in user-specified format. Like the OptimizeTours method, each OptimizeToursRequest contains a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoute\ s, which are a set of routes to be performed by vehicles minimizing the overall cost.

from google.cloud import optimization_v1

def sample_batch_optimize_tours():
    # Create a client
    client = optimization_v1.FleetRoutingClient()

    # Initialize request argument(s)
    model_configs = optimization_v1.AsyncModelConfig()
    model_configs.input_config.gcs_source.uri = "uri_value"
    model_configs.output_config.gcs_destination.uri = "uri_value"

    request = optimization_v1.BatchOptimizeToursRequest(
        parent="parent_value",
        model_configs=model_configs,
    )

    # Make the request
    operation = client.batch_optimize_tours(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Returns an appropriate transport class.

Sends an OptimizeToursRequest containing a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoute\ s, which are a set of routes to be performed by vehicles minimizing the overall cost.

A ShipmentModel model consists mainly of Shipment\ s that need to be carried out and Vehicle\ s that can be used to transport the Shipment\ s. The ShipmentRoute\ s assign Shipment\ s to Vehicle\ s. More specifically, they assign a series of Visit\ s to each vehicle, where a Visit corresponds to a VisitRequest, which is a pickup or delivery for a Shipment.

The goal is to provide an assignment of ShipmentRoute\ s to Vehicle\ s that minimizes the total cost where cost has many components defined in the ShipmentModel.

from google.cloud import optimization_v1

def sample_optimize_tours():
    # Create a client
    client = optimization_v1.FleetRoutingClient()

    # Initialize request argument(s)
    request = optimization_v1.OptimizeToursRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.optimize_tours(request=request)

    # Handle the response
    print(response)

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.