Google Maps FleetEngine Delivery V1 Client - Class DeliveryServiceClient (0.1.1)

Namespace

Methods

__construct

batchCreateTasks

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\Delivery\V1\BatchCreateTasksRequest;
use Google\Maps\FleetEngine\Delivery\V1\BatchCreateTasksResponse;
use Google\Maps\FleetEngine\Delivery\V1\Client\DeliveryServiceClient;
use Google\Maps\FleetEngine\Delivery\V1\CreateTaskRequest;
use Google\Maps\FleetEngine\Delivery\V1\Task;
use Google\Maps\FleetEngine\Delivery\V1\Task\State;
use Google\Maps\FleetEngine\Delivery\V1\Task\Type;
use Google\Protobuf\Duration;

/**
 * @param string $formattedParent   The parent resource shared by all tasks. This value must be in
 *                                  the format `providers/{provider}`. The `provider` must be the Google Cloud
 *                                  Project ID. For example, `sample-cloud-project`. The parent field in the
 *                                  `CreateTaskRequest` messages must either  be empty, or it must match this
 *                                  field. Please see
 *                                  {@see DeliveryServiceClient::providerName()} for help formatting this field.
 * @param string $requestsParent    Must be in the format `providers/{provider}`. The `provider` must
 *                                  be the Google Cloud Project ID. For example, `sample-cloud-project`.
 * @param string $requestsTaskId    The Task ID must be unique, but it should be not a shipment
 *                                  tracking ID. To store a shipment tracking ID, use the `tracking_id` field.
 *                                  Note that multiple tasks can have the same `tracking_id`. Task IDs are
 *                                  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 '#'.
 * @param int    $requestsTaskType  Immutable. Defines the type of the Task. For example, a break or
 *                                  shipment.
 * @param int    $requestsTaskState The current execution state of the Task.
 */
