Créer des tâches HTTP Target

Avec cette version de HTTP Target, les gestionnaires Cloud Tasks peuvent désormais être exécutés sur n'importe quel point de terminaison HTTP doté d'une adresse IP publique, par exemple Cloud Functions, Cloud Run, GKE, Compute Engine ou même un serveur Web sur site. Vous pouvez exécuter vos tâches sur n'importe lequel de ces services de manière fiable et configurable.

Cette page montre comment créer de façon automatisée des tâches HTTP Target et comment les placer dans des files d'attente Cloud Tasks.

Si vous avez choisi de spécifier un nom pour la tâche, Cloud Tasks peut l'utiliser pour garantir la déduplication des tâches, même si le traitement nécessaire peut augmenter la latence.

En général, vous créez des tâches sous la forme d'une requête HTTP. L'utilisation des bibliothèques clientes et d'un compte de service, comme dans les exemples suivants, peut vous aider à gérer les détails de la communication avec le serveur Cloud Tasks et à créer plus facilement des tâches.

Créer des tâches HTTP Target

Pour les tâches comportant des cibles HTTP, il existe deux façons de les créer.

  • Méthode BufferTask (aperçu):utilisez cette méthode si votre file d'attente est configurée pour mettre en mémoire tampon des tâches devant un service. La file d'attente doit avoir un routage au niveau de la file d'attente.

  • Méthode CreateTask:cette méthode est plus complexe. Vous devez créer explicitement un objet de tâche. Utilisez cette méthode si les tâches de votre file d'attente ont des configurations de routage différentes. Dans ce cas, vous spécifiez le routage au niveau de la tâche.

Méthode BufferTask

Pour utiliser la méthode BufferTask, votre file d'attente doit utiliser le routage au niveau de la file d'attente. Sinon, la tâche ne comporte aucune information de routage. Si votre file d'attente n'utilise pas déjà le routage au niveau de la file d'attente, consultez la section Configurer le routage au niveau de la file d'attente pour les tâches HTTP.

Vous pouvez utiliser la méthode BufferTask dans une bibliothèque cliente, ou bien votre application effectue des requêtes HTTP. L'exemple suivant suit la méthode BufferTask pour créer une tâche à l'aide de curl.

  curl -X HTTP_METHOD\
   "https://cloudtasks.googleapis.com/v2beta3/projects/PROJECT_ID/locations/LOCATION/queues/QUEUE_ID/tasks:buffer" \

Remplacez les éléments suivants :

  • HTTP_METHOD: méthode HTTP de votre requête, par exemple GET ou POST.
  • PROJECT_ID : ID de votre projet Google Cloud. Pour l'obtenir, exécutez la commande suivante dans votre terminal: 
    gcloud config get-value project
  • LOCATION: emplacement de votre file d'attente.
  • QUEUE_ID: ID de la file d'attente.

Méthode CreateTask

Pour créer une tâche à l'aide de la méthode CreateTask, vous devez créer et définir explicitement l'objet de tâche. Vous devez spécifier le service et le gestionnaire qui traitent la tâche.

Vous pouvez éventuellement transmettre des données spécifiques à une tâche au gestionnaire. Vous pouvez également affiner la configuration de la tâche, par exemple en planifiant une heure d'exécution ultérieure ou en limitant le nombre de nouvelles tentatives en cas d'échec de la tâche.

Les exemples suivants suivent la méthode CreateTask pour créer une tâche à l'aide des bibliothèques clientes Cloud Tasks.

C#

cloudtasks/api/TasksSample/CreateHttpTask.cs 

using Google.Cloud.Tasks.V2;
using Google.Protobuf;
using Google.Protobuf.WellKnownTypes;
using System;

class CreateHttpTask
{
    public string CreateTask(
        string projectId = "YOUR-PROJECT-ID",
        string location = "us-central1",
        string queue = "my-queue",
        string url = "http://example.com/taskhandler",
        string payload = "Hello World!",
        int inSeconds = 0)
    {
        CloudTasksClient client = CloudTasksClient.Create();
        QueueName parent = new QueueName(projectId, location, queue);

        var response = client.CreateTask(new CreateTaskRequest
        {
            Parent = parent.ToString(),
            Task = new Task
            {
                HttpRequest = new HttpRequest
                {
                    HttpMethod = HttpMethod.Post,
                    Url = url,
                    Body = ByteString.CopyFromUtf8(payload)
                },
                ScheduleTime = Timestamp.FromDateTime(
                    DateTime.UtcNow.AddSeconds(inSeconds))
            }
        });

        Console.WriteLine($"Created Task {response.Name}");
        return response.Name;
    }
}

