@googlemaps/fleetengine 0.8.2 → 0.9.0

package/build/src/v1/vehicle_service_client.d.ts

@@ -534,141 +534,141 @@ export declare class VehicleServiceClient {
     searchVehicles(request: protos.maps.fleetengine.v1.ISearchVehiclesRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.v1.ISearchVehiclesResponse, protos.maps.fleetengine.v1.ISearchVehiclesRequest | null | undefined, {} | null | undefined>): void;
     searchVehicles(request: protos.maps.fleetengine.v1.ISearchVehiclesRequest, callback: Callback<protos.maps.fleetengine.v1.ISearchVehiclesResponse, protos.maps.fleetengine.v1.ISearchVehiclesRequest | null | undefined, {} | null | undefined>): void;
     /**
-    * Returns a paginated list of vehicles associated with
-    * a provider that match the request options.
-    *
-    * @param {Object} request
-    *   The request object that will be sent.
-    * @param {maps.fleetengine.v1.RequestHeader} request.header
-    *   The standard Fleet Engine request header.
-    * @param {string} request.parent
-    *   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.
-    * @param {number} request.pageSize
-    *   The maximum number of vehicles to return.
-    *   Default value: 100.
-    * @param {string} request.pageToken
-    *   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`.
-    * @param {google.protobuf.Int32Value} request.minimumCapacity
-    *   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.
-    * @param {number[]} request.tripTypes
-    *   Restricts the response to vehicles that support at least one of the
-    *   specified trip types.
-    * @param {google.protobuf.Duration} request.maximumStaleness
-    *   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.
-    * @param {number[]} request.vehicleTypeCategories
-    *   Required. Restricts the response to vehicles with one of the specified type
-    *   categories. `UNKNOWN` is not allowed.
-    * @param {string[]} request.requiredAttributes
-    *   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{@link protos.0|0} OR required_one_of_attributes{@link protos.1|0} OR
-    *   ...)
-    *   AND
-    *   (required_one_of_attributes{@link protos.0|1} OR required_one_of_attributes{@link protos.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".
-    * @param {string[]} request.requiredOneOfAttributes
-    *   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".
-    * @param {string[]} request.requiredOneOfAttributeSets
-    *   `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{@link protos.0|0} AND
-    *     required_one_of_attribute_sets{@link protos.1|0} AND
-    *     ...)
-    *     OR
-    *     (required_one_of_attribute_sets{@link protos.0|1} AND
-    *     required_one_of_attribute_sets{@link protos.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".
-    * @param {maps.fleetengine.v1.VehicleState} request.vehicleState
-    *   Restricts the response to vehicles that have this vehicle state.
-    * @param {boolean} request.onTripOnly
-    *   Only return the vehicles with current trip(s).
-    * @param {string} [request.filter]
-    *   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"`).
-    * @param {google.geo.type.Viewport} [request.viewport]
-    *   Optional. A filter that limits the vehicles returned to those whose last
-    *   known location was in the rectangular area defined by the viewport.
-    * @param {object} [options]
-    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
-    * @returns {Promise} - The promise which resolves to an array.
-    *   The first element of the array is Array of {@link protos.maps.fleetengine.v1.Vehicle|Vehicle}.
-    *   The client library will perform auto-pagination by default: it will call the API as many
-    *   times as needed and will merge results from all the pages into this array.
-    *   Note that it can affect your quota.
-    *   We recommend using `listVehiclesAsync()`
-    *   method described below for async iteration which you can stop as needed.
-    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
-    *   for more details and examples.
-    */
+     * Returns a paginated list of vehicles associated with
+     * a provider that match the request options.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {maps.fleetengine.v1.RequestHeader} request.header
+     *   The standard Fleet Engine request header.
+     * @param {string} request.parent
+     *   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.
+     * @param {number} request.pageSize
+     *   The maximum number of vehicles to return.
+     *   Default value: 100.
+     * @param {string} request.pageToken
+     *   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`.
+     * @param {google.protobuf.Int32Value} request.minimumCapacity
+     *   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.
+     * @param {number[]} request.tripTypes
+     *   Restricts the response to vehicles that support at least one of the
+     *   specified trip types.
+     * @param {google.protobuf.Duration} request.maximumStaleness
+     *   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.
+     * @param {number[]} request.vehicleTypeCategories
+     *   Required. Restricts the response to vehicles with one of the specified type
+     *   categories. `UNKNOWN` is not allowed.
+     * @param {string[]} request.requiredAttributes
+     *   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{@link protos.0|0} OR required_one_of_attributes{@link protos.1|0} OR
+     *   ...)
+     *   AND
+     *   (required_one_of_attributes{@link protos.0|1} OR required_one_of_attributes{@link protos.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".
+     * @param {string[]} request.requiredOneOfAttributes
+     *   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".
+     * @param {string[]} request.requiredOneOfAttributeSets
+     *   `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{@link protos.0|0} AND
+     *     required_one_of_attribute_sets{@link protos.1|0} AND
+     *     ...)
+     *     OR
+     *     (required_one_of_attribute_sets{@link protos.0|1} AND
+     *     required_one_of_attribute_sets{@link protos.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".
+     * @param {maps.fleetengine.v1.VehicleState} request.vehicleState
+     *   Restricts the response to vehicles that have this vehicle state.
+     * @param {boolean} request.onTripOnly
+     *   Only return the vehicles with current trip(s).
+     * @param {string} [request.filter]
+     *   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"`).
+     * @param {google.geo.type.Viewport} [request.viewport]
+     *   Optional. A filter that limits the vehicles returned to those whose last
+     *   known location was in the rectangular area defined by the viewport.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of {@link protos.maps.fleetengine.v1.Vehicle|Vehicle}.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   Note that it can affect your quota.
+     *   We recommend using `listVehiclesAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
     listVehicles(request?: protos.maps.fleetengine.v1.IListVehiclesRequest, options?: CallOptions): Promise<[
         protos.maps.fleetengine.v1.IVehicle[],
         protos.maps.fleetengine.v1.IListVehiclesRequest | null,