function batch_create_tasks_sample(
    string $formattedParent,
    string $requestsParent,
    string $requestsTaskId,
    int $requestsTaskType,
    int $requestsTaskState
): void {
    // Create a client.
    $deliveryServiceClient = new DeliveryServiceClient();

    // Prepare the request message.
    $requestsTaskTaskDuration = new Duration();
    $requestsTask = (new Task())
        ->setType($requestsTaskType)
        ->setState($requestsTaskState)
        ->setTaskDuration($requestsTaskTaskDuration);
    $createTaskRequest = (new CreateTaskRequest())
        ->setParent($requestsParent)
        ->setTaskId($requestsTaskId)
        ->setTask($requestsTask);
    $requests = [$createTaskRequest,];
    $request = (new BatchCreateTasksRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateTasksResponse $response */
        $response = $deliveryServiceClient->batchCreateTasks($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 = DeliveryServiceClient::providerName('[PROVIDER]');
    $requestsParent = '[PARENT]';
    $requestsTaskId = '[TASK_ID]';
    $requestsTaskType = Type::TYPE_UNSPECIFIED;
    $requestsTaskState = State::STATE_UNSPECIFIED;

    batch_create_tasks_sample(
        $formattedParent,
        $requestsParent,
        $requestsTaskId,
        $requestsTaskType,
        $requestsTaskState
    );
}

createDeliveryVehicle

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\Delivery\V1\Client\DeliveryServiceClient;
use Google\Maps\FleetEngine\Delivery\V1\CreateDeliveryVehicleRequest;
use Google\Maps\FleetEngine\Delivery\V1\DeliveryVehicle;

/**
 * @param string $parent            Must be in the format `providers/{provider}`. The provider must
 *                                  be the Google Cloud Project ID. For example, `sample-cloud-project`.
 * @param string $deliveryVehicleId The Delivery Vehicle ID must be unique and 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_delivery_vehicle_sample(string $parent, string $deliveryVehicleId): void
{
    // Create a client.
    $deliveryServiceClient = new DeliveryServiceClient();

    // Prepare the request message.
    $deliveryVehicle = new DeliveryVehicle();
    $request = (new CreateDeliveryVehicleRequest())
        ->setParent($parent)
        ->setDeliveryVehicleId($deliveryVehicleId)
        ->setDeliveryVehicle($deliveryVehicle);

    // Call the API and handle any network failures.
    try {
        /** @var DeliveryVehicle $response */
        $response = $deliveryServiceClient->createDeliveryVehicle($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]';
    $deliveryVehicleId = '[DELIVERY_VEHICLE_ID]';

    create_delivery_vehicle_sample($parent, $deliveryVehicleId);
}

createTask

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\Delivery\V1\Client\DeliveryServiceClient;
use Google\Maps\FleetEngine\Delivery\V1\CreateTaskRequest;
use Google\Maps\FleetEngine\Delivery\V1\Task;
use Google\Maps\FleetEngine\Delivery\V1\Task\State;
use Google\Maps\FleetEngine\Delivery\V1\Task\Type;
use Google\Protobuf\Duration;

/**
 * @param string $parent    Must be in the format `providers/{provider}`. The `provider` must
 *                          be the Google Cloud Project ID. For example, `sample-cloud-project`.
 * @param string $taskId    The Task ID must be unique, but it should be not a shipment
 *                          tracking ID. To store a shipment tracking ID, use the `tracking_id` field.
 *                          Note that multiple tasks can have the same `tracking_id`. Task IDs are
 *                          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 '#'.
 * @param int    $taskType  Immutable. Defines the type of the Task. For example, a break or
 *                          shipment.
 * @param int    $taskState The current execution state of the Task.
 */
function create_task_sample(string $parent, string $taskId, int $taskType, int $taskState): void
{
    // Create a client.
    $deliveryServiceClient = new DeliveryServiceClient();

    // Prepare the request message.
    $taskTaskDuration = new Duration();
    $task = (new Task())
        ->setType($taskType)
        ->setState($taskState)
        ->setTaskDuration($taskTaskDuration);
    $request = (new CreateTaskRequest())
        ->setParent($parent)
        ->setTaskId($taskId)
        ->setTask($task);

    // Call the API and handle any network failures.
    try {
        /** @var Task $response */
        $response = $deliveryServiceClient->createTask($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]';
    $taskId = '[TASK_ID]';
    $taskType = Type::TYPE_UNSPECIFIED;
    $taskState = State::STATE_UNSPECIFIED;

    create_task_sample($parent, $taskId, $taskType, $taskState);
}

getDeliveryVehicle

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\Delivery\V1\Client\DeliveryServiceClient;
use Google\Maps\FleetEngine\Delivery\V1\DeliveryVehicle;
use Google\Maps\FleetEngine\Delivery\V1\GetDeliveryVehicleRequest;

/**
 * @param string $formattedName Must be in the format
 *                              `providers/{provider}/deliveryVehicles/{delivery_vehicle}`.
 *                              The `provider` must be the Google Cloud Project ID. For example,
 *                              `sample-cloud-project`. Please see
 *                              {@see DeliveryServiceClient::deliveryVehicleName()} for help formatting this field.
 */
function get_delivery_vehicle_sample(string $formattedName): void
{
    // Create a client.
    $deliveryServiceClient = new DeliveryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DeliveryVehicle $response */
        $response = $deliveryServiceClient->getDeliveryVehicle($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 = DeliveryServiceClient::deliveryVehicleName('[PROVIDER]', '[VEHICLE]');

    get_delivery_vehicle_sample($formattedName);
}

getTask

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\Delivery\V1\Client\DeliveryServiceClient;
use Google\Maps\FleetEngine\Delivery\V1\GetTaskRequest;
use Google\Maps\FleetEngine\Delivery\V1\Task;

/**
 * @param string $formattedName Must be in the format `providers/{provider}/tasks/{task}`. The
 *                              `provider` must be the Google Cloud Project ID. For example,
 *                              `sample-cloud-project`. Please see
 *                              {@see DeliveryServiceClient::taskName()} for help formatting this field.
 */
function get_task_sample(string $formattedName): void
{
    // Create a client.
    $deliveryServiceClient = new DeliveryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Task $response */
        $response = $deliveryServiceClient->getTask($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 = DeliveryServiceClient::taskName('[PROVIDER]', '[TASK]');

    get_task_sample($formattedName);
}

getTaskTrackingInfo

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\Delivery\V1\Client\DeliveryServiceClient;
use Google\Maps\FleetEngine\Delivery\V1\GetTaskTrackingInfoRequest;
use Google\Maps\FleetEngine\Delivery\V1\TaskTrackingInfo;

/**
 * @param string $formattedName Must be in the format
 *                              `providers/{provider}/taskTrackingInfo/{tracking_id}`. The `provider`
 *                              must be the Google Cloud Project ID, and the `tracking_id` must be the
 *                              tracking ID associated with the task. An example name can be
 *                              `providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id`. Please see
 *                              {@see DeliveryServiceClient::taskTrackingInfoName()} for help formatting this field.
 */
function get_task_tracking_info_sample(string $formattedName): void
{
    // Create a client.
    $deliveryServiceClient = new DeliveryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var TaskTrackingInfo $response */
        $response = $deliveryServiceClient->getTaskTrackingInfo($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 = DeliveryServiceClient::taskTrackingInfoName('[PROVIDER]', '[TRACKING]');

    get_task_tracking_info_sample($formattedName);
}

listDeliveryVehicles

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Maps\FleetEngine\Delivery\V1\Client\DeliveryServiceClient;
use Google\Maps\FleetEngine\Delivery\V1\DeliveryVehicle;
use Google\Maps\FleetEngine\Delivery\V1\ListDeliveryVehiclesRequest;

/**
 * @param string $formattedParent Must be in the format `providers/{provider}`.
 *                                The `provider` must be the Google Cloud Project ID.
 *                                For example, `sample-cloud-project`. Please see
 *                                {@see DeliveryServiceClient::providerName()} for help formatting this field.
 */
function list_delivery_vehicles_sample(string $formattedParent): void
{
    // Create a client.
    $deliveryServiceClient = new DeliveryServiceClient();

    // Prepare the request message.
    $request = (new ListDeliveryVehiclesRequest())
        ->setParent($formattedParent);

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

        /** @var DeliveryVehicle $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
{
    $formattedParent = DeliveryServiceClient::providerName('[PROVIDER]');

    list_delivery_vehicles_sample($formattedParent);
}

listTasks

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Maps\FleetEngine\Delivery\V1\Client\DeliveryServiceClient;
use Google\Maps\FleetEngine\Delivery\V1\ListTasksRequest;
use Google\Maps\FleetEngine\Delivery\V1\Task;

/**
 * @param string $formattedParent Must be in the format `providers/{provider}`.
 *                                The `provider` must be the Google Cloud Project ID. For example,
 *                                `sample-cloud-project`. Please see
 *                                {@see DeliveryServiceClient::providerName()} for help formatting this field.
 */
function list_tasks_sample(string $formattedParent): void
{
    // Create a client.
    $deliveryServiceClient = new DeliveryServiceClient();

    // Prepare the request message.
    $request = (new ListTasksRequest())
        ->setParent($formattedParent);

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

        /** @var Task $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
{
    $formattedParent = DeliveryServiceClient::providerName('[PROVIDER]');

    list_tasks_sample($formattedParent);
}

updateDeliveryVehicle

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\Delivery\V1\Client\DeliveryServiceClient;
use Google\Maps\FleetEngine\Delivery\V1\DeliveryVehicle;
use Google\Maps\FleetEngine\Delivery\V1\UpdateDeliveryVehicleRequest;
use Google\Protobuf\FieldMask;

/**
 * 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 update_delivery_vehicle_sample(): void
{
    // Create a client.
    $deliveryServiceClient = new DeliveryServiceClient();

    // Prepare the request message.
    $deliveryVehicle = new DeliveryVehicle();
    $updateMask = new FieldMask();
    $request = (new UpdateDeliveryVehicleRequest())
        ->setDeliveryVehicle($deliveryVehicle)
        ->setUpdateMask($updateMask);

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

updateTask

use Google\ApiCore\ApiException;
use Google\Maps\FleetEngine\Delivery\V1\Client\DeliveryServiceClient;
use Google\Maps\FleetEngine\Delivery\V1\Task;
use Google\Maps\FleetEngine\Delivery\V1\Task\State;
use Google\Maps\FleetEngine\Delivery\V1\Task\Type;
use Google\Maps\FleetEngine\Delivery\V1\UpdateTaskRequest;
use Google\Protobuf\Duration;
use Google\Protobuf\FieldMask;

/**
 * @param int $taskType  Immutable. Defines the type of the Task. For example, a break or
 *                       shipment.
 * @param int $taskState The current execution state of the Task.
 */
function update_task_sample(int $taskType, int $taskState): void
{
    // Create a client.
    $deliveryServiceClient = new DeliveryServiceClient();

    // Prepare the request message.
    $taskTaskDuration = new Duration();
    $task = (new Task())
        ->setType($taskType)
        ->setState($taskState)
        ->setTaskDuration($taskTaskDuration);
    $updateMask = new FieldMask();
    $request = (new UpdateTaskRequest())
        ->setTask($task)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Task $response */
        $response = $deliveryServiceClient->updateTask($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
{
    $taskType = Type::TYPE_UNSPECIFIED;
    $taskState = State::STATE_UNSPECIFIED;

    update_task_sample($taskType, $taskState);
}

batchCreateTasksAsync

createDeliveryVehicleAsync

createTaskAsync

getDeliveryVehicleAsync

getTaskAsync

getTaskTrackingInfoAsync

listDeliveryVehiclesAsync

listTasksAsync

updateDeliveryVehicleAsync

updateTaskAsync

static::deliveryVehicleName

static::providerName

static::taskName

static::taskTrackingInfoName

static::parseName