Python

cloud_tasks/snippets/create_http_task.py 
import datetime
import json
from typing import Dict, Optional

from google.cloud import tasks_v2
from google.protobuf import duration_pb2, timestamp_pb2

def create_http_task(
    project: str,
    location: str,
    queue: str,
    url: str,
    json_payload: Dict,
    scheduled_seconds_from_now: Optional[int] = None,
    task_id: Optional[str] = None,
    deadline_in_seconds: Optional[int] = None,
) -> tasks_v2.Task:
    """Create an HTTP POST task with a JSON payload.
    Args:
        project: The project ID where the queue is located.
        location: The location where the queue is located.
        queue: The ID of the queue to add the task to.
        url: The target URL of the task.
        json_payload: The JSON payload to send.
        scheduled_seconds_from_now: Seconds from now to schedule the task for.
        task_id: ID to use for the newly created task.
        deadline_in_seconds: The deadline in seconds for task.
    Returns:
        The newly created task.
    """

    # Create a client.
    client = tasks_v2.CloudTasksClient()

    # Construct the task.
    task = tasks_v2.Task(
        http_request=tasks_v2.HttpRequest(
            http_method=tasks_v2.HttpMethod.POST,
            url=url,
            headers={"Content-type": "application/json"},
            body=json.dumps(json_payload).encode(),
        ),
        name=(
            client.task_path(project, location, queue, task_id)
            if task_id is not None
            else None
        ),
    )

    # Convert "seconds from now" to an absolute Protobuf Timestamp
    if scheduled_seconds_from_now is not None:
        timestamp = timestamp_pb2.Timestamp()
        timestamp.FromDatetime(
            datetime.datetime.utcnow()
            + datetime.timedelta(seconds=scheduled_seconds_from_now)
        )
        task.schedule_time = timestamp

    # Convert "deadline in seconds" to a Protobuf Duration
    if deadline_in_seconds is not None:
        duration = duration_pb2.Duration()
        duration.FromSeconds(deadline_in_seconds)
        task.dispatch_deadline = duration

    # Use the client to send a CreateTaskRequest.
    return client.create_task(
        tasks_v2.CreateTaskRequest(
            # The queue to add the task to
            parent=client.queue_path(project, location, queue),
            # The task itself
            task=task,
        )
    )

Notez le fichier requirements.txt :

cloud_tasks/snippets/requirements.txt 
google-cloud-tasks==2.13.1

Java

tasks/snippets/src/main/java/com/example/task/CreateHttpTask.java 
import com.google.cloud.tasks.v2.CloudTasksClient;
import com.google.cloud.tasks.v2.HttpMethod;
import com.google.cloud.tasks.v2.HttpRequest;
import com.google.cloud.tasks.v2.QueueName;
import com.google.cloud.tasks.v2.Task;
import com.google.protobuf.ByteString;
import java.io.IOException;
import java.nio.charset.Charset;

public class CreateHttpTask {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project-id";
    String locationId = "us-central1";
    String queueId = "my-queue";
    createTask(projectId, locationId, queueId);
  }

  // Create a task with a HTTP target using the Cloud Tasks client.
  public static void createTask(String projectId, String locationId, String queueId)
      throws IOException {

    // Instantiates a client.
    try (CloudTasksClient client = CloudTasksClient.create()) {
      String url = "https://example.com/taskhandler";
      String payload = "Hello, World!";

      // Construct the fully qualified queue name.
      String queuePath = QueueName.of(projectId, locationId, queueId).toString();

      // Construct the task body.
      Task.Builder taskBuilder =
          Task.newBuilder()
              .setHttpRequest(
                  HttpRequest.newBuilder()
                      .setBody(ByteString.copyFrom(payload, Charset.defaultCharset()))
                      .setUrl(url)
                      .setHttpMethod(HttpMethod.POST)
                      .build());

      // Send create task request.
      Task task = client.createTask(queuePath, taskBuilder.build());
      System.out.println("Task created: " + task.getName());
    }
  }
}

Notez le fichier pom.xml :

