Class: Google::Maps::FleetEngine::V1::ListVehiclesRequest

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

ListVehicles request message.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Optional. A filter query to apply when listing vehicles. See http://aip.dev/160 for examples of the filter syntax.

This field is designed to replace the required_attributes, required_one_of_attributes, and required_one_of_attributes_sets fields. If a non-empty value is specified here, the following fields must be empty: required_attributes, required_one_of_attributes, and required_one_of_attributes_sets.

This filter functions as an AND clause with other constraints, such as vehicle_state or on_trip_only.

Note that the only queries supported are on vehicle attributes (for example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). The maximum number of restrictions allowed in a filter query is 50.

Also, all attributes are stored as strings, so the only supported comparisons against attributes are string comparisons. In order to compare against number or boolean values, the values must be explicitly quoted to be treated as strings (for example, attributes.<key> = "10" or attributes.<key> = "true").

Returns:

  • (::String) —

    Optional. A filter query to apply when listing vehicles. See http://aip.dev/160 for examples of the filter syntax.

    This field is designed to replace the required_attributes, required_one_of_attributes, and required_one_of_attributes_sets fields. If a non-empty value is specified here, the following fields must be empty: required_attributes, required_one_of_attributes, and required_one_of_attributes_sets.

    This filter functions as an AND clause with other constraints, such as vehicle_state or on_trip_only.

    Note that the only queries supported are on vehicle attributes (for example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). The maximum number of restrictions allowed in a filter query is 50.

    Also, all attributes are stored as strings, so the only supported comparisons against attributes are string comparisons. In order to compare against number or boolean values, the values must be explicitly quoted to be treated as strings (for example, attributes.<key> = "10" or attributes.<key> = "true").



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

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

Returns The standard Fleet Engine request header.

Returns:



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#maximum_staleness ⇒ ::Google::Protobuf::Duration

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

Returns:

  • (::Google::Protobuf::Duration) —

    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.



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#minimum_capacity ⇒ ::Google::Protobuf::Int32Value

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.

Returns:

  • (::Google::Protobuf::Int32Value) —

    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.



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#on_trip_only ⇒ ::Boolean

Returns Only return the vehicles with current trip(s).

Returns:

  • (::Boolean) —

    Only return the vehicles with current trip(s).



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#page_size ⇒ ::Integer

Returns The maximum number of vehicles to return. Default value: 100.

Returns:

  • (::Integer) —

    The maximum number of vehicles to return. Default value: 100.



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#page_token ⇒ ::String

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

Returns:

  • (::String) —

    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.



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

class ListVehiclesRequest
  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.



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#required_attributes ⇒ ::Array<::String>

Returns 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_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Restricts the response to vehicles with the specified attributes. This field is a conjunction/AND operation. A max of 50 required_attributes is allowed. This matches the maximum number of attributes allowed on a vehicle. Each repeated string should be of the format "key:value".

Returns:

  • (::Array<::String>) —

    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_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

    Restricts the response to vehicles with the specified attributes. This field is a conjunction/AND operation. A max of 50 required_attributes is allowed. This matches the maximum number of attributes allowed on a vehicle. Each repeated string should be of the format "key:value".



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#required_one_of_attribute_sets ⇒ ::Array<::String>

Returns required_one_of_attribute_sets provides additional functionality.

Similar to required_one_of_attributes, required_one_of_attribute_sets uses a message which allows a list of lists, allowing expressions such as this one:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Restricts the response to vehicles that match all the attributes in a VehicleAttributeList. Within each list, a vehicle must match all of the attributes. This field is a conjunction/AND operation in each VehicleAttributeList and inclusive disjunction/OR operation across the collection of VehicleAttributeList. Each repeated string should be of the format "key1:value1|key2:value2|key3:value3".

Returns:

  • (::Array<::String>) —

    required_one_of_attribute_sets provides additional functionality.

    Similar to required_one_of_attributes, required_one_of_attribute_sets uses a message which allows a list of lists, allowing expressions such as this one:

    (required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

    Restricts the response to vehicles that match all the attributes in a VehicleAttributeList. Within each list, a vehicle must match all of the attributes. This field is a conjunction/AND operation in each VehicleAttributeList and inclusive disjunction/OR operation across the collection of VehicleAttributeList. Each repeated string should be of the format "key1:value1|key2:value2|key3:value3".



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#required_one_of_attributes ⇒ ::Array<::String>

Returns Restricts the response to vehicles with at least one of the specified attributes in each VehicleAttributeList. Within each list, a vehicle must match at least one of the attributes. This field is an inclusive disjunction/OR operation in each VehicleAttributeList and a conjunction/AND operation across the collection of VehicleAttributeList. Each repeated string should be of the format "key1:value1|key2:value2|key3:value3".

Returns:

  • (::Array<::String>) —

    Restricts the response to vehicles with at least one of the specified attributes in each VehicleAttributeList. Within each list, a vehicle must match at least one of the attributes. This field is an inclusive disjunction/OR operation in each VehicleAttributeList and a conjunction/AND operation across the collection of VehicleAttributeList. Each repeated string should be of the format "key1:value1|key2:value2|key3:value3".



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#trip_types ⇒ ::Array<::Google::Maps::FleetEngine::V1::TripType>

Returns Restricts the response to vehicles that support at least one of the specified trip types.

Returns:



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#vehicle_state ⇒ ::Google::Maps::FleetEngine::V1::VehicleState

Returns Restricts the response to vehicles that have this vehicle state.

Returns:



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#vehicle_type_categories ⇒ ::Array<::Google::Maps::FleetEngine::V1::Vehicle::VehicleType::Category>

Returns Required. Restricts the response to vehicles with one of the specified type categories. UNKNOWN is not allowed.

Returns:



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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

#viewport ⇒ ::Google::Geo::Type::Viewport

Returns Optional. A filter that limits the vehicles returned to those whose last known location was in the rectangular area defined by the viewport.

Returns:

  • (::Google::Geo::Type::Viewport) —

    Optional. A filter that limits the vehicles returned to those whose last known location was in the rectangular area defined by the viewport.



517
518
519
520
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 517

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