Class v1.VehicleServiceClient (0.3.0)

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  The standard Fleet Engine request header. 
 */ 
  
 // const header = {} 
  
 /** 
 *  Required. Must be in the format `providers/{provider}`. 
 *  The provider must be the Project ID (for example, `sample-cloud-project`) 
 *  of the Google Cloud Project of which the service account making 
 *  this call is a member. 
 */ 
  
 // const parent = 'abc123' 
  
 /** 
 *  Required. Unique Vehicle ID. 
 *  Subject to the following restrictions: 
 *  * Must be a valid Unicode string. 
 *  * Limited to a maximum length of 64 characters. 
 *  * Normalized according to Unicode Normalization Form C 
 *  (http://www.unicode.org/reports/tr15/). 
 *  * May not contain any of the following ASCII characters: '/', ':', '?', 
 *  ',', or '#'. 
 */ 
  
 // const vehicleId = 'abc123' 
  
 /** 
 *  Required. The Vehicle entity to create. When creating a Vehicle, the 
 *  following fields are required: 
 *  * `vehicleState` 
 *  * `supportedTripTypes` 
 *  * `maximumCapacity` 
 *  * `vehicleType` 
 *  When creating a Vehicle, the following fields are ignored: 
 *  * `name` 
 *  * `currentTrips` 
 *  * `availableCapacity` 
 *  * `current_route_segment` 
 *  * `current_route_segment_end_point` 
 *  * `current_route_segment_version` 
 *  * `current_route_segment_traffic` 
 *  * `route` 
 *  * `waypoints` 
 *  * `waypoints_version` 
 *  * `remaining_distance_meters` 
 *  * `remaining_time_seconds` 
 *  * `eta_to_next_waypoint` 
 *  * `navigation_status` 
 *  All other fields are optional and used if provided. 
 */ 
  
 // const vehicle = {} 
  
 // Imports the Fleetengine library 
  
 const 
  
 { 
 VehicleServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @googlemaps/fleetengine 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 fleetengineClient 
  
 = 
  
 new 
  
  VehicleServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callCreateVehicle 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 vehicleId 
 , 
  
 vehicle 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 fleetengineClient 
 . 
 createVehicle 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callCreateVehicle 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  The standard Fleet Engine request header. 
 */ 
  
 // const header = {} 
  
 /** 
 *  Required. Must be in the format 
 *  `providers/{provider}/vehicles/{vehicle}`. 
 *  The provider must be the Project ID (for example, `sample-cloud-project`) 
 *  of the Google Cloud Project of which the service account making 
 *  this call is a member. 
 */ 
  
 // const name = 'abc123' 
  
 /** 
 *  Indicates the minimum timestamp (exclusive) for which 
 *  `Vehicle.current_route_segment` is retrieved. 
 *  If the route is unchanged since this timestamp, the `current_route_segment` 
 *  field is not set in the response. If a minimum is unspecified, the 
 *  `current_route_segment` is always retrieved. 
 */ 
  
 // const currentRouteSegmentVersion = {} 
  
 /** 
 *  Indicates the minimum timestamp (exclusive) for which `Vehicle.waypoints` 
 *  data is retrieved. If the waypoints are unchanged since this timestamp, the 
 *  `vehicle.waypoints` data is not set in the response. If this field is 
 *  unspecified, `vehicle.waypoints` is always retrieved. 
 */ 
  
 // const waypointsVersion = {} 
  
 // Imports the Fleetengine library 
  
 const 
  
 { 
 VehicleServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @googlemaps/fleetengine 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 fleetengineClient 
  
 = 
  
 new 
  
  VehicleServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callGetVehicle 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 fleetengineClient 
 . 
 getVehicle 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callGetVehicle 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  The standard Fleet Engine request header. 
 */ 
  
 // const header = {} 
  
 /** 
 *  Required. Must be in the format `providers/{provider}`. 
 *  The provider must be the Project ID (for example, `sample-cloud-project`) 
 *  of the Google Cloud Project of which the service account making 
 *  this call is a member. 
 */ 
  
 // const parent = 'abc123' 
  
 /** 
 *  The maximum number of vehicles to return. 
 *  Default value: 100. 
 */ 
  
 // const pageSize = 1234 
  
 /** 
 *  The value of the `next_page_token` provided by a previous call to 
 *  `ListVehicles` so that you can paginate through groups of vehicles. The 
 *  value is undefined if the filter criteria of the request is not the same as 
 *  the filter criteria for the previous call to `ListVehicles`. 
 */ 
  
 // const pageToken = 'abc123' 
  
 /** 
 *  Specifies the required minimum capacity of the vehicle. All vehicles 
 *  returned will have a `maximum_capacity` greater than or equal to this 
 *  value. If set, must be greater or equal to 0. 
 */ 
  
 // const minimumCapacity = {} 
  
 /** 
 *  Restricts the response to vehicles that support at least one of the 
 *  specified trip types. 
 */ 
  
 // const tripTypes = [1,2,3,4] 
  
 /** 
 *  Restricts the response to vehicles that have sent location updates to Fleet 
 *  Engine within the specified duration. Stationary vehicles still 
 *  transmitting their locations are not considered stale. If present, must be 
 *  a valid positive duration. 
 */ 
  
 // const maximumStaleness = {} 
  
 /** 
 *  Required. Restricts the response to vehicles with one of the specified type 
 *  categories. `UNKNOWN` is not allowed. 
 */ 
  
 // const vehicleTypeCategories = [1,2,3,4] 
  
 /** 
  
 * 
  
 Callers 
  
 can 
  
 form 
  
 complex 
  
 logical 
  
 operations 
  
 using 
  
 any 
  
 combination 
  
 of 
  
 the 
  
 * 
  
 `required_attributes` 
 , 
  
 `required_one_of_attributes` 
 , 
  
 and 
  
 * 
  
 `required_one_of_attribute_sets` 
  
 fields 
 . 
  
 * 
  
 `required_attributes` 
  
 is 
  
 a 
  
 list 
 ; 
  
 `required_one_of_attributes` 
  
 uses 
  
 a 
  
 * 
  
 message 
  
 which 
  
 allows 
  
 a 
  
 list 
  
 of 
  
 lists 
 . 
  
 In 
  
 combination 
 , 
  
 the 
  
 two 
  
 fields 
  
 allow 
  
 * 
  
 the 
  
 composition 
  
 of 
  
 this 
  
 expression 
 : 
  
 * 
  
 
 
    
 * 
  
 ( 
 required_attributes0 
  
 AND 
  
 required_attributes1 
  
 AND 
  
 ...) 
  
 * 
  
 AND 
  
 * 
  
 ( 
 required_one_of_attributes0 
  
 0 
  
 OR 
  
 required_one_of_attributes0 
  
 1 
  
 OR 
  
 * 
  
 ...) 
  
 * 
  
 AND 
  
 * 
  
 ( 
 required_one_of_attributes1 
  
 0 
  
 OR 
  
 required_one_of_attributes1 
  
 1 
  
 OR 
  
 * 
  
 ...) 
  
 * 
  
 
 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  The standard Fleet Engine request header. 
 */ 
  
 // const header = {} 
  
 /** 
 *  Required. Must be in the format `providers/{provider}`. 
 *  The provider must be the Project ID (for example, `sample-cloud-project`) 
 *  of the Google Cloud Project of which the service account making 
 *  this call is a member. 
 */ 
  
 // const parent = 'abc123' 
  
 /** 
 *  Required. The pickup point to search near. 
 */ 
  
 // const pickupPoint = {} 
  
 /** 
 *  The customer's intended dropoff location. The field is required if 
 *  `trip_types` contains `TripType.SHARED`. 
 */ 
  
 // const dropoffPoint = {} 
  
 /** 
 *  Required. Defines the vehicle search radius around the pickup point. Only 
 *  vehicles within the search radius will be returned. Value must be between 
 *  400 and 10000 meters (inclusive). 
 */ 
  
 // const pickupRadiusMeters = 1234 
  
 /** 
 *  Required. Specifies the maximum number of vehicles to return. The value 
 *  must be between 1 and 50 (inclusive). 
 */ 
  
 // const count = 1234 
  
 /** 
 *  Required. Specifies the number of passengers being considered for a trip. 
 *  The value must be greater than or equal to one. The driver is not 
 *  considered in the capacity value. 
 */ 
  
 // const minimumCapacity = 1234 
  
 /** 
 *  Required. Represents the type of proposed trip. Must include exactly one 
 *  type. `UNKNOWN_TRIP_TYPE` is not allowed. Restricts the search to only 
 *  those vehicles that can support that trip type. 
 */ 
  
 // const tripTypes = [1,2,3,4] 
  
 /** 
 *  Restricts the search to only those vehicles that have sent location updates 
 *  to Fleet Engine within the specified duration. Stationary vehicles still 
 *  transmitting their locations are not considered stale. If this field is not 
 *  set, the server uses five minutes as the default value. 
 */ 
  
 // const maximumStaleness = {} 
  
 /** 
 *  Required. Restricts the search to vehicles with one of the specified types. 
 *  At least one vehicle type must be specified. VehicleTypes with a category 
 *  of `UNKNOWN` are not allowed. 
 */ 
  
 // const vehicleTypes = [1,2,3,4] 
  
 /** 
  
 * 
  
 Callers 
  
 can 
  
 form 
  
 complex 
  
 logical 
  
 operations 
  
 using 
  
 any 
  
 combination 
  
 of 
  
 the 
  
 * 
  
 `required_attributes` 
 , 
  
 `required_one_of_attributes` 
 , 
  
 and 
  
 * 
  
 `required_one_of_attribute_sets` 
  
 fields 
 . 
  
 * 
  
 `required_attributes` 
  
 is 
  
 a 
  
 list 
 ; 
  
 `required_one_of_attributes` 
  
 uses 
  
 a 
  
 * 
  
 message 
  
 which 
  
 allows 
  
 a 
  
 list 
  
 of 
  
 lists 
 . 
  
 In 
  
 combination 
 , 
  
 the 
  
 two 
  
 fields 
  
 allow 
  
 * 
  
 the 
  
 composition 
  
 of 
  
 this 
  
 expression 
 : 
  
 * 
  
 
 
    
 * 
  
 ( 
 required_attributes0 
  
 AND 
  
 required_attributes1 
  
 AND 
  
 ...) 
  
 * 
  
 AND 
  
 * 
  
 ( 
 required_one_of_attributes0 
  
 0 
  
 OR 
  
 required_one_of_attributes0 
  
 1 
  
 OR 
  
 * 
  
 ...) 
  
 * 
  
 AND 
  
 * 
  
 ( 
 required_one_of_attributes1 
  
 0 
  
 OR 
  
 required_one_of_attributes1 
  
 1 
  
 OR 
  
 * 
  
 ...) 
  
 * 
  
 
 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  The standard Fleet Engine request header. 
 */ 
  
 // const header = {} 
  
 /** 
 *  Required. Must be in the format 
 *  `providers/{provider}/vehicles/{vehicle}`. 
 *  The {provider} must be the Project ID (for example, `sample-cloud-project`) 
 *  of the Google Cloud Project of which the service account making 
 *  this call is a member. 
 */ 
  
 // const name = 'abc123' 
  
 /** 
 *  Required. The `Vehicle` entity values to apply.  When updating a `Vehicle`, 
 *  the following fields may not be updated as they are managed by the 
 *  server. 
 *  * `available_capacity` 
 *  * `current_route_segment_version` 
 *  * `current_trips` 
 *  * `name` 
 *  * `waypoints_version` 
 *  If the `attributes` field is updated, **all** the vehicle's attributes are 
 *  replaced with the attributes provided in the request. If you want to update 
 *  only some attributes, see the `UpdateVehicleAttributes` method. 
 *  Likewise, the `waypoints` field can be updated, but must contain all the 
 *  waypoints currently on the vehicle, and no other waypoints. 
 */ 
  
 // const vehicle = {} 
  
 /** 
 *  Required. A field mask indicating which fields of the `Vehicle` to update. 
 *  At least one field name must be provided. 
 */ 
  
 // const updateMask = {} 
  
 // Imports the Fleetengine library 
  
 const 
  
 { 
 VehicleServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @googlemaps/fleetengine 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 fleetengineClient 
  
 = 
  
 new 
  
  VehicleServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callUpdateVehicle 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 vehicle 
 , 
  
 updateMask 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 fleetengineClient 
 . 
 updateVehicle 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callUpdateVehicle 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  The standard Fleet Engine request header. 
 */ 
  
 // const header = {} 
  
 /** 
 *  Required. Must be in the format `providers/{provider}/vehicles/{vehicle}`. 
 *  The provider must be the Project ID (for example, `sample-cloud-project`) 
 *  of the Google Cloud Project of which the service account making 
 *  this call is a member. 
 */ 
  
 // const name = 'abc123' 
  
 /** 
 *  Required. The vehicle attributes to update. Unmentioned attributes are not 
 *  altered or removed. 
 */ 
  
 // const attributes = [1,2,3,4] 
  
 // Imports the Fleetengine library 
  
 const 
  
 { 
 VehicleServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @googlemaps/fleetengine 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 fleetengineClient 
  
 = 
  
 new 
  
  VehicleServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callUpdateVehicleAttributes 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 attributes 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 fleetengineClient 
 . 
 updateVehicleAttributes 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callUpdateVehicleAttributes 
 ();