tasks/snippets/pom.xml 
<?xml version='1.0' encoding='UTF-8'?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example.tasks</groupId>
  <artifactId>cloudtasks-snippets</artifactId>
  <packaging>jar</packaging>
  <name>Google Cloud Tasks Snippets</name>

  <!--
    The parent pom defines common style checks and testing strategies for our samples.
    Removing or replacing it should not affect the execution of the samples in anyway.
  -->
  <parent>
    <groupId>com.google.cloud.samples</groupId>
    <artifactId>shared-configuration</artifactId>
    <version>1.2.0</version>
  </parent>

  <properties>
    <maven.compiler.target>1.8</maven.compiler.target>
    <maven.compiler.source>1.8</maven.compiler.source>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>libraries-bom</artifactId>
        <version>26.12.0</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>google-cloud-tasks</artifactId>
    </dependency>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.13.2</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>com.google.truth</groupId>
      <artifactId>truth</artifactId>
      <version>1.1.4</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

PHP

tasks/src/create_http_task.php 
use Google\Cloud\Tasks\V2\CloudTasksClient;
use Google\Cloud\Tasks\V2\HttpMethod;
use Google\Cloud\Tasks\V2\HttpRequest;
use Google\Cloud\Tasks\V2\Task;

/** Uncomment and populate these variables in your code */
// $projectId = 'The Google project ID';
// $locationId = 'The Location ID';
// $queueId = 'The Cloud Tasks Queue ID';
// $url = 'The full url path that the task request will be sent to.'
// $payload = 'The payload your task should carry to the task handler. Optional';

// Instantiate the client and queue name.
$client = new CloudTasksClient();
$queueName = $client->queueName($projectId, $locationId, $queueId);

// Create an Http Request Object.
$httpRequest = new HttpRequest();
// The full url path that the task request will be sent to.
$httpRequest->setUrl($url);
// POST is the default HTTP method, but any HTTP method can be used.
$httpRequest->setHttpMethod(HttpMethod::POST);
// Setting a body value is only compatible with HTTP POST and PUT requests.
if (isset($payload)) {
    $httpRequest->setBody($payload);
}

// Create a Cloud Task object.
$task = new Task();
$task->setHttpRequest($httpRequest);

// Send request and print the task name.
$response = $client->createTask($queueName, $task);
printf('Created task %s' . PHP_EOL, $response->getName());

Notez le fichier composer.json :

tasks/composer.json 
{
    "require": {
        "google/cloud-tasks": "^1.4.0"
    }
}

Go

tasks/create_http_task.go 

// Command createHTTPtask constructs and adds a task to a Cloud Tasks Queue.
package main

import (
	"context"
	"fmt"

	cloudtasks "cloud.google.com/go/cloudtasks/apiv2"
	taskspb "cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb"
)

// createHTTPTask creates a new task with a HTTP target then adds it to a Queue.
func createHTTPTask(projectID, locationID, queueID, url, message string) (*taskspb.Task, error) {

	// Create a new Cloud Tasks client instance.
	// See https://godoc.org/cloud.google.com/go/cloudtasks/apiv2
	ctx := context.Background()
	client, err := cloudtasks.NewClient(ctx)
	if err != nil {
		return nil, fmt.Errorf("NewClient: %w", err)
	}
	defer client.Close()

	// Build the Task queue path.
	queuePath := fmt.Sprintf("projects/%s/locations/%s/queues/%s", projectID, locationID, queueID)

	// Build the Task payload.
	// https://godoc.org/google.golang.org/genproto/googleapis/cloud/tasks/v2#CreateTaskRequest
	req := &taskspb.CreateTaskRequest{
		Parent: queuePath,
		Task: &taskspb.Task{
			// https://godoc.org/google.golang.org/genproto/googleapis/cloud/tasks/v2#HttpRequest
			MessageType: &taskspb.Task_HttpRequest{
				HttpRequest: &taskspb.HttpRequest{
					HttpMethod: taskspb.HttpMethod_POST,
					Url:        url,
				},
			},
		},
	}

	// Add a payload message if one is present.
	req.Task.GetHttpRequest().Body = []byte(message)

	createdTask, err := client.CreateTask(ctx, req)
	if err != nil {
		return nil, fmt.Errorf("cloudtasks.CreateTask: %w", err)
	}

	return createdTask, nil
}

Node.js

cloud-tasks/snippets/createHttpTask.js 
// Imports the Google Cloud Tasks library.
const {CloudTasksClient} = require('@google-cloud/tasks');

// Instantiates a client.
const client = new CloudTasksClient();

