Google Maps FleetEngine V1 Client - Class VehicleServiceClient (0.1.2)

Namespace

Methods

__construct

createVehicle

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\V1\Client\VehicleServiceClient;
use Google\Maps\FleetEngine\V1\CreateVehicleRequest;
use Google\Maps\FleetEngine\V1\Vehicle;
use Google\Maps\FleetEngine\V1\Vehicle\VehicleType;

/**
 * @param string $parent    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 string $vehicleId 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]
 *                          (http://www.unicode.org/reports/tr15/).
 *                          * May not contain any of the following ASCII characters: '/', ':', '?',
 *                          ',', or '#'.
 */
function create_vehicle_sample(string $parent, string $vehicleId): void
{
    // Create a client.
    $vehicleServiceClient = new VehicleServiceClient();

    // Prepare the request message.
    $vehicleVehicleType = new VehicleType();
    $vehicle = (new Vehicle())
        ->setVehicleType($vehicleVehicleType);
    $request = (new CreateVehicleRequest())
        ->setParent($parent)
        ->setVehicleId($vehicleId)
        ->setVehicle($vehicle);

    // Call the API and handle any network failures.
    try {
        /** @var Vehicle $response */
        $response = $vehicleServiceClient->createVehicle($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $parent = '[PARENT]';
    $vehicleId = '[VEHICLE_ID]';

    create_vehicle_sample($parent, $vehicleId);
}

getVehicle

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\V1\Client\VehicleServiceClient;
use Google\Maps\FleetEngine\V1\GetVehicleRequest;
use Google\Maps\FleetEngine\V1\Vehicle;

/**
 * @param string $formattedName Must be in the format
 *                              `providers/{provider}/vehicles/{vehicle}`.
 *                              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. Please see
 *                              {@see VehicleServiceClient::vehicleName()} for help formatting this field.
 */
function get_vehicle_sample(string $formattedName): void
{
    // Create a client.
    $vehicleServiceClient = new VehicleServiceClient();

    // Prepare the request message.
    $request = (new GetVehicleRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Vehicle $response */
        $response = $vehicleServiceClient->getVehicle($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = VehicleServiceClient::vehicleName('[PROVIDER]', '[VEHICLE]');

    get_vehicle_sample($formattedName);
}

listVehicles

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Maps\FleetEngine\V1\Client\VehicleServiceClient;
use Google\Maps\FleetEngine\V1\ListVehiclesRequest;
use Google\Maps\FleetEngine\V1\Vehicle;
use Google\Maps\FleetEngine\V1\Vehicle\VehicleType\Category;

/**
 * @param string $parent                       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 int    $vehicleTypeCategoriesElement Restricts the response to vehicles with one of the specified type
 *                                             categories. `UNKNOWN` is not allowed.
 */
function list_vehicles_sample(string $parent, int $vehicleTypeCategoriesElement): void
{
    // Create a client.
    $vehicleServiceClient = new VehicleServiceClient();

    // Prepare the request message.
    $vehicleTypeCategories = [$vehicleTypeCategoriesElement,];
    $request = (new ListVehiclesRequest())
        ->setParent($parent)
        ->setVehicleTypeCategories($vehicleTypeCategories);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $vehicleServiceClient->listVehicles($request);

        /** @var Vehicle $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $parent = '[PARENT]';
    $vehicleTypeCategoriesElement = Category::UNKNOWN;

    list_vehicles_sample($parent, $vehicleTypeCategoriesElement);
}

searchVehicles

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\V1\Client\VehicleServiceClient;
use Google\Maps\FleetEngine\V1\SearchVehiclesRequest;
use Google\Maps\FleetEngine\V1\SearchVehiclesRequest\VehicleMatchOrder;
use Google\Maps\FleetEngine\V1\SearchVehiclesResponse;
use Google\Maps\FleetEngine\V1\TerminalLocation;
use Google\Maps\FleetEngine\V1\TripType;
use Google\Maps\FleetEngine\V1\Vehicle\VehicleType;
use Google\Type\LatLng;

/**
 * @param string $parent             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 int    $pickupRadiusMeters Defines the vehicle search radius around the pickup point. Only
 *                                   vehicles within the search radius will be returned. Value must be between
 *                                   400 and 10000 meters (inclusive).
 * @param int    $count              Specifies the maximum number of vehicles to return. The value
 *                                   must be between 1 and 50 (inclusive).
 * @param int    $minimumCapacity    Specifies the number of passengers being considered for a trip.
 *                                   The value must be greater than or equal to one. The driver is not
 *                                   considered in the capacity value.
 * @param int    $tripTypesElement   Represents the type of proposed trip. Must include exactly one
 *                                   type. `UNKNOWN_TRIP_TYPE` is not allowed. Restricts the search to only
 *                                   those vehicles that can support that trip type.
 * @param int    $orderBy            Specifies the desired ordering criterion for results.
 */
function search_vehicles_sample(
    string $parent,
    int $pickupRadiusMeters,
    int $count,
    int $minimumCapacity,
    int $tripTypesElement,
    int $orderBy
): void {
    // Create a client.
    $vehicleServiceClient = new VehicleServiceClient();

    // Prepare the request message.
    $pickupPointPoint = new LatLng();
    $pickupPoint = (new TerminalLocation())
        ->setPoint($pickupPointPoint);
    $tripTypes = [$tripTypesElement,];
    $vehicleTypes = [new VehicleType()];
    $request = (new SearchVehiclesRequest())
        ->setParent($parent)
        ->setPickupPoint($pickupPoint)
        ->setPickupRadiusMeters($pickupRadiusMeters)
        ->setCount($count)
        ->setMinimumCapacity($minimumCapacity)
        ->setTripTypes($tripTypes)
        ->setVehicleTypes($vehicleTypes)
        ->setOrderBy($orderBy);

    // Call the API and handle any network failures.
    try {
        /** @var SearchVehiclesResponse $response */
        $response = $vehicleServiceClient->searchVehicles($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $parent = '[PARENT]';
    $pickupRadiusMeters = 0;
    $count = 0;
    $minimumCapacity = 0;
    $tripTypesElement = TripType::UNKNOWN_TRIP_TYPE;
    $orderBy = VehicleMatchOrder::UNKNOWN_VEHICLE_MATCH_ORDER;

    search_vehicles_sample(
        $parent,
        $pickupRadiusMeters,
        $count,
        $minimumCapacity,
        $tripTypesElement,
        $orderBy
    );
}

updateVehicle

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\V1\Client\VehicleServiceClient;
use Google\Maps\FleetEngine\V1\UpdateVehicleRequest;
use Google\Maps\FleetEngine\V1\Vehicle;
use Google\Maps\FleetEngine\V1\Vehicle\VehicleType;
use Google\Protobuf\FieldMask;

/**
 * @param string $name Must be in the format
 *                     `providers/{provider}/vehicles/{vehicle}`.
 *                     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.
 */
function update_vehicle_sample(string $name): void
{
    // Create a client.
    $vehicleServiceClient = new VehicleServiceClient();

    // Prepare the request message.
    $vehicleVehicleType = new VehicleType();
    $vehicle = (new Vehicle())
        ->setVehicleType($vehicleVehicleType);
    $updateMask = new FieldMask();
    $request = (new UpdateVehicleRequest())
        ->setName($name)
        ->setVehicle($vehicle)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Vehicle $response */
        $response = $vehicleServiceClient->updateVehicle($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $name = '[NAME]';

    update_vehicle_sample($name);
}

updateVehicleAttributes

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\V1\Client\VehicleServiceClient;
use Google\Maps\FleetEngine\V1\UpdateVehicleAttributesRequest;
use Google\Maps\FleetEngine\V1\UpdateVehicleAttributesResponse;
use Google\Maps\FleetEngine\V1\VehicleAttribute;

/**
 * @param string $name Must be in the format `providers/{provider}/vehicles/{vehicle}`.
 *                     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.
 */
function update_vehicle_attributes_sample(string $name): void
{
    // Create a client.
    $vehicleServiceClient = new VehicleServiceClient();

    // Prepare the request message.
    $attributes = [new VehicleAttribute()];
    $request = (new UpdateVehicleAttributesRequest())
        ->setName($name)
        ->setAttributes($attributes);

    // Call the API and handle any network failures.
    try {
        /** @var UpdateVehicleAttributesResponse $response */
        $response = $vehicleServiceClient->updateVehicleAttributes($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $name = '[NAME]';

    update_vehicle_attributes_sample($name);
}

createVehicleAsync

getVehicleAsync

listVehiclesAsync

searchVehiclesAsync

updateVehicleAsync

updateVehicleAttributesAsync

static::vehicleName

static::parseName