Propriétés et commandes de l'adaptateur

Cette section répertorie les propriétés prises en charge par l'adaptateur Google Cloud Pub/Sub.

Fichier de données d'identification

Indique le JSON avec les données d'identification du compte de service utilisé pour accéder au service Cloud Pub/Sub. Lorsqu'il n'est pas spécifié, l'authentification est effectuée à l'aide du fichier de données d'identification pointé par la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS. Lors de l'exécution dans l'environnement Google Cloud, le cas échéant, l'authentification peut être effectuée automatiquement par l'environnement à l'aide du compte de service par défaut pour l'environnement dans lequel l'adaptateur s'exécute. L'adaptateur ne prend en charge que l'authentification pour les comptes de service Google. L'authentification pour les comptes utilisateur final Google n'est pas prise en charge.

La commande d'adaptateur correspondante est -CF (ou -CREDENTIALSFILE) credentials_file.

Nom d'utilisateur

Indique le nom d'utilisateur pour la connexion. Cette propriété est facultative. Pour de nombreux pilotes, vous pouvez spécifier le nom d'utilisateur dans la chaîne de connexion. Certains pilotes peuvent utiliser une authentification autre que le nom d'utilisateur et le mot de passe, et certains pilotes peuvent ne pas nécessiter d'authentification. La commande d'adaptateur correspondante est -USER user_name.

Project

Cette propriété identifie le projet qui héberge les sujets et les abonnements accessibles par l'adaptateur. La commande d'adaptateur correspondante est -P (ou -PROJECT) project_id.

Rubrique

Spécifie le sujet dans laquelle les messages sont écrits. Lors de la lecture des messages et de la création automatique de l'abonnement. Il s'agit du sujet pour lequel l'abonnement est créé. La commande d'adaptateur correspondante est -T (ou -TOPIC)topic_id.

Créer une rubrique

Indique à l'adaptateur de créer le sujet cible spécifié si le sujet n'existe pas encore. Cette propriété s'applique uniquement lorsque l'adaptateur est utilisé dans le scénario cible. La commande d'adaptateur correspondante est -CT (ou -CREATETOPIC).

Abonnement

Cette propriété identifie l'abonnement à partir duquel les messages seront lus. L'adaptateur prend uniquement en charge les abonnements de type Pull et ne prend pas en charge les abonnements de type Push. Lors de la reconnaissance d'abonnements, seuls les abonnements de type Pull sont inclus dans le résultat. La commande d'adaptateur correspondante est -S subscription_id.

Créer un abonnement

Demande à l'adaptateur de créer l'abonnement spécifié si l'abonnement n'existe pas encore. Cette propriété s'applique uniquement lorsque l'adaptateur est utilisé dans un scénario source. Le nouvel abonnement est créé pour la rubrique spécifiée et il est créé en tant qu'abonnement de type Pull.

La commande d'adaptateur correspondante est -CS (ou -CREATESUBSCRIPTION).

Nombre de lots

Indique le nombre de messages à stocker localement dans le client Pub/Sub avant de vider la mémoire tampon. La valeur par défaut est 1, ce qui implique que la mémoire tampon sera vidée immédiatement. Le vidage du lot est contrôlé à l'aide d'une combinaison de conditions spécifiées dans les propriétés Nombre de lots, Taille du lot (octets) et Délai du lot (millisecondes). Lorsque l'une de ces conditions est remplie, la mémoire tampon est vidée.

La commande d'adaptateur correspondante est -BC (ou -BATCHCOUNT) count.

Taille du lot (octets)

Spécifie la taille en octets de la mémoire tampon dans laquelle les messages seront stockés localement avant de vider la mémoire tampon. La valeur par défaut est 1, ce qui implique que la mémoire tampon sera vidée immédiatement. Le vidage du lot est contrôlé à l'aide d'une combinaison de conditions spécifiées dans les propriétés Nombre de lots, Taille du lot (en octets) et Délai du lot (en millisecondes). Lorsque l'une de ces conditions est remplie, la mémoire tampon est vidée.

La commande d'adaptateur correspondante est -BS (ou -BATCHSIZE) size.

Délai du lot (en millisecondes)

Spécifie la durée, en millisecondes, du stockage des messages localement dans une mémoire tampon, avant de la vider. La valeur par défaut est 1, ce qui implique que la mémoire tampon sera vidée immédiatement. Le vidage du lot est contrôlé à l'aide d'une combinaison de conditions spécifiées dans les propriétés Nombre de lots, Taille du lot (en octets) et Délai du lot (en millisecondes). Lorsque l'une de ces conditions est remplie, la mémoire tampon est vidée.

La commande d'adaptateur correspondante est -BD (ou -BATCHDELAY) delay.

Echéance de l'abonnement (en secondes)

Spécifie l'échéance, en millisecondes, à définir pour les messages sur l'abonnement lorsque l'abonnement est créé par l'adaptateur. Il s'agit de l'intervalle attribué à chaque abonné pour reconnaître l'extraction d'un message de l'abonnement. Si le message n'est pas reconnu au cours de cet intervalle et que son échéance n'est pas étendue, il est automatiquement mis à disposition en vue d'une nouvelle livraison. La valeur par défaut est de 10 secondes.

La commande d'adaptateur correspondante est -SD (ou -SUBSCRIPTIONDELAY) deadline.

Accusés de réception
Indique à quel moment l'adaptateur doit reconnaître les messages extraits. Les actions prises en charge sont :
  • Never  : l'adaptateur n'envoie jamais d'accusés de réception pour les messages. Une fois l'échéance de l'accusé de réception expirée, les messages sont mis à disposition pour une nouvelle livraison. Il s'agit de la valeur par défaut. Insensible à la casse. La valeur de la commande d'adaptateur correspondante est never.
  • Immediate : l'adaptateur envoie un accusé de réception pour les messages immédiatement après les avoir extraits, avant que les messages ne soient traités par la mappe. Insensible à la casse. La valeur de la commande d'adaptateur correspondante est immediate.
  • Transactional : l'adaptateur reconnaît les messages dans le cadre de la validation de la transaction source. Insensible à la casse. La valeur de la commande d'adaptateur correspondante est transactional.

La commande d'adaptateur correspondante est -ACK (ou -ACKNOWLEDGMENTS)never|immediate|transactional.

Echéance du message (en secondes)

Spécifie l'échéance, en millisecondes, à définir pour les messages extraits d'un abonnement. Elle devient le nouvel intervalle de temps. L'adaptateur doit reconnaître les messages avant qu'ils ne soient disponibles pour la nouvelle livraison. Lorsque la valeur n'est pas spécifiée, la valeur d'échéance par défaut est -1, ce qui représente l'échéance définie au niveau de l'abonnement. La commande d'adaptateur correspondante est -MD (-MESSAGEDEADLINE) deadline.

Nombre de messages de sondage

Indique le nombre maximal de messages à sonder à partir du service Pub/Sub par requête unique. La valeur par défaut est 1, ce qui désactive l'extraction des messages par lots. Lorsque plusieurs messages sont extraits par requête, les messages sont stockés localement et l'adaptateur sonde l'abonnement pour trouver de nouveaux messages uniquement après qu'il a épuisé tous les messages stockés localement.

La commande d'adaptateur correspondante est -PMC (-POLLMESSAGECOUNT)count.

Délai d'attente de publication (en secondes)

Indique le temps en millisecondes. L'adaptateur attend que l'opération de publication se termine, avant d'arriver à expiration et de signaler l'erreur. La valeur par défaut est -1, ce qui indique qu'il n'y a pas de délai d'attente. La commande d'adaptateur correspondante est -PT (-PUBLISHTIME) timeout.

Mode de message logique

Indique que l'adaptateur s'exécutera dans un mode dans lequel la charge qu'il échange avec la structure est supposée se composer d'un ou de plusieurs messages Pub/Sub physiques. Lorsque ce mode n'est pas utilisé, chaque charge que l'adaptateur échange avec la structure correspond exactement à un message Pub/Sub.

En mode message logique, la charge que l'adaptateur échange avec la structure est au format suivant :

Nombre entier de 32 bits représentant la taille totale restante de la charge (4 octets) nombre entier de 32 bits représentant la taille du message 1 (4 octets) nombre entier de 32 bits des données du message 1 représentant la taille du message 2 (4 octets) données du message 2.

Dans le contexte cible, une charge unique (message logique) fournie à l'adaptateur peut entraîner la publication de plusieurs messages Pub/Sub dans le sujet cible. Dans le contexte source, plusieurs messages Pub/Sub extraits de l'abonnement peuvent être combinés et fournis à la structure en tant que charge unique (message logique).

La commande d'adaptateur correspondante est -LMM (ou -LOGICALMESSAGEMODE).

Nombre de messages logiques

Indique le nombre de messages Pub/Sub à inclure dans un message logique unique lors de la lecture de messages de l'abonnement en mode message logique. La valeur par défaut est 1. La taille du message logique fourni par l'adaptateur est contrôlée par la combinaison de conditions définies par deux propriétés :

  • Nombre de messages logiques et
  • Taille du message logique (en octets)

La première condition qui est remplie détermine la taille réelle du message logique.

La commande d'adaptateur correspondante est -LMC (ou -LOGICALMESSAGECOUNT) count.

Taille du message logique (en octets)

Spécifie la taille, en octets, d'un message logique unique lors de la lecture des messages de l'abonnement en mode message logique. Lorsque la taille totale des messages extraits de l'abonnement atteint ou dépasse cette valeur, les messages logiques sont considérés comme terminés. La valeur par défaut est 0. La taille du message logique fourni par l'adaptateur est contrôlée par la combinaison de conditions définies par deux propriétés :

  • Nombre de messages logiques et
  • Taille du message logique (en octets)

La première condition qui est remplie détermine la taille réelle du message logique.

La commande d'adaptateur correspondante est -LMS (or -LOGICALMESSAGESIZE) size.

Limite
Indique le nombre de messages à extraire de l'abonnement. La valeur par défaut est 1. La valeur spéciale "S" indique tous les messages disponibles et la valeur 0 signifie qu'il n'y a pas d'attente. La commande d'adaptateur correspondante est -QTY limit.
Délai d'attente

Indique le délai d'attente, en secondes, jusqu'à l'arrivée d'un nouveau message. La valeur par défaut est "S". Il s'agit d'une valeur spéciale qui indique une attente illimitée (infinie). La commande d'adaptateur correspondante est -LSN timeout.

Journalisation

Cette propriété spécifie le niveau de journalisation à utiliser pour le fichier journal (fichier de trace) produit par l'adaptateur. La valeur par défaut est Désactivé. La valeur Informatif permet de consigner les messages d'information et d'erreur, la valeur Erreurs uniquement permet de consigner uniquement les messages d'erreur et la valeur Prolixe permet de consigner les messages de débogage et de niveau de trace en plus des messages d'information et d'erreur.

La commande d'adaptateur correspondante est :

-T [E|V] [+] [file_path]

-T -> Consignation des messages d'information de l'adaptateur.

-TE -> Consignation des erreurs de l'adaptateur uniquement.

-TV -> Utilisation de la consignation prolixe (débogage). Le fichier journal consigne toute l'activité lorsque l'adaptateur génère ou consomme des messages.

+ -> Ajout des informations de trace à un fichier existant. Omettez cet argument pour créer un nouveau fichier journal.

file_path -> Le chemin d'accès complet au journal de trace de l'adaptateur. Si vous omettez ce mot clé, l'adaptateur crée le fichier journal m4gcpubsub.mtr dans le répertoire de mappe.

Ajouter un journal

Indicateur spécifiant l'action à effectuer si le fichier journal spécifié existe déjà. Lorsque la valeur est true, les messages du journal sont ajoutés au fichier. Lorsque la valeur est false, le fichier est tronqué et les messages sont écrits dans le fichier vide. La valeur par défaut est true.