Paramètres de configuration fournis par Google

Chaque connecteur est associé à un fichier de configuration contenant les paramètres qu'il utilise, comme l'ID de votre dépôt. Les paramètres sont définis sous forme de paires clé-valeur. Par exemple : api.sourceId=1234567890abcdef

Le SDK Google Cloud Search contient plusieurs configurations fournies par Google paramètres utilisés par les différents connecteurs. Parmi les paramètres de configuration fournis par Google, seuls les paramètres d'accès à la source de données doivent être définis dans votre fichier de configuration. Vous n'avez pas besoin de redéfinir les paramètres fournis par Google votre fichier de configuration, sauf si vous souhaitez remplacer leurs valeurs par défaut.

Ce document de référence décrit les paramètres de configuration fournis par Google.

Exemple de fichier de configuration

L'exemple suivant montre un fichier de configuration d'identité avec des paires clé/valeur de paramètres.

#
# Configuration file sample
#
api.sourceId=1234567890abcdef
api.identitySourceId=0987654321lmnopq
api.serviceAccountPrivateKeyFile= ./PrivateKey.json

#
# Traversal schedules
#
schedule.traversalIntervalSecs=7200
schedule.incrementalTraversalIntervalSecs=600
#
# Default ACLs
#
defaultAcl.mode=fallback
defaultAcl.public=true

Paramètres fréquemment définis

Cette section liste les paramètres de configuration obligatoires et facultatifs qui sont généralement définis. Si vous ne modifier les valeurs des paramètres facultatifs, le connecteur utilise les valeurs par défaut fournies par le SDK.

Accès à la source de données

Le tableau suivant répertorie tous les paramètres qui doivent apparaître dans une configuration . Les paramètres à utiliser dépendent du type de connecteur que vous créez (connecteur de contenu ou connecteur d'identité).

Paramètre Paramètre
ID de la source de données api.sourceId=1234567890abcdef

Ce paramètre est requis par un connecteur pour identifier l'emplacement de votre dépôt. Vous obtenez cette valeur lorsque vous ajouté une source de données pour la recherche. Ce paramètre doit figurer dans les fichiers de configuration du connecteur.
ID de la source d'identité api.identitySourceId=0987654321lmnopq

Ce paramètre est requis par les connecteurs d'identité pour identifier l'emplacement d'une source d'identité externe. Vous avez obtenu cette valeur lorsque vous faire correspondre les identités des utilisateurs dans Cloud Search. Ce paramètre doit figurer dans tous les fichiers de configuration du connecteur d'identité.
Fichier de clé privée de compte de service api.serviceAccountPrivateKeyFile=./PrivateKey.json

Ce paramètre contient la clé privée requise. pour accéder au dépôt. Vous avez obtenu cette valeur lorsque vous configuré l'accès à l'API REST de Google Cloud Search API. Ce paramètre doit figurer dans tous les fichiers de configuration.
ID du compte de service api.serviceAccountId=123abcdef4567890

Ce paramètre spécifie le compte de service ID. La valeur de chaîne vide par défaut n'est autorisée que lorsque le fichier de configuration spécifie un paramètre de fichier de clé privée. Ce paramètre est obligatoire si votre fichier de clé privée n'est pas une clé JSON.

ID de compte Google Workspace api.customerId=123abcdef4567890

Ce paramètre spécifie l'ID du compte Google Workspace de l'entreprise. Vous avez obtenu cette valeur lorsque vous associez les identités dans Cloud Search. Ce paramètre est obligatoire lors de la synchronisation des utilisateurs à l'aide d'un le connecteur d'identité.
URL racine api.rootUrl=baseURLPath

Ce paramètre spécifie le chemin de l'URL de base du service d'indexation.

La valeur par défaut de ce paramètre est une chaîne vide qui est convertie en https://cloudsearch.googleapis.com

Planifications de balayage

Les paramètres de planification déterminent la fréquence d'attente du connecteur les balayages d'écrans.

Paramètre Paramètre
Balayage complet au démarrage du connecteur schedule.performTraversalOnStart=true|false

Le connecteur effectue un balayage complet au démarrage du connecteur, en attendant l'expiration du premier intervalle. La valeur par défaut est true..

Balayage complet après un intervalle schedule.traversalIntervalSecs=intervalInSeconds

Le connecteur effectue un balayage complet après un intervalle spécifié. Spécifiez le paramètre l'intervalle entre les balayages en secondes. La valeur par défaut est 86400 (nombre de secondes dans une journée).

Quitter après un balayage unique connector.runOnce=true|false

Le connecteur effectue un balayage complet, puis se ferme. Ce paramètre ne doit doit être défini sur true si vous utilisez une stratégie de balayage complet ; liste et graphique nécessitent des balayages multiples pour détecter les modifications et indexer le contenu. La valeur par défaut la valeur est false (ne quittez pas après un seul balayage).

Balayage incrémentiel après un intervalle schedule.incrementalTraversalIntervalSecs=intervalInSeconds

Le connecteur effectue un balayage incrémentiel après un intervalle défini. Spécifiez l'intervalle entre les balayages en secondes. La valeur par défaut est 300 (nombre de secondes dans 5 minutes).

Intervalles de la file d'attente des sondages programmés schedule.pollQueueIntervalSecs=interval_in_seconds

Intervalle entre les intervalles de la file d'attente d'interrogation planifiée (en secondes). Ceci est utilisé mais uniquement par un connecteur de balayage. La valeur par défaut est 10..

Listes de contrôle d'accès

Le connecteur contrôle l'accès aux éléments à l'aide de LCA. Paramètres multiples vous permettent de protéger l'accès des utilisateurs aux enregistrements indexés avec des LCA.

Si votre référentiel contient des informations de LCA individuelles associées à chaque élément, importer toutes les informations de LCA pour contrôler l'accès aux éléments dans Cloud Search ; Si votre dépôt ne fournit que des informations de LCA partielles, voire aucune, vous pouvez fournir des informations de la LCA dans les paramètres suivants, que le SDK fournit au le connecteur.

Paramètre Paramètre
Mode LCA defaultAcl.mode=mode

Détermine quand appliquer la LCA par défaut. Valeurs correctes :

  • none: ne pas utiliser la LCA par défaut (dans ce mode, les enregistrements sont impossible à rechercher, sauf si vous définissez des LCA individuelles)
  • fallback: utiliser la LCA par défaut uniquement si aucune LCA n'est présente
  • append: ajouter une LCA par défaut à la LCA existante
  • override: remplacer la LCA existante par la LCA par défaut

Le mode par défaut est none.
LCA publique par défaut defaultAcl.public=true|false

La LCA par défaut utilisée pour l'ensemble du dépôt est définie sur l'accès au domaine public. La valeur par défaut est false. .

Lecteurs de groupes de la LCA commune defaultAcl.readers.groups=google:group1@mydomain.com, group2
Lecteurs de la LCA commune defaultAcl.readers.users=user1, user2, google:user3@mydomain.com
Lecteurs de groupe refusés de la LCA commune defaultAcl.denied.groups=group3
Lecteurs refusés de la LCA commune defaultAcl.denied.users=user4, user5
Accès à l'intégralité du domaine Spécifier que chaque enregistrement indexé doit être accessible au public par tous les utilisateurs du domaine, définissez les deux paramètres suivants avec des valeurs: <ph type="x-smartling-placeholder">
    </ph>
  • defaultAcl.mode=override
  • defaultACL.public=true
LCA commune définie Pour spécifier une LCA pour chaque enregistrement du référentiel de données, définissez toutes les les valeurs de paramètres suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • defaultAcl.mode=fallback
  • defaultAcl.public=false
  • defaultAcl.readers.groups=google:group1@mydomain.com, group2 code>
  • defaultAcl.readers.users=user1@mydomain.com, user2, google:user3@mydomain.com
  • defaultAcl.denied.groups=group3
  • defaultAcl.denied.users=user4, user5

    Chaque utilisateur et groupe spécifié est considéré comme un domaine local défini utilisateur/groupe, sauf s'il porte le préfixe "google:" (constante littérale).

    L'utilisateur ou le groupe par défaut est une chaîne vide. Fournir uniquement les paramètres des utilisateurs et des groupes si defaultAcl.public est défini sur false. Pour répertorier plusieurs des groupes et des utilisateurs, utilisez des listes d'éléments séparés par une virgule.

    Si defaultAcl.mode est défini sur none, les enregistrements sont impossible à rechercher sans LCA individuelle définie.

Paramètres de configuration des métadonnées

Certaines métadonnées des éléments peuvent être configurées. Les connecteurs peuvent définir des champs de métadonnées configurables pendant ou l'indexation. Si le connecteur ne définit aucun champ, les paramètres de votre fichier de configuration sont utilisés. pour définir le champ.

Le fichier de configuration contient une série de paramètres de configuration de métadonnées nommés, indiqués par un suffixe .field, tel que itemMetadata.title.field=movieTitle S'il existe une valeur pour ces , il est utilisé pour configurer le champ de métadonnées. Si aucune valeur n'est définie pour le paramètre , les métadonnées sont configurées à l'aide d'un paramètre associé au paramètre .defaultValue).

Le tableau suivant présente les paramètres de configuration des métadonnées.

Paramètre Paramètre
Titre itemMetadata.title.field=movieTitle
itemMetadata.title.defaultValue=Gone with the Wind
Titre de l'élément Si title.field n'est pas défini sur une valeur, la valeur de title.defaultValue est utilisé.
URL du dépôt source itemMetadata.sourceRepositoryUrl.field=url
itemMetadata.sourceRepositoryUrl.defaultValue=https://www.imdb.com/title/tt0031381/
URL de l'article utilisée dans les résultats de recherche. Vous pouvez simplement définir le defaultValue pour qu'il contienne URL de l'ensemble du dépôt, par exemple si votre dépôt est un fichier CSV et qu'il n'y en a qu'un URL de chaque article. Si sourceRepositoryUrl.field n'est pas défini sur une valeur, la valeur de sourceRepositoryUrl.defaultValue est utilisée.
Nom du conteneur itemMetadata.containerName.field=containerName
itemMetadata.containerName.defaultValue=myDefaultContainerName
Nom du conteneur de l'élément (par exemple, le nom d'un dossier ou d'un répertoire du système de fichiers). Si containerName.field n'est pas défini sur une valeur, la valeur de containerName.defaultValue est utilisé.
Type d'objet itemMetadata.objectType.field=type
itemMetadata.objectType.defaultValue=movie
Type d'objet utilisé par le connecteur, tel que défini dans les schéma. Si cette propriété n'est pas spécifiée, le connecteur n'indexera aucune donnée structurée.
Si objectType.field n'est pas défini sur une valeur, la valeur de objectType.defaultValue est utilisé.
Heure de création itemMetadata.createTime.field=releaseDate
itemMetadata.createTime.defaultValue=1940-01-17
Code temporel de création du document. Si createTime.field n'est pas défini sur une valeur, le la valeur de createTime.defaultValue est utilisée.
Heure de mise à jour itemMetadata.updateTime.field=releaseDate
itemMetadata.updateTime.defaultValue=1940-01-17
Code temporel de la dernière modification de l'élément. Si updateTime.field n'est pas défini sur une valeur, la valeur de updateTime.defaultValue est utilisée.
Langue du contenu itemMetadata.contentLanguage.field=languageCode
itemMetadata.contentLanguage.defaultValue=en-US
Langue du contenu des documents indexés. Si le contentLanguage.field n'est pas défini sur une valeur, la valeur de contentLanguage.defaultValue est utilisée.
Type MIME itemMetadata.mimeType.field=mimeType
itemMetadata.mimeType.defaultValue=image/bmp
Type MIME d'origine d'ItemContent.content dans le dépôt source. La longueur maximale est de 256 caractères. Si mimeType.field n'est pas défini sur une valeur, la valeur de mimeType.defaultValue est utilisé.
Métadonnées sur la qualité de la recherche itemMetadata.searchQualityMetadata.quality.field=quality
itemMetadata.searchQualityMetadata.quality.defaultValue=1
Indication de la qualité de l'élément, utilisée pour influencer la qualité de la recherche. La valeur doit être de entre 0 (qualité la plus faible) et 1 (qualité la plus élevée). La valeur par défaut est 0.0. Si le quality.field n'est pas défini sur une valeur, la valeur de quality.defaultValue est utilisé.
Hachage itemMetadata.hash.field=hash
itemMetadata.hash.defaultValue=f0fda58630310a6dd91a7d8f0a4ceda2
Valeur de hachage fournie par l'appelant de l'API. Vous pouvez l'utiliser avec items.push pour calculer l'état modifié. La longueur maximale est de 2 048 caractères. Si hash.field n'est pas défini sur une valeur, la valeur de hash.defaultValue est utilisé.

Formats de date et d'heure

Les formats de date et d'heure spécifient les formats attendus dans les attributs de métadonnées. Si le fichier de configuration ne contient pas ce paramètre, des valeurs par défaut sont utilisées. Le tableau suivant présente ce paramètre.

Paramètre Paramètre
Autres formats de date et d'heure structuredData.dateTimePatterns=MM/dd/uuuu HH:mm:ssXXX
Liste de java.time.format.DateTimeFormatter supplémentaires séparés par un point-virgule modèles de ML. Les formats sont utilisés lors de l'analyse des valeurs de chaîne pour tous les champs de date ou de date/heure dans les métadonnées ou le schéma. La valeur par défaut est une liste vide, mais les normes RFC 3339 et RFC 1123 sont toujours acceptés.

Données structurées

L'API Cloud Search Indexing fournit un service de schéma que vous pouvez utiliser pour personnaliser la façon dont Cloud Search indexe et diffuse vos données. Si vous utilisez un schéma du dépôt local, vous devez spécifier la valeur nom du schéma.

Paramètre Paramètre
Nom du schéma local structuredData.localSchema=mySchemaName

Le nom du schéma est lu à partir de la source de données et utilisé pour le dépôt données structurées.

La valeur par défaut est une chaîne vide.

Qualité du contenu et de la recherche

Pour les dépôts contenant du contenu basé sur des enregistrements ou des champs (tels que CRM, CVS, ou une base de données), le SDK permet un format HTML automatique pour les champs de données. Votre Le connecteur définit les champs de données au début de son exécution. Ensuite, il utilise un modèle de contenu pour mettre en forme chaque enregistrement de données avant de l'importer dans Cloud Search.

Le modèle de contenu définit l'importance de chaque valeur de champ pour la recherche. L'élément HTML <title> est obligatoire et défini comme ayant la priorité la plus élevée. Vous pouvez Indiquez les niveaux d'importance de la qualité de la recherche pour tous les autres champs de contenu: élevé, moyen ou faible. Tout champ de contenu non défini dans une catégorie spécifique est défini par défaut sur une priorité faible.

Paramètre Paramètre
Titre HTML du contenu contentTemplate.templateName.title=myTitleField

Titre HTML du contenu et champ présentant la meilleure qualité de recherche. Ce paramètre est obligatoire uniquement si vous utilisez un modèle de contenu HTML. La valeur par défaut est vide .

Qualité de recherche élevée pour les champs de contenu contentTemplate.templateName.quality.high=hField1,hField2

Champs de contenu disposant d'une priorité de recherche élevée. La valeur par défaut est une chaîne vide.

Qualité de recherche moyenne pour les champs de contenu contentTemplate.templateName.quality.medium=mField1,mField2

Champs de contenu associés à une priorité de recherche moyenne. La valeur par défaut est une chaîne vide.

Mauvaise qualité de recherche pour les champs de contenu contentTemplate.templateName.quality.low=lField1,lField2

Champs de contenu associés à une priorité de recherche faible. La valeur par défaut est une chaîne vide.

Champs de contenu non spécifiés contentTemplate.templateName.unmappedColumnsMode=value

Façon dont le connecteur gère les champs de contenu non spécifiés. Les valeurs valides sont les suivantes :

  • APPEND : ajoute les champs de contenu non spécifiés au modèle
  • IGNORE : ignore les champs de contenu non spécifiés

    La valeur par défaut est APPEND.

Inclure les noms des champs dans le modèle HTML contentTemplate.templateName.includeFieldName=true|false

Indique si les noms des champs doivent être inclus avec les données de champ dans le code HTML modèle. La valeur par défaut est true et permet d'inclure les noms de champs dans l'index de recherche dans les données de contenu.

Paramètres rarement définis

Vous avez rarement besoin de définir les paramètres répertoriés dans cette section. Les valeurs par défaut des paramètres sont afin d'optimiser les performances. Google déconseille de définir ces paramètres sur de valeurs différentes des valeurs par défaut sans exigences spécifiques dans votre un dépôt de clés.

Configuration du proxy

Le SDK vous permet de configurer votre connecteur afin qu'il utilise un proxy pour les connexions sortantes.

Les paramètres transport.proxy.hostname et transport.proxy.port sont requis pour activer le transport via un proxy. Les autres paramètres peuvent être requis si votre proxy nécessite une authentification ou fonctionne sur le protocole SOCKS au lieu de HTTP. Si transport.proxy.hostname n'est pas défini, le SDK n'utilisera pas de proxy.

Paramètre Paramètre
Nom d'hôte transport.proxy.hostname=hostname

Nom d'hôte du serveur proxy. Ce paramètre est obligatoire lors de l'utilisation d'un proxy.

Port transport.proxy.port=port

Numéro de port du serveur proxy. Ce paramètre est obligatoire lors de l'utilisation d'un proxy.

Type de proxy transport.proxy.type=type

Type de proxy. Les valeurs valides sont les suivantes :

  • HTTP : le proxy accepte et transfère les requêtes via HTTP.
  • SOCKS : le proxy accepte et transfère les paquets via le protocole SOCKS.

La valeur par défaut est HTTP.
Nom d'utilisateur transport.proxy.username=username

Nom d'utilisateur à utiliser lors de la création d'un jeton d'autorisation de proxy. Ce paramètre est facultatif et ne doit être défini que si votre proxy nécessite une authentification.

Mot de passe transport.proxy.password=password

Mot de passe à utiliser lors de la création d'un jeton d'autorisation de proxy. Ce paramètre est facultatif et ne doit être défini que si votre proxy nécessite une authentification.

Balayeuses

Le SDK vous permet de spécifier plusieurs balayages individuels des balayages parallèles dans un référentiel de données. Les connecteurs de modèle de SDK utilisent .

Paramètre Paramètre
Taille du pool de threads traverse.threadPoolSize=size

Nombre de threads créés par le connecteur pour permettre le traitement en parallèle. A un itérateur unique récupère les opérations en série (généralement des objets RepositoryDoc). mais l'API appelle les processus en parallèle en utilisant ce nombre de threads.

La valeur par défaut est 5.

Taille de la partition traverse.partitionSize=batchSize

Nombre de ApiOperation() à traiter par lots avant de récupérer des APIOperation supplémentaires.

La valeur par défaut est 50.

Demandes de sondage Traverser

Le cœur de la file d'attente d'indexation Cloud Search est une file d'attente prioritaire contenant pour chaque élément connu. Un connecteur de fiches peut demander à interroger de l'API d'indexation. Une demande de sondage obtient les entrées ayant la priorité la plus élevée de la file d'attente d'indexation.

Les paramètres suivants sont utilisés par le modèle de connecteur de liste de SDK pour : définir des paramètres d'interrogation.

Paramètre Paramètre
Traverseur de dépôt repository.traversers=t1, t2, t3, ...

Crée un ou plusieurs balayages individuels pour lesquels t1, t2, t3, ... est le nom unique de chaque élément. Chaque balayage nommé possède son propre ensemble de paramètres identifiés par le nom unique du balayage, traversers.t1.hostload et traversers.t2.hostload.
File d'attente à interroger traverser.pollRequest.queue=mySpecialQueue

Noms des files d'attente interrogées par ce balayage. La valeur par défaut est une chaîne vide (ce qui implique "par défaut").

traverser.t1.pollRequest.queue=mySpecialQueue

Si vous utilisez plusieurs balayages, définissez l'état de chaque élément. (où t1 représente un balayage spécifique).

Comportement de l'interrogation traverser.pollRequest.limit=maxItems

Nombre maximal d'éléments à renvoyer à partir d'une requête d'interrogation. La valeur par défaut est 0 (ce qui implique le maximum de l'API).

traverser.t1.pollRequest.limit=limit

Si vous utilisez plusieurs balayages, définissez l'état de chaque élément. (où t1 représente un balayage spécifique).

État de l'élément traverser.pollRequest.statuses=statuses

États spécifiques de l'élément interrogé par ce balayage, où statuses peut être toute combinaison de MODIFIED, NEW_ITEM (séparés par des virgules), la valeur par défaut est Chaîne vide (implique toutes les valeurs d'état).

traverser.t1.pollRequest.statuses=statusesForThisTraverser

Si vous utilisez plusieurs balayages, définissez l'état des éléments pour chacun d'eux (où t1, représente un balayage spécifique).

Charge de l'hôte traverser.hostload=threads

Nombre maximal de threads parallèles actifs disponibles pour l'interrogation. La valeur par défaut la valeur est 5.

traverser.t1.hostload=threadsForThisTraverser

Si vous utilisez plusieurs balayages, définissez l'état des éléments pour chacun d'eux (où t1, représente un balayage spécifique).
Délai avant expiration traverser.timeout=timeout

Valeur du délai avant expiration pour l'interruption de cette tentative d'interrogation de balayage.

La valeur par défaut est 60.

traverser.t1.timeout=timeoutForThisTraverser

Si vous utilisez plusieurs balayages, définissez l'état des éléments pour chacun d'eux (où t1, représente un balayage spécifique).
traverser.timeunit=timeoutUunit

Unités du délai avant expiration. Les valeurs valides sont SECONDS, MINUTES,

traverser.t1.timeunit=timeoutUnit

Si vous utilisez plusieurs balayages, définissez l'état des éléments pour chacun d'eux (où t1, représente un balayage spécifique).

Dans la plupart des cas, un connecteur utilisant uniquement le modèle de connecteur listant le SDK nécessite un ensemble unique de paramètres pour l'interrogation. Dans certains cas, vous devrez peut-être définir plusieurs critères d'interrogation si votre algorithme de balayage séparer le traitement des éléments à l'aide de différentes files d'attente, par exemple.

Dans ce cas, vous avez la possibilité de définir plusieurs jeux d'interrogation paramètres. Commencez par spécifier les noms des jeux de paramètres en utilisant repository.traversers Pour chaque nom de balayage défini, indiquez le de configuration Terraform en remplaçant les paramètres du tableau ci-dessus t1 par le nom du balayage. Cela crée un ensemble de sondages pour chaque balayage défini.

Points de contrôle

Un point de contrôle permet de suivre l'état d'un balayage incrémentiel.

Paramètre Paramètre
Répertoire des points de contrôle connector.checkpointDirectory=/path/to/checkpoint

Indique le chemin d'accès au répertoire local à utiliser pour les points de contrôle de balayage incrémentiel et complet.

Importations de contenus

Le contenu de l'élément est importé dans Cloud Search avec celui-ci lorsque l'élément la taille du contenu ne dépasse pas le seuil spécifié. Si la taille du contenu dépasse le seuil, le contenu est importé séparément des métadonnées et des données structurées.

Paramètre Paramètre
Seuil de contenu api.contentUploadThresholdBytes=bytes

Seuil applicable au contenu qui détermine s'il est importé "en ligne" par l'article au lieu d'effectuer une importation distincte.

La valeur par défaut est 100000 (~100 Ko).

Conteneurs

Le modèle de connecteur complet utilise un algorithme faisant intervenir le concept activation/désactivation de la file d'attente des sources de données temporaires pour détecter les enregistrements supprimés dans la base de données. Ainsi, à chaque balayage complet, les enregistrements récupérés, qui se trouvent dans un nouvelle file d'attente, remplacez tous les enregistrements Cloud Search existants indexés à partir de la de balayage précédent, qui se trouvent dans une ancienne file d'attente.

Paramètre Paramètre
Tag de nom du conteneur traverse.queueTag=instance

Pour exécuter plusieurs instances du connecteur en parallèle afin d'indexer des données communes (que ce soit sur des dépôts de données différents ou sur des parties distinctes d'un sans interférer les uns avec les autres, attribuez-lui un conteneur unique à chaque exécution du connecteur. Un tag de nom unique empêche un connecteur de supprimer les enregistrements d'une autre instance.

Le tag de nom est ajouté à l'ID de file d'attente d'activation/de désactivation du connecteur de balayage complet.
Désactiver la détection des suppressions traverse.useQueues=true|false

Indique si le connecteur utilise une logique d'activation/de désactivation de la file d'attente pour la détection des suppressions.

La valeur par défaut est true, qui spécifie que les files d'attente doivent être utilisé.

Remarque: Ce paramètre de configuration ne s'applique qu'aux connecteurs en implémentant le modèle FullTraversalConnector.

Règle de traitement par lot

Le SDK accepte une stratégie de traitement par lot qui vous permet d'effectuer les opérations suivantes : actions:

  • Requêtes par lot
  • Spécifier le nombre de requêtes dans une file d'attente par lot
  • Gérer les lots exécutés simultanément
  • Vider les requêtes par lot

Le SDK regroupe les requêtes du connecteur pour accélérer le débit mises en ligne. Le déclencheur SDK pour importer un lot de requêtes est le nombre de requêtes ou le délai avant expiration, selon la première échéance atteinte. Par exemple, si le le délai de traitement du lot a expiré sans que la taille de lot n'ait été atteinte, ou si le le nombre d'éléments de la taille de lot est atteint avant l'expiration du délai, puis l'importation groupée est déclenchée.

Paramètre Paramètre
Requêtes par lot batch.batchSize=batchSize

Envoyez des requêtes par lot. La valeur par défaut est 10.
Nombre de requêtes dans une file d'attente par lot batch.maxQueueLength=maxQueueLength

Nombre maximal de requêtes dans une file d'attente par lot pour l'exécution. La valeur par défaut est 1000..

Exécution simultanée de lots batch.maxActiveBatches=maxActiveBatches

Nombre de lots autorisés en cours d'exécution simultanée. La valeur par défaut est 20.

Vider automatiquement les requêtes par lot batch.maxBatchDelaySeconds=maxBatchDelay

Nombre de secondes d'attente avant que les requêtes par lot ne soient traitées sont automatiquement vidées. La la valeur par défaut est 5.

Vider les requêtes par lot à l'arrêt batch.flushOnShutdown=true|false

Videz les requêtes par lot à l'arrêt du service. La valeur par défaut est true.

Gestionnaires d'exceptions

Les paramètres des gestionnaires d'exceptions déterminent le déroulement du balayage rencontre une exception.

Paramètre Paramètre
Instruction de balayage en cas d'erreur traverse.exceptionHandler=exceptions

Procédure à suivre pour le balayage après la génération d'une exception. Valeurs valides sont:

  • 0 : annulez toujours le balayage en cas d'exception.
  • num_exceptions (par exemple, 10) : annulation après le balayage rencontre le num_exceptions spécifié.

    La valeur par défaut est 0 (toujours annuler en cas d'erreur).

  • ignore : ignorer l'erreur
Temps d'attente entre les exceptions abortExceptionHander.backoffMilliSeconds=backoff

Délai d'attente en millisecondes entre chaque exception de gestionnaire détectée (généralement utilisé lors du balayage d'un dépôt). La valeur par défaut est 10.