Class: Google::Maps::FleetEngine::Delivery::V1::ListDeliveryVehiclesRequest

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

Overview

The ListDeliveryVehicles request message.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Optional. A filter query to apply when listing delivery vehicles. See http://aip.dev/160 for examples of the filter syntax. If you don't specify a value, or if you specify an empty string for the filter, then all delivery vehicles are returned.

Note that the only queries supported for ListDeliveryVehicles are on vehicle attributes (for example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). 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").

The maximum number of restrictions allowed in a filter query is 50. A restriction is a part of the query of the form attribute.<KEY> <COMPARATOR> <VALUE>, for example attributes.foo = bar is 1 restriction.

Returns:

  • (::String) —

    Optional. A filter query to apply when listing delivery vehicles. See http://aip.dev/160 for examples of the filter syntax. If you don't specify a value, or if you specify an empty string for the filter, then all delivery vehicles are returned.

    Note that the only queries supported for ListDeliveryVehicles are on vehicle attributes (for example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). 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").

    The maximum number of restrictions allowed in a filter query is 50. A restriction is a part of the query of the form attribute.<KEY> <COMPARATOR> <VALUE>, for example attributes.foo = bar is 1 restriction.



120
121
122
123
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 120

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

#header ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryRequestHeader

Returns Optional. The standard Delivery API request header.

Returns:



120
121
122
123
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 120

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

#page_size ⇒ ::Integer

Returns Optional. The maximum number of vehicles to return. The service may return fewer than this number. If you don't specify this number, then the server determines the number of results to return.

Returns:

  • (::Integer) —

    Optional. The maximum number of vehicles to return. The service may return fewer than this number. If you don't specify this number, then the server determines the number of results to return.



120
121
122
123
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 120

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

#page_token ⇒ ::String

Returns Optional. A page token, received from a previous ListDeliveryVehicles call. You must provide this in order to retrieve the subsequent page.

When paginating, all other parameters provided to ListDeliveryVehicles must match the call that provided the page token.

Returns:

  • (::String) —

    Optional. A page token, received from a previous ListDeliveryVehicles call. You must provide this in order to retrieve the subsequent page.

    When paginating, all other parameters provided to ListDeliveryVehicles must match the call that provided the page token.



120
121
122
123
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 120

class ListDeliveryVehiclesRequest
  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 Google Cloud Project ID. For example, sample-cloud-project.

Returns:

  • (::String) —

    Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.



120
121
122
123
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 120

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



120
121
122
123
 
# File 'proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb', line 120

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