Google Maps FleetEngine V1 Client - Class TripServiceClient (0.1.2)

Namespace

Methods

__construct

createTrip

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\V1\Client\TripServiceClient;
use Google\Maps\FleetEngine\V1\CreateTripRequest;
use Google\Maps\FleetEngine\V1\Trip;

/**
 * @param string $formattedParent 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. Please see
 *                                {@see TripServiceClient::tripName()} for help formatting this field.
 * @param string $tripId          Unique Trip 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_trip_sample(string $formattedParent, string $tripId): void
{
    // Create a client.
    $tripServiceClient = new TripServiceClient();

    // Prepare the request message.
    $trip = new Trip();
    $request = (new CreateTripRequest())
        ->setParent($formattedParent)
        ->setTripId($tripId)
        ->setTrip($trip);

    // Call the API and handle any network failures.
    try {
        /** @var Trip $response */
        $response = $tripServiceClient->createTrip($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
{
    $formattedParent = TripServiceClient::tripName('[PROVIDER]', '[TRIP]');
    $tripId = '[TRIP_ID]';

    create_trip_sample($formattedParent, $tripId);
}

getTrip

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\V1\Client\TripServiceClient;
use Google\Maps\FleetEngine\V1\GetTripRequest;
use Google\Maps\FleetEngine\V1\Trip;

/**
 * @param string $formattedName Must be in the format `providers/{provider}/trips/{trip}`.
 *                              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 TripServiceClient::tripName()} for help formatting this field.
 */
function get_trip_sample(string $formattedName): void
{
    // Create a client.
    $tripServiceClient = new TripServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Trip $response */
        $response = $tripServiceClient->getTrip($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 = TripServiceClient::tripName('[PROVIDER]', '[TRIP]');

    get_trip_sample($formattedName);
}

reportBillableTrip

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\V1\Client\TripServiceClient;
use Google\Maps\FleetEngine\V1\ReportBillableTripRequest;

/**
 * @param string $name        Must be in the format
 *                            `providers/{provider}/billableTrips/{billable_trip}`. 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 $countryCode Two letter country code of the country where the trip takes
 *                            place. Price is defined according to country code.
 */
function report_billable_trip_sample(string $name, string $countryCode): void
{
    // Create a client.
    $tripServiceClient = new TripServiceClient();

    // Prepare the request message.
    $request = (new ReportBillableTripRequest())
        ->setName($name)
        ->setCountryCode($countryCode);

    // Call the API and handle any network failures.
    try {
        $tripServiceClient->reportBillableTrip($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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]';
    $countryCode = '[COUNTRY_CODE]';

    report_billable_trip_sample($name, $countryCode);
}

searchTrips

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Maps\FleetEngine\V1\Client\TripServiceClient;
use Google\Maps\FleetEngine\V1\SearchTripsRequest;
use Google\Maps\FleetEngine\V1\Trip;

/**
 * @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.
 */
function search_trips_sample(string $parent): void
{
    // Create a client.
    $tripServiceClient = new TripServiceClient();

    // Prepare the request message.
    $request = (new SearchTripsRequest())
        ->setParent($parent);

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

        /** @var Trip $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]';

    search_trips_sample($parent);
}

updateTrip

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\V1\Client\TripServiceClient;
use Google\Maps\FleetEngine\V1\Trip;
use Google\Maps\FleetEngine\V1\UpdateTripRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $name Must be in the format
 *                     `providers/{provider}/trips/{trip}`. The provider must
 *                     be the Project ID (for example, `sample-consumer-project`) of the Google
 *                     Cloud Project of which the service account making this call is a member.
 */
function update_trip_sample(string $name): void
{
    // Create a client.
    $tripServiceClient = new TripServiceClient();

    // Prepare the request message.
    $trip = new Trip();
    $updateMask = new FieldMask();
    $request = (new UpdateTripRequest())
        ->setName($name)
        ->setTrip($trip)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Trip $response */
        $response = $tripServiceClient->updateTrip($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_trip_sample($name);
}

createTripAsync

getTripAsync

reportBillableTripAsync

searchTripsAsync

updateTripAsync

static::tripName

static::parseName