Ressource REST : projects.locations.dataSourceDefinitions

Ressource : DataSourceDefinition

Représente la définition de la source de données.

Représentation JSON 

{
  "name": string,
  "dataSource": {
    object(DataSource)
  },
  "transferRunPubsubTopic": string,
  "runTimeOffset": string,
  "supportEmail": string,
  "serviceAccount": string,
  "disabled": boolean,
  "transferConfigPubsubTopic": string,
  "supportedLocationIds": [
    string
  ]
}
Champs
name

string

Nom de ressource de la définition de la source de données. Les noms des définitions de sources de données sont au format projects/{projectId}/locations/{location}/dataSourceDefinitions/{dataSourceId}.

dataSource

object(DataSource)

Métadonnées de la source de données.
transferRunPubsubTopic

string

Sujet Pub/Sub à utiliser pour diffuser un message lors de la création d'une exécution de transfert. Ce sujet et le sujet transferConfigPubsubTopic peuvent être personnalisés. Par défaut, les deux sujets sont générés automatiquement si aucun d'entre eux n'est fourni lors de la création de la définition. Toutefois, si l'un des sujets est défini manuellement, l'autre doit également être défini manuellement. La seule différence réside dans le fait que transferRunPubsubTopic doit être un sujet Pub/Sub non vide, alors que le champ transferConfigPubsubTopic peut être vide. Les commentaires sur "{location}" pour transferConfigPubsubTopic s'appliquent également ici.

runTimeOffset

string (Duration format)

Durée à ajouter à l'heure de planification (scheduleTime) pour calculer le temps d'exécution (runTime) lorsque la tâche est planifiée. Ne s'applique qu'aux exécutions de transferts planifiées automatiquement. Permet de lancer une exécution prématurée sur une source de données compatible avec l'actualisation continue des données pour compenser les décalages horaires inconnus. Utilisez un nombre négatif pour lancer une exécution tardive sur les sources de données non compatibles avec l'actualisation continue des données.

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".
supportEmail

string

Adresse e-mail d'assistance de la marque du client OAuth, qui contient les données de l'écran d'autorisation.
serviceAccount

string

Une fois le compte de service spécifié, BigQuery partage l'ensemble de données créé avec le compte de service donné. De plus, ce compte de service pourra effectuer des mises à jour d'état et consigner les messages afin d'exécuter des transferts de données pour l'ID de la source de données (dataSourceId) correspondant.

disabled

boolean

La source de données est-elle désactivée ? Si la valeur est "true", la source de données (dataSource) n'est pas visible. L'API arrête également de renvoyer les configurations et/ou les exécutions de transferts de données associées à la source de données. Ce paramètre a une priorité plus élevée que les identifiants "whitelisted_project_id".

transferConfigPubsubTopic

string

Sujet Pub/Sub à utiliser pour diffuser un message sur la configuration du transfert. Si vous ne le renseignez pas, aucun message ne sera diffusé. Ce sujet et le sujet transferRunPubsubTopic sont générés automatiquement si aucun d'entre eux n'est fourni lors de la création de la définition. Il est recommandé de renseigner le sujet transferConfigPubsubTopic si un sujet transferRunPubsubTopic détenu par l'utilisateur est fourni. Sinon, il sera vide. Si la valeur comprend "{location}", cela signifie que la source de données souhaite gérer les messages séparément pour les ensembles de données dans différentes régions. Nous remplaçons "{location}" par l'emplacement réel de l'ensemble de données, en tant que nom de sujet réel. Par exemple, projects/connector/topics/scheduler-{location} peut devenir projects/connector/topics/scheduler-us. Si "{location}" est introuvable, nous utilisons la valeur d'entrée comme nom de sujet.

supportedLocationIds[]

string

Les identifiants "location_id" compatibles sont utilisés pour déterminer les emplacements dans lesquels créer des sujets Pub/Sub. Si des sujets Pub/Sub personnalisés sont utilisés et contiennent "{location}", ce champ est remplacé par l'emplacement individuel de la liste en fonction des identifiants "locations_id". Les valeurs valides correspondent au champ "locationId" de la réponse de GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations. De plus, si la source de données doit être compatible avec toutes les régions disponibles, vous pouvez définir supportedLocationIds sur "global" (soit sur un seul élément de chaîne). Lorsque "global" est spécifié : 1) la mise en œuvre de la source de données est censée préparer les données dans la région appropriée de l'ensemble de données de destination ; 2) le développeur de la source de données doit connaître les implications de la région associée au paramètre "global" (par exemple, la latence du trafic réseau, le coût potentiel associé au trafic interrégional, etc.).

Méthodes

create

 Crée une définition de source de données.

delete

 Supprime une définition de source de données. Toutes les configurations de transfert associées à la définition (le cas échéant) doivent d'abord être supprimées par l'utilisateur dans TOUTES les régions pour que la suppression soit possible.

get

 Récupère une définition de source de données existante.

list

 Répertorie les définitions de source de données compatibles.

patch

 Met à jour une définition de source de données existante.