async function createHttpTask() {
  // TODO(developer): Uncomment these lines and replace with your values.
  // const project = 'my-project-id';
  // const queue = 'my-queue';
  // const location = 'us-central1';
  // const url = 'https://example.com/taskhandler';
  // const payload = 'Hello, World!';
  // const inSeconds = 180;

  // Construct the fully qualified queue name.
  const parent = client.queuePath(project, location, queue);

  const task = {
    httpRequest: {
      headers: {
        'Content-Type': 'text/plain', // Set content type to ensure compatibility your application's request parsing
      },
      httpMethod: 'POST',
      url,
    },
  };

  if (payload) {
    task.httpRequest.body = Buffer.from(payload).toString('base64');
  }

  if (inSeconds) {
    // The time when the task is scheduled to be attempted.
    task.scheduleTime = {
      seconds: parseInt(inSeconds) + Date.now() / 1000,
    };
  }

  // Send create task request.
  console.log('Sending task:');
  console.log(task);
  const request = {parent: parent, task: task};
  const [response] = await client.createTask(request);
  console.log(`Created task ${response.name}`);
}
createHttpTask();

Notez le fichier package.json :

cloud-tasks/snippets/package.json 
{
  "name": "appengine-cloudtasks",
  "description": "Google App Engine Cloud Tasks example.",
  "license": "Apache-2.0",
  "author": "Google Inc.",
  "private": true,
  "engines": {
    "node": ">=14.0.0"
  },
  "files": [
    "*.js"
  ],
  "scripts": {
    "test": "c8 mocha --timeout 30000",
    "start": "node server.js"
  },
  "dependencies": {
    "@google-cloud/tasks": "^3.0.4",
    "express": "^4.16.3"
  },
  "devDependencies": {
    "c8": "^7.13.0",
    "chai": "^4.2.0",
    "mocha": "^10.0.0",
    "uuid": "^9.0.0"
  }
}

Ruby

google-cloud-tasks/samples/create_http_task.rb 
require "google/cloud/tasks"

# Create a Task with an HTTP Target
#
# @param [String] project_id Your Google Cloud Project ID.
# @param [String] location_id Your Google Cloud Project Location ID.
# @param [String] queue_id Your Google Cloud Tasks Queue ID.
# @param [String] url The full path to sent the task request to.
# @param [String] payload The request body of your task.
# @param [Integer] seconds The delay, in seconds, to process your task.
def create_http_task project_id, location_id, queue_id, url, payload: nil, seconds: nil
  # Instantiates a client.
  client = Google::Cloud::Tasks.cloud_tasks

  # Construct the fully qualified queue name.
  parent = client.queue_path project: project_id, location: location_id, queue: queue_id

  # Construct task.
  task = {
    http_request: {
      http_method: "POST",
      url:         url
    }
  }

  # Add payload to task body.
  task[:http_request][:body] = payload if payload

  # Add scheduled time to task.
  if seconds
    timestamp = Google::Protobuf::Timestamp.new
    timestamp.seconds = Time.now.to_i + seconds.to_i
    task[:schedule_time] = timestamp
  end

  # Send create task request.
  puts "Sending task #{task}"

  response = client.create_task parent: parent, task: task

  puts "Created task #{response.name}" if response.name
end

Configurer des comptes de service pour l'authentification des gestionnaires HTTP Target

Cloud Tasks peut appeler des gestionnaires HTTP Target nécessitant une authentification si vous disposez d'un compte de service avec les identifiants appropriés pour accéder au gestionnaire.

Si vous disposez déjà d'un compte de service, vous pouvez le faire. Accordez-lui simplement les rôles appropriés. Ces instructions concernent la création d'un compte de service spécifique pour cette fonction. Le compte de service nouveau ou existant utilisé pour l'authentification Cloud Tasks doit se trouver dans le même projet que vos files d'attente Cloud Tasks.

  1. Dans Google Cloud Console, accédez à la page Comptes de service.

    Accéder à la page "Comptes de service"

  2. Si nécessaire, sélectionnez le projet approprié.

  3. Cliquez sur Créer un compte de service.

  4. Fournissez le nom à afficher pour ce compte. La console crée un nom de compte de messagerie associé pour le compte. C'est ainsi que vous référencez le compte. Vous pouvez également ajouter une description de l'objet du compte, si vous le souhaitez.

  5. Cliquez sur Créer et continuer.

  6. Cliquez sur Sélectionnez un rôle, puis sélectionnez Cloud Tasks > Cloud Tasks Empileur. Ce rôle autorise le compte de service à ajouter des tâches à la file d'attente.

  7. Cliquez sur + Ajouter un autre rôle.

  8. Cliquez sur Sélectionner un rôle, puis sur Comptes de service>Utilisateur du compte de service. Ce rôle permet au compte de service d'autoriser la file d'attente à créer des jetons en son nom à l'aide des identifiants du compte de service.

  9. Si votre gestionnaire fait partie de Google Cloud, attribuez au compte de service le rôle associé à l'accès au service sur lequel votre gestionnaire s'exécute. Chaque service Google Cloud nécessite un rôle différent. Par exemple, pour accéder à un gestionnaire sur Cloud Run, vous devez utiliser le rôle Demandeur Cloud Run, et ainsi de suite. Vous pouvez utiliser le compte de service que vous venez de créer ou tout autre compte de service dans votre projet.

  10. Cliquez sur OK pour terminer la création du compte de service.

