internal/generated/snippets/optimization/apiv1/snippet_metadata.google.cloud.optimization.v1.json

{
  "clientLibrary": {
    "name": "cloud.google.com/go/optimization/apiv1",
    "version": "1.3.0",
    "language": "GO",
    "apis": [
      {
        "id": "google.cloud.optimization.v1",
        "version": "v1"
      }
    ]
  },
  "snippets": [
    {
      "regionTag": "cloudoptimization_v1_generated_FleetRouting_BatchOptimizeTours_sync",
      "title": "cloudoptimization BatchOptimizeTours Sample",
      "description": "BatchOptimizeTours optimizes vehicle tours for one or more OptimizeToursRequest\nmessages as a batch.\n\nThis method is a Long Running Operation (LRO). The inputs for optimization\n(OptimizeToursRequest messages) and outputs (OptimizeToursResponse\nmessages) are read/written from/to Cloud Storage in user-specified\nformat. Like the OptimizeTours method, each OptimizeToursRequest\ncontains a ShipmentModel and returns an OptimizeToursResponse\ncontaining ShipmentRoutes, which are a set of routes to be performed by\nvehicles minimizing the overall cost.",
      "file": "FleetRoutingClient/BatchOptimizeTours/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "BatchOptimizeTours",
        "fullName": "google.cloud.optimization.v1.FleetRoutingClient.BatchOptimizeTours",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "optimizationpb.BatchOptimizeToursRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "BatchOptimizeToursOperation",
        "client": {
          "shortName": "FleetRoutingClient",
          "fullName": "google.cloud.optimization.v1.FleetRoutingClient"
        },
        "method": {
          "shortName": "BatchOptimizeTours",
          "fullName": "google.cloud.optimization.v1.FleetRouting.BatchOptimizeTours",
          "service": {
            "shortName": "FleetRouting",
            "fullName": "google.cloud.optimization.v1.FleetRouting"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 58,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "cloudoptimization_v1_generated_FleetRouting_OptimizeTours_sync",
      "title": "cloudoptimization OptimizeTours Sample",
      "description": "OptimizeTours sends an OptimizeToursRequest containing a ShipmentModel and returns an\nOptimizeToursResponse containing ShipmentRoutes, which are a set of\nroutes to be performed by vehicles minimizing the overall cost.\n\nA ShipmentModel model consists mainly of Shipments that need to be\ncarried out and Vehicles that can be used to transport the Shipments.\nThe ShipmentRoutes assign Shipments to Vehicles. More specifically,\nthey assign a series of Visits to each vehicle, where a Visit\ncorresponds to a VisitRequest, which is a pickup or delivery for a\nShipment.\n\nThe goal is to provide an assignment of ShipmentRoutes to Vehicles that\nminimizes the total cost where cost has many components defined in the\nShipmentModel.",
      "file": "FleetRoutingClient/OptimizeTours/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "OptimizeTours",
        "fullName": "google.cloud.optimization.v1.FleetRoutingClient.OptimizeTours",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "optimizationpb.OptimizeToursRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "optimizationpb.OptimizeToursResponse",
        "client": {
          "shortName": "FleetRoutingClient",
          "fullName": "google.cloud.optimization.v1.FleetRoutingClient"
        },
        "method": {
          "shortName": "OptimizeTours",
          "fullName": "google.cloud.optimization.v1.FleetRouting.OptimizeTours",
          "service": {
            "shortName": "FleetRouting",
            "fullName": "google.cloud.optimization.v1.FleetRouting"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    }
  ]
}