@googlemaps/fleetengine 0.1.0

package/build/src/v1/vehicle_service_client.js

@@ -0,0 +1,904 @@
+"use strict";
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VehicleServiceClient = void 0;
+const jsonProtos = require("../../protos/protos.json");
+/**
+ * Client JSON configuration object, loaded from
+ * `src/v1/vehicle_service_client_config.json`.
+ * This file defines retry strategy and timeouts for all API methods in this library.
+ */
+const gapicConfig = require("./vehicle_service_client_config.json");
+const version = require('../../../package.json').version;
+/**
+ *  Vehicle management service.
+ * @class
+ * @memberof v1
+ */
+class VehicleServiceClient {
+    /**
+     * Construct an instance of VehicleServiceClient.
+     *
+     * @param {object} [options] - The configuration object.
+     * The options accepted by the constructor are described in detail
+     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
+     * The common options are:
+     * @param {object} [options.credentials] - Credentials object.
+     * @param {string} [options.credentials.client_email]
+     * @param {string} [options.credentials.private_key]
+     * @param {string} [options.email] - Account email address. Required when
+     *     using a .pem or .p12 keyFilename.
+     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
+     *     .p12 key downloaded from the Google Developers Console. If you provide
+     *     a path to a JSON file, the projectId option below is not necessary.
+     *     NOTE: .pem and .p12 require you to specify options.email as well.
+     * @param {number} [options.port] - The port on which to connect to
+     *     the remote host.
+     * @param {string} [options.projectId] - The project ID from the Google
+     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
+     *     the environment variable GCLOUD_PROJECT for your project ID. If your
+     *     app is running in an environment which supports
+     *     {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
+     *     your project ID will be detected automatically.
+     * @param {string} [options.apiEndpoint] - The domain name of the
+     *     API remote host.
+     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
+     *     Follows the structure of {@link gapicConfig}.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
+     *     For more information, please check the
+     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
+     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
+     *     need to avoid loading the default gRPC version and want to use the fallback
+     *     HTTP implementation. Load only fallback version and pass it to the constructor:
+     *     ```
+     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
+     *     const client = new VehicleServiceClient({fallback: true}, gax);
+     *     ```
+     */
+    constructor(opts, gaxInstance) {
+        var _a, _b, _c, _d, _e;
+        this._terminated = false;
+        this.descriptors = {
+            page: {},
+            stream: {},
+            longrunning: {},
+            batching: {},
+        };
+        // Ensure that options include all the required fields.
+        const staticMembers = this.constructor;
+        if ((opts === null || opts === void 0 ? void 0 : opts.universe_domain) && (opts === null || opts === void 0 ? void 0 : opts.universeDomain) && (opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== (opts === null || opts === void 0 ? void 0 : opts.universeDomain)) {
+            throw new Error('Please set either universe_domain or universeDomain, but not both.');
+        }
+        const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
+        this._universeDomain = (_c = (_b = (_a = opts === null || opts === void 0 ? void 0 : opts.universeDomain) !== null && _a !== void 0 ? _a : opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== null && _b !== void 0 ? _b : universeDomainEnvVar) !== null && _c !== void 0 ? _c : 'googleapis.com';
+        this._servicePath = 'fleetengine.' + this._universeDomain;
+        const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || this._servicePath;
+        this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
+        const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
+        const clientConfig = (_d = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _d !== void 0 ? _d : {};
+        const fallback = (_e = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _e !== void 0 ? _e : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
+        opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
+        // Request numeric enum values if REST transport is used.
+        opts.numericEnums = true;
+        // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
+        if (servicePath !== this._servicePath && !('scopes' in opts)) {
+            opts['scopes'] = staticMembers.scopes;
+        }
+        // Load google-gax module synchronously if needed
+        if (!gaxInstance) {
+            gaxInstance = require('google-gax');
+        }
+        // Choose either gRPC or proto-over-HTTP implementation of google-gax.
+        this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
+        // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
+        this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
+        // Save options to use in initialize() method.
+        this._opts = opts;
+        // Save the auth object to the client, for use by other methods.
+        this.auth = this._gaxGrpc.auth;
+        // Set useJWTAccessWithScope on the auth object.
+        this.auth.useJWTAccessWithScope = true;
+        // Set defaultServicePath on the auth object.
+        this.auth.defaultServicePath = this._servicePath;
+        // Set the default scopes in auth client if needed.
+        if (servicePath === this._servicePath) {
+            this.auth.defaultScopes = staticMembers.scopes;
+        }
+        // Determine the client header string.
+        const clientHeader = [
+            `gax/${this._gaxModule.version}`,
+            `gapic/${version}`,
+        ];
+        if (typeof process === 'object' && 'versions' in process) {
+            clientHeader.push(`gl-node/${process.versions.node}`);
+        }
+        else {
+            clientHeader.push(`gl-web/${this._gaxModule.version}`);
+        }
+        if (!opts.fallback) {
+            clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
+        }
+        else {
+            clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
+        }
+        if (opts.libName && opts.libVersion) {
+            clientHeader.push(`${opts.libName}/${opts.libVersion}`);
+        }
+        // Load the applicable protos.
+        this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
+        // This API contains "path templates"; forward-slash-separated
+        // identifiers to uniquely identify resources within the API.
+        // Create useful helper objects for these.
+        this.pathTemplates = {
+            tripPathTemplate: new this._gaxModule.PathTemplate('providers/{provider}/trips/{trip}'),
+            vehiclePathTemplate: new this._gaxModule.PathTemplate('providers/{provider}/vehicles/{vehicle}'),
+        };
+        // Some of the methods on this service return "paged" results,
+        // (e.g. 50 results at a time, with tokens to get subsequent
+        // pages). Denote the keys used for pagination and results.
+        this.descriptors.page = {
+            listVehicles: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'vehicles')
+        };
+        // Put together the default options sent with requests.
+        this._defaults = this._gaxGrpc.constructSettings('maps.fleetengine.v1.VehicleService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
+        // Set up a dictionary of "inner API calls"; the core implementation
+        // of calling the API is handled in `google-gax`, with this code
+        // merely providing the destination and request information.
+        this.innerApiCalls = {};
+        // Add a warn function to the client constructor so it can be easily tested.
+        this.warn = this._gaxModule.warn;
+    }
+    /**
+     * Initialize the client.
+     * Performs asynchronous operations (such as authentication) and prepares the client.
+     * This function will be called automatically when any class method is called for the
+     * first time, but if you need to initialize it before calling an actual method,
+     * feel free to call initialize() directly.
+     *
+     * You can await on this method if you want to make sure the client is initialized.
+     *
+     * @returns {Promise} A promise that resolves to an authenticated service stub.
+     */
+    initialize() {
+        // If the client stub promise is already initialized, return immediately.
+        if (this.vehicleServiceStub) {
+            return this.vehicleServiceStub;
+        }
+        // Put together the "service stub" for
+        // maps.fleetengine.v1.VehicleService.
+        this.vehicleServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
+            this._protos.lookupService('maps.fleetengine.v1.VehicleService') :
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            this._protos.maps.fleetengine.v1.VehicleService, this._opts, this._providedCustomServicePath);
+        // Iterate over each of the methods that the service provides
+        // and create an API call method for each.
+        const vehicleServiceStubMethods = ['createVehicle', 'getVehicle', 'updateVehicle', 'updateVehicleLocation', 'updateVehicleAttributes', 'listVehicles', 'searchVehicles', 'searchFuzzedVehicles'];
+        for (const methodName of vehicleServiceStubMethods) {
+            const callPromise = this.vehicleServiceStub.then(stub => (...args) => {
+                if (this._terminated) {
+                    return Promise.reject('The client has already been closed.');
+                }
+                const func = stub[methodName];
+                return func.apply(stub, args);
+            }, (err) => () => {
+                throw err;
+            });
+            const descriptor = this.descriptors.page[methodName] ||
+                undefined;
+            const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
+            this.innerApiCalls[methodName] = apiCall;
+        }
+        return this.vehicleServiceStub;
+    }
+    /**
+     * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath() {
+        if (typeof process === 'object' && typeof process.emitWarning === 'function') {
+            process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
+        }
+        return 'fleetengine.googleapis.com';
+    }
+    /**
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint() {
+        if (typeof process === 'object' && typeof process.emitWarning === 'function') {
+            process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
+        }
+        return 'fleetengine.googleapis.com';
+    }
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint() {
+        return this._servicePath;
+    }
+    get universeDomain() {
+        return this._universeDomain;
+    }
+    /**
+     * The port for this API service.
+     * @returns {number} The default port for this service.
+     */
+    static get port() {
+        return 443;
+    }
+    /**
+     * The scopes needed to make gRPC calls for every method defined
+     * in this service.
+     * @returns {string[]} List of default scopes.
+     */
+    static get scopes() {
+        return [
+            'https://www.googleapis.com/auth/cloud-platform'
+        ];
+    }
+    /**
+     * Return the project ID used by this class.
+     * @returns {Promise} A promise that resolves to string containing the project ID.
+     */
+    getProjectId(callback) {
+        if (callback) {
+            this.auth.getProjectId(callback);
+            return;
+        }
+        return this.auth.getProjectId();
+    }
+    createVehicle(request, optionsOrCallback, callback) {
+        var _a, _b;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        let routingParameter = {};
+        {
+            const fieldValue = request.parent;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<provider_id>providers/[^/]+)'));
+                if (match) {
+                    const parameterValue = (_b = (_a = match.groups) === null || _a === void 0 ? void 0 : _a['provider_id']) !== null && _b !== void 0 ? _b : fieldValue;
+                    Object.assign(routingParameter, { provider_id: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize();
+        return this.innerApiCalls.createVehicle(request, options, callback);
+    }
+    getVehicle(request, optionsOrCallback, callback) {
+        var _a, _b;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        let routingParameter = {};
+        {
+            const fieldValue = request.name;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<provider_id>providers/[^/]+)'));
+                if (match) {
+                    const parameterValue = (_b = (_a = match.groups) === null || _a === void 0 ? void 0 : _a['provider_id']) !== null && _b !== void 0 ? _b : fieldValue;
+                    Object.assign(routingParameter, { provider_id: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize();
+        return this.innerApiCalls.getVehicle(request, options, callback);
+    }
+    updateVehicle(request, optionsOrCallback, callback) {
+        var _a, _b;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        let routingParameter = {};
+        {
+            const fieldValue = request.name;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<provider_id>providers/[^/]+)'));
+                if (match) {
+                    const parameterValue = (_b = (_a = match.groups) === null || _a === void 0 ? void 0 : _a['provider_id']) !== null && _b !== void 0 ? _b : fieldValue;
+                    Object.assign(routingParameter, { provider_id: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize();
+        return this.innerApiCalls.updateVehicle(request, options, callback);
+    }
+    updateVehicleLocation(request, optionsOrCallback, callback) {
+        var _a, _b;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        let routingParameter = {};
+        {
+            const fieldValue = request.name;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<provider_id>providers/[^/]+)'));
+                if (match) {
+                    const parameterValue = (_b = (_a = match.groups) === null || _a === void 0 ? void 0 : _a['provider_id']) !== null && _b !== void 0 ? _b : fieldValue;
+                    Object.assign(routingParameter, { provider_id: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize();
+        this.warn('DEP$VehicleService-$UpdateVehicleLocation', 'UpdateVehicleLocation is deprecated and may be removed in a future version.', 'DeprecationWarning');
+        return this.innerApiCalls.updateVehicleLocation(request, options, callback);
+    }
+    updateVehicleAttributes(request, optionsOrCallback, callback) {
+        var _a, _b;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        let routingParameter = {};
+        {
+            const fieldValue = request.name;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<provider_id>providers/[^/]+)'));
+                if (match) {
+                    const parameterValue = (_b = (_a = match.groups) === null || _a === void 0 ? void 0 : _a['provider_id']) !== null && _b !== void 0 ? _b : fieldValue;
+                    Object.assign(routingParameter, { provider_id: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize();
+        return this.innerApiCalls.updateVehicleAttributes(request, options, callback);
+    }
+    searchVehicles(request, optionsOrCallback, callback) {
+        var _a, _b;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        let routingParameter = {};
+        {
+            const fieldValue = request.parent;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<provider_id>providers/[^/]+)'));
+                if (match) {
+                    const parameterValue = (_b = (_a = match.groups) === null || _a === void 0 ? void 0 : _a['provider_id']) !== null && _b !== void 0 ? _b : fieldValue;
+                    Object.assign(routingParameter, { provider_id: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize();
+        return this.innerApiCalls.searchVehicles(request, options, callback);
+    }
+    searchFuzzedVehicles(request, optionsOrCallback, callback) {
+        var _a, _b;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        let routingParameter = {};
+        {
+            const fieldValue = request.parent;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<provider_id>providers/[^/]+)'));
+                if (match) {
+                    const parameterValue = (_b = (_a = match.groups) === null || _a === void 0 ? void 0 : _a['provider_id']) !== null && _b !== void 0 ? _b : fieldValue;
+                    Object.assign(routingParameter, { provider_id: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize();
+        this.warn('DEP$VehicleService-$SearchFuzzedVehicles', 'SearchFuzzedVehicles is deprecated and may be removed in a future version.', 'DeprecationWarning');
+        return this.innerApiCalls.searchFuzzedVehicles(request, options, callback);
+    }
+    listVehicles(request, optionsOrCallback, callback) {
+        var _a, _b;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        let routingParameter = {};
+        {
+            const fieldValue = request.parent;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<provider_id>providers/[^/]+)'));
+                if (match) {
+                    const parameterValue = (_b = (_a = match.groups) === null || _a === void 0 ? void 0 : _a['provider_id']) !== null && _b !== void 0 ? _b : fieldValue;
+                    Object.assign(routingParameter, { provider_id: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize();
+        return this.innerApiCalls.listVehicles(request, options, callback);
+    }
+    /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @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 {Stream}
+     *   An object stream which emits an object representing {@link protos.maps.fleetengine.v1.Vehicle|Vehicle} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. 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.
+     */
+    listVehiclesStream(request, options) {
+        var _a, _b;
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        let routingParameter = {};
+        {
+            const fieldValue = request.parent;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<provider_id>providers/[^/]+)'));
+                if (match) {
+                    const parameterValue = (_b = (_a = match.groups) === null || _a === void 0 ? void 0 : _a['provider_id']) !== null && _b !== void 0 ? _b : fieldValue;
+                    Object.assign(routingParameter, { provider_id: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams(routingParameter);
+        const defaultCallSettings = this._defaults['listVehicles'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize();
+        return this.descriptors.page.listVehicles.createStream(this.innerApiCalls.listVehicles, request, callSettings);
+    }
+    /**
+     * Equivalent to `listVehicles`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @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 {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.maps.fleetengine.v1.Vehicle|Vehicle}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vehicle_service.list_vehicles.js</caption>
+     * region_tag:fleetengine_v1_generated_VehicleService_ListVehicles_async
+     */
+    listVehiclesAsync(request, options) {
+        var _a, _b;
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        let routingParameter = {};
+        {
+            const fieldValue = request.parent;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<provider_id>providers/[^/]+)'));
+                if (match) {
+                    const parameterValue = (_b = (_a = match.groups) === null || _a === void 0 ? void 0 : _a['provider_id']) !== null && _b !== void 0 ? _b : fieldValue;
+                    Object.assign(routingParameter, { provider_id: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams(routingParameter);
+        const defaultCallSettings = this._defaults['listVehicles'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize();
+        return this.descriptors.page.listVehicles.asyncIterate(this.innerApiCalls['listVehicles'], request, callSettings);
+    }
+    // --------------------
+    // -- Path templates --
+    // --------------------
+    /**
+     * Return a fully-qualified trip resource name string.
+     *
+     * @param {string} provider
+     * @param {string} trip
+     * @returns {string} Resource name string.
+     */
+    tripPath(provider, trip) {
+        return this.pathTemplates.tripPathTemplate.render({
+            provider: provider,
+            trip: trip,
+        });
+    }
+    /**
+     * Parse the provider from Trip resource.
+     *
+     * @param {string} tripName
+     *   A fully-qualified path representing Trip resource.
+     * @returns {string} A string representing the provider.
+     */
+    matchProviderFromTripName(tripName) {
+        return this.pathTemplates.tripPathTemplate.match(tripName).provider;
+    }
+    /**
+     * Parse the trip from Trip resource.
+     *
+     * @param {string} tripName
+     *   A fully-qualified path representing Trip resource.
+     * @returns {string} A string representing the trip.
+     */
+    matchTripFromTripName(tripName) {
+        return this.pathTemplates.tripPathTemplate.match(tripName).trip;
+    }
+    /**
+     * Return a fully-qualified vehicle resource name string.
+     *
+     * @param {string} provider
+     * @param {string} vehicle
+     * @returns {string} Resource name string.
+     */
+    vehiclePath(provider, vehicle) {
+        return this.pathTemplates.vehiclePathTemplate.render({
+            provider: provider,
+            vehicle: vehicle,
+        });
+    }
+    /**
+     * Parse the provider from Vehicle resource.
+     *
+     * @param {string} vehicleName
+     *   A fully-qualified path representing Vehicle resource.
+     * @returns {string} A string representing the provider.
+     */
+    matchProviderFromVehicleName(vehicleName) {
+        return this.pathTemplates.vehiclePathTemplate.match(vehicleName).provider;
+    }
+    /**
+     * Parse the vehicle from Vehicle resource.
+     *
+     * @param {string} vehicleName
+     *   A fully-qualified path representing Vehicle resource.
+     * @returns {string} A string representing the vehicle.
+     */
+    matchVehicleFromVehicleName(vehicleName) {
+        return this.pathTemplates.vehiclePathTemplate.match(vehicleName).vehicle;
+    }
+    /**
+     * Terminate the gRPC channel and close the client.
+     *
+     * The client will no longer be usable and all future behavior is undefined.
+     * @returns {Promise} A promise that resolves when the client is closed.
+     */
+    close() {
+        if (this.vehicleServiceStub && !this._terminated) {
+            return this.vehicleServiceStub.then(stub => {
+                this._terminated = true;
+                stub.close();
+            });
+        }
+        return Promise.resolve();
+    }
+}
+exports.VehicleServiceClient = VehicleServiceClient;
+//# sourceMappingURL=vehicle_service_client.js.map