Class: Google::Maps::FleetEngine::V1::UpdateVehicleRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/maps/fleetengine/v1/vehicle_api.rb

Overview

`UpdateVehicle request message.

Instance Attribute Summary collapse

Instance Attribute Details

#header ⇒ ::Google::Maps::FleetEngine::V1::RequestHeader

Returns The standard Fleet Engine request header.

Returns:



140
141
142
143
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 140

class UpdateVehicleRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



140
141
142
143
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 140

class UpdateVehicleRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns Required. A field mask indicating which fields of the Vehicle to update. At least one field name must be provided.

Returns:

  • (::Google::Protobuf::FieldMask) —

    Required. A field mask indicating which fields of the Vehicle to update. At least one field name must be provided.



140
141
142
143
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 140

class UpdateVehicleRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#vehicle ⇒ ::Google::Maps::FleetEngine::V1::Vehicle

Returns 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.

Returns:

  • (::Google::Maps::FleetEngine::V1::Vehicle) —

    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.



140
141
142
143
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 140

class UpdateVehicleRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end