Cloud Tasks lui-même doit posséder son propre compte de service doté du rôle Cloud Tasks Service Agent. Cela lui permet de générer des jetons d'en-tête basés sur les identifiants associés au compte de service Cloud Tasks pour s'authentifier auprès de votre cible de gestionnaire. Le compte de service Cloud Tasks auquel ce rôle est attribué est automatiquement créé lorsque vous activez l'API Cloud Tasks, sauf si vous l'avez activée avant le 19 mars 2019, auquel cas vous devez ajouter le rôle manuellement.

Utiliser des tâches HTTP Target avec des jetons d'authentification

Pour s'authentifier entre Cloud Tasks et un gestionnaire HTTP Target nécessitant une telle authentification, Cloud Tasks crée un jeton d'en-tête. Ce jeton est basé sur les identifiants du compte de service Cloud Tasks Enqueuer, identifiés par son adresse e-mail. Le compte de service utilisé pour l'authentification doit faire partie du projet dans lequel se trouve votre file d'attente Cloud Tasks. La requête, avec le jeton d'en-tête, est envoyée via HTTPS au gestionnaire de la file d'attente. Vous pouvez utiliser un jeton d'ID ou un jeton d'accès. Les jetons d'ID doivent généralement être utilisés pour tout gestionnaire s'exécutant sur Google Cloud, par exemple sur Cloud Functions ou Cloud Run. La principale exception concerne les API Google hébergées sur *.googleapis.com, car elles attendent un jeton d'accès. Vous spécifiez un jeton d'ID (OIDC) ou un jeton d'accès (OAuth) dans la tâche elle-même.

Méthode BufferTask

Lorsque vous utilisez la méthode BufferTask pour créer des tâches, toute configuration OIDC ou OAuth définie au niveau de la file d'attente remplace la configuration au niveau de la tâche. Pour configurer l'authentification au niveau de la file d'attente, consultez Créer des files d'attente Cloud Tasks. Toutefois, vous pouvez vous authentifier lors de la création de la tâche. L'exemple suivant utilise les identifiants par défaut de l'application pour s'authentifier lors de la création d'une tâche:

  curl -X HTTP_METHOD\
   "https://cloudtasks.googleapis.com/v2beta3/projects/PROJECT_ID/locations/LOCATION/queues/QUEUE_ID/tasks:buffer" \
      -H "Authorization: Bearer ACCESS_TOKEN"

Remplacez les éléments suivants :

  • HTTP_METHOD: méthode HTTP de votre requête, par exemple GET ou POST.
  • PROJECT_ID : ID de votre projet Google Cloud. Pour l'obtenir, exécutez la commande suivante dans votre terminal: 
    gcloud config get-value project
  • LOCATION: emplacement de votre file d'attente.
  • QUEUE_ID: ID de la file d'attente.
  • ACCESS_TOKEN: votre jeton d'accès. Pour l'obtenir, exécutez la commande suivante dans votre terminal :
    1. gcloud auth application-default login
    2. gcloud auth application-default print-access-token

Méthode CreateTask

Les exemples suivants utilisent la méthode CreateTask avec les bibliothèques clientes Cloud Tasks pour créer une tâche comprenant la création d'un jeton d'en-tête. Les jetons d'ID sont utilisés dans les exemples. Pour utiliser un jeton d'accès, remplacez le paramètre OIDC par le paramètre OAuth de langage approprié lors de la création de la requête.

Python

cloud_tasks/snippets/create_http_task_with_token.py 
from typing import Optional

from google.cloud import tasks_v2

def create_http_task_with_token(
    project: str,
    location: str,
    queue: str,
    url: str,
    payload: bytes,
    service_account_email: str,
    audience: Optional[str] = None,
) -> tasks_v2.Task:
    """Create an HTTP POST task with an OIDC token and an arbitrary payload.
    Args:
        project: The project ID where the queue is located.
        location: The location where the queue is located.
        queue: The ID of the queue to add the task to.
        url: The target URL of the task.
        payload: The payload to send.
        service_account_email: The service account to use for generating the OIDC token.
        audience: Audience to use when generating the OIDC token.
    Returns:
        The newly created task.
    """

    # Create a client.
    client = tasks_v2.CloudTasksClient()

    # Construct the request body.
    task = tasks_v2.Task(
        http_request=tasks_v2.HttpRequest(
            http_method=tasks_v2.HttpMethod.POST,
            url=url,
            oidc_token=tasks_v2.OidcToken(
                service_account_email=service_account_email,
                audience=audience,
            ),
            body=payload,
        ),
    )

    # Use the client to build and send the task.
    return client.create_task(
        tasks_v2.CreateTaskRequest(
            parent=client.queue_path(project, location, queue),
            task=task,
        )
    )

Notez le fichier requirements.txt :

cloud_tasks/snippets/requirements.txt 
google-cloud-tasks==2.13.1

Java

tasks/snippets/src/main/java/com/example/task/CreateHttpTaskWithToken.java 
import com.google.cloud.tasks.v2.CloudTasksClient;
import com.google.cloud.tasks.v2.HttpMethod;
import com.google.cloud.tasks.v2.HttpRequest;
import com.google.cloud.tasks.v2.OidcToken;
import com.google.cloud.tasks.v2.QueueName;
import com.google.cloud.tasks.v2.Task;
import com.google.protobuf.ByteString;
import java.io.IOException;
import java.nio.charset.Charset;

public class CreateHttpTaskWithToken {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project-id";
    String locationId = "us-central1";
    String queueId = "my-queue";
    String serviceAccountEmail =
        "java-docs-samples-testing@java-docs-samples-testing.iam.gserviceaccount.com";
    createTask(projectId, locationId, queueId, serviceAccountEmail);
  }

  // Create a task with a HTTP target and authorization token using the Cloud Tasks client.
  public static void createTask(
      String projectId, String locationId, String queueId, String serviceAccountEmail)
      throws IOException {

    // Instantiates a client.
    try (CloudTasksClient client = CloudTasksClient.create()) {
      String url =
          "https://example.com/taskhandler"; // The full url path that the request will be sent to
      String payload = "Hello, World!"; // The task HTTP request body

      // Construct the fully qualified queue name.
      String queuePath = QueueName.of(projectId, locationId, queueId).toString();

      // Add your service account email to construct the OIDC token.
      // in order to add an authentication header to the request.
      OidcToken.Builder oidcTokenBuilder =
          OidcToken.newBuilder().setServiceAccountEmail(serviceAccountEmail);

      // Construct the task body.
      Task.Builder taskBuilder =
          Task.newBuilder()
              .setHttpRequest(
                  HttpRequest.newBuilder()
                      .setBody(ByteString.copyFrom(payload, Charset.defaultCharset()))
                      .setHttpMethod(HttpMethod.POST)
                      .setUrl(url)
                      .setOidcToken(oidcTokenBuilder)
                      .build());

      // Send create task request.
      Task task = client.createTask(queuePath, taskBuilder.build());
      System.out.println("Task created: " + task.getName());
    }
  }
}

Notez le fichier pom.xml :

tasks/snippets/pom.xml 
<?xml version='1.0' encoding='UTF-8'?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example.tasks</groupId>
  <artifactId>cloudtasks-snippets</artifactId>
  <packaging>jar</packaging>
  <name>Google Cloud Tasks Snippets</name>

  <!--
    The parent pom defines common style checks and testing strategies for our samples.
    Removing or replacing it should not affect the execution of the samples in anyway.
  -->
  <parent>
    <groupId>com.google.cloud.samples</groupId>
    <artifactId>shared-configuration</artifactId>
    <version>1.2.0</version>
  </parent>

  <properties>
    <maven.compiler.target>1.8</maven.compiler.target>
    <maven.compiler.source>1.8</maven.compiler.source>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>libraries-bom</artifactId>
        <version>26.12.0</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>google-cloud-tasks</artifactId>
    </dependency>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.13.2</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>com.google.truth</groupId>
      <artifactId>truth</artifactId>
      <version>1.1.4</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

Go

tasks/token/create_http_task_with_token.go 
import (
	"context"
	"fmt"

	cloudtasks "cloud.google.com/go/cloudtasks/apiv2"
	taskspb "cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb"
)

// createHTTPTaskWithToken constructs a task with a authorization token
// and HTTP target then adds it to a Queue.
func createHTTPTaskWithToken(projectID, locationID, queueID, url, email, message string) (*taskspb.Task, error) {
	// Create a new Cloud Tasks client instance.
	// See https://godoc.org/cloud.google.com/go/cloudtasks/apiv2
	ctx := context.Background()
	client, err := cloudtasks.NewClient(ctx)
	if err != nil {
		return nil, fmt.Errorf("NewClient: %w", err)
	}
	defer client.Close()

	// Build the Task queue path.
	queuePath := fmt.Sprintf("projects/%s/locations/%s/queues/%s", projectID, locationID, queueID)

	// Build the Task payload.
	// https://godoc.org/google.golang.org/genproto/googleapis/cloud/tasks/v2#CreateTaskRequest
	req := &taskspb.CreateTaskRequest{
		Parent: queuePath,
		Task: &taskspb.Task{
			// https://godoc.org/google.golang.org/genproto/googleapis/cloud/tasks/v2#HttpRequest
			MessageType: &taskspb.Task_HttpRequest{
				HttpRequest: &taskspb.HttpRequest{
					HttpMethod: taskspb.HttpMethod_POST,
					Url:        url,
					AuthorizationHeader: &taskspb.HttpRequest_OidcToken{
						OidcToken: &taskspb.OidcToken{
							ServiceAccountEmail: email,
						},
					},
				},
			},
		},
	}

	// Add a payload message if one is present.
	req.Task.GetHttpRequest().Body = []byte(message)

	createdTask, err := client.CreateTask(ctx, req)
	if err != nil {
		return nil, fmt.Errorf("cloudtasks.CreateTask: %w", err)
	}

	return createdTask, nil
}

Node.js

cloud-tasks/snippets/createHttpTaskWithToken.js 
// Imports the Google Cloud Tasks library.
const {CloudTasksClient} = require('@google-cloud/tasks');

// Instantiates a client.
const client = new CloudTasksClient();

async function createHttpTaskWithToken() {
  // TODO(developer): Uncomment these lines and replace with your values.
  // const project = 'my-project-id';
  // const queue = 'my-queue';
  // const location = 'us-central1';
  // const url = 'https://example.com/taskhandler';
  // const serviceAccountEmail = 'client@<project-id>.iam.gserviceaccount.com';
  // const payload = 'Hello, World!';

  // Construct the fully qualified queue name.
  const parent = client.queuePath(project, location, queue);

  const task = {
    httpRequest: {
      headers: {
        'Content-Type': 'text/plain', // Set content type to ensure compatibility your application's request parsing
      },
      httpMethod: 'POST',
      url,
      oidcToken: {
        serviceAccountEmail,
      },
    },
  };

  if (payload) {
    task.httpRequest.body = Buffer.from(payload).toString('base64');
  }

  console.log('Sending task:');
  console.log(task);
  // Send create task request.
  const request = {parent: parent, task: task};
  const [response] = await client.createTask(request);
  const name = response.name;
  console.log(`Created task ${name}`);
}
createHttpTaskWithToken();

Notez le fichier package.json :

cloud-tasks/snippets/package.json 
{
  "name": "appengine-cloudtasks",
  "description": "Google App Engine Cloud Tasks example.",
  "license": "Apache-2.0",
  "author": "Google Inc.",
  "private": true,
  "engines": {
    "node": ">=14.0.0"
  },
  "files": [
    "*.js"
  ],
  "scripts": {
    "test": "c8 mocha --timeout 30000",
    "start": "node server.js"
  },
  "dependencies": {
    "@google-cloud/tasks": "^3.0.4",
    "express": "^4.16.3"
  },
  "devDependencies": {
    "c8": "^7.13.0",
    "chai": "^4.2.0",
    "mocha": "^10.0.0",
    "uuid": "^9.0.0"
  }
}

Fournir vos propres gestionnaires de tâches HTTP Target

Les gestionnaires de tâches HTTP Target ressemblent beaucoup aux gestionnaires de tâches App Engine, aux exceptions près suivantes :

  • Délais avant expiration : pour tous les gestionnaires de tâches HTTP Target, le délai avant expiration par défaut est de 10 minutes, avec un maximum de 30 minutes.
  • Logique d'authentification: si vous écrivez votre propre code dans le service ciblé pour valider le jeton, vous devez utiliser un jeton d'ID. Pour plus d'informations sur ce sujet, consultez la page OpenID Connect, en particulier la section Valider un jeton d'ID.

  • En-têtes : une requête HTTP Target comporte des en-têtes définis par la file d'attente, qui contiennent des informations propres à la tâche, que votre gestionnaire peut utiliser. Ils sont semblables aux en-têtes définis dans les requêtes de tâches App Engine, mais pas identiques. Ces en-têtes fournissent des informations uniquement. Elles ne doivent pas être utilisées en tant que sources d'identité.

    Si ces en-têtes étaient présents dans une requête d'utilisateur externe adressée à votre application, ils sont remplacés par des en-têtes internes. La seule exception concerne les requêtes des administrateurs connectés à l'application, qui sont autorisés à définir des en-têtes à des fins de test.

    Les requêtes HTTP Target contiennent toujours les en-têtes suivants :

    En-tête Description
    X-CloudTasks-QueueName Nom de la file d'attente.
    X-CloudTasks-TaskName Nom "court" de la tâche ou, si aucun nom n'a été spécifié lors de la création, identifiant unique généré par le système. Il s'agit de la valeur my-task-id dans le nom complet de la tâche, par exemple task_name = projects/my-project-id/locations/my-location/queues/my-queue-id/tasks/my-task-id.
    X-CloudTasks-TaskRetryCount Nombre de fois où une tâche a fait l'objet de nouvelles tentatives d'exécution. Pour la première tentative, cette valeur est définie sur 0. Ce chiffre inclut les tentatives lorsque la tâche a échoué en raison de codes d'erreur 5XX et n'a jamais atteint la phase d'exécution.
    X-CloudTasks-TaskExecutionCount Nombre total de fois où la tâche a reçu une réponse du gestionnaire. Étant donné que Cloud Tasks supprime la tâche une fois la réponse reçue, toutes les réponses précédentes du gestionnaire sont des échecs. Ce chiffre n'inclut pas les échecs dus à des codes d'erreur 5XX.
    X-CloudTasks-TaskETA Heure de planification de la tâche spécifiée en secondes depuis le 1er janvier 1970.

    En outre, les requêtes Cloud Tasks peuvent contenir les en-têtes suivants :

    En-tête Description
    X-CloudTasks-TaskPreviousResponse Code de réponse HTTP de la tentative précédente.
    X-CloudTasks-TaskRetryReason Raison de la nouvelle tentative d'exécution de la tâche.

Ajouter manuellement le rôle d'agent de service Cloud Tasks à votre compte de service Cloud Tasks

Cela n'est nécessaire que si vous avez activé l'API Cloud Tasks avant le 19 mars 2019.

Utiliser la console

  1. Recherchez le numéro de votre projet sur la page des paramètres du projet Google Cloud.
  2. Copiez le numéro.
  3. Ouvrez la page Console d'administration IAM.
  4. Cliquez sur Add. L'écran Add members s'ouvre.

  5. Dans la boîte de dialogue "Nouveaux membres", ajoutez une adresse e-mail au format suivant :

    service-[project-number]@gcp-sa-cloudtasks.iam.gserviceaccount.com

    Remplacez [project-number] par le numéro de projet ci-dessus.

  6. Dans la liste déroulante Select a role, choisissez Service Management -> Cloud Tasks Service Agent.

  7. Cliquez sur Save.

Utiliser gcloud

  1. Recherchez le numéro de votre projet :

    gcloud projects describe [project-id] --format='table(projectNumber)'

    Remplacement de [project-id] par votre ID de projet

  2. Copiez le numéro.

  3. Attribuez le rôle Cloud Tasks Service Agent au compte de service Cloud Tasks en utilisant le numéro de projet que vous avez copié :

    gcloud projects add-iam-policy-binding [project-id] --member serviceAccount:service-[project-number]@gcp-sa-cloudtasks.iam.gserviceaccount.com --role roles/cloudtasks.serviceAgent

    Pour ce faire, remplacez [project-id] par l'ID de votre projet et [project-number] par le numéro de projet déterminé ci-dessus.

Étapes suivantes