Class: Google::Maps::FleetEngine::V1::CreateVehicleRequest

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

CreateVehicle request message.

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns The standard Fleet Engine request header.

Returns:



73
74
75
76
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 73

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

#parent ⇒ ::String

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

Returns:

  • (::String) —

    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.



73
74
75
76
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 73

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

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

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

Returns:

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

    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.



73
74
75
76
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 73

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

#vehicle_id ⇒ ::String

Returns 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.
  • May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.

Returns:

  • (::String) —

    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.
    • May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.


73
74
75
76
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 73

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