Package google.cloud.bigquery.datatransfer.v1

Index

DataTransferService

L'API du service de transfert de données Google BigQuery permet aux utilisateurs de BigQuery de configurer le transfert de données à partir d'autres produits Google vers BigQuery. Ce service contient des méthodes exposées aux utilisateurs finaux. Il sauvegarde l'interface.

CheckValidCreds

rpc CheckValidCreds(CheckValidCredsRequest) returns (CheckValidCredsResponse)

Renvoie la valeur "true" si des identifiants valides existent pour la source de données présentée et l'utilisateur demandeur. Comme certaines sources de données ne sont pas compatibles avec le compte de service, nous devons interagir avec elles au nom de l'utilisateur final. Cette API vérifie simplement si nous disposons d'un jeton OAuth pour l'utilisateur concerné, ce qui est nécessaire pour qu'il puisse créer une configuration de transfert.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
CreateTransferConfig

rpc CreateTransferConfig(CreateTransferConfigRequest) returns (TransferConfig)

Crée une configuration de transfert de données.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
DeleteTransferConfig

rpc DeleteTransferConfig(DeleteTransferConfigRequest) returns (Empty)

Supprime une configuration de transfert de données, y compris les exécutions de transfert et les journaux associés.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
DeleteTransferRun

rpc DeleteTransferRun(DeleteTransferRunRequest) returns (Empty)

Supprime l'exécution de transfert spécifiée.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
GetDataSource

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

Récupère une source de données compatible et renvoie ses paramètres, qui peuvent être utilisés pour l'affichage dans l'interface utilisateur.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
GetTransferConfig

rpc GetTransferConfig(GetTransferConfigRequest) returns (TransferConfig)

Renvoie des informations sur une configuration de transfert de données.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
GetTransferRun

rpc GetTransferRun(GetTransferRunRequest) returns (TransferRun)

Renvoie des informations sur l'exécution de transfert spécifique.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
ListDataSources

rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse)

Répertorie les sources de données compatibles et renvoie leurs paramètres, qui peuvent être utilisés pour l'affichage dans l'interface utilisateur.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
ListTransferConfigs

rpc ListTransferConfigs(ListTransferConfigsRequest) returns (ListTransferConfigsResponse)

Renvoie des informations sur tous les transferts de données du projet.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
ListTransferLogs

rpc ListTransferLogs(ListTransferLogsRequest) returns (ListTransferLogsResponse)

Renvoie les messages de journal destinés aux utilisateurs pour l'exécution du transfert de données.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
ListTransferRuns

rpc ListTransferRuns(ListTransferRunsRequest) returns (ListTransferRunsResponse)

Renvoie des informations sur les tâches en cours ou terminées.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
ScheduleTransferRuns

rpc ScheduleTransferRuns(ScheduleTransferRunsRequest) returns (ScheduleTransferRunsResponse)

Crée des exécutions de transfert pour une période [start_time, end_time]. Pour chaque date comprise dans la plage, ou toute précision que la source de données accepte, une exécution de transfert est créée. Notez que les exécutions pour une période sont exprimées en temps UTC. OBSOLÈTE : utilisez StartManualTransferRuns à la place.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
StartManualTransferRuns

rpc StartManualTransferRuns(StartManualTransferRunsRequest) returns (StartManualTransferRunsResponse)

Démarre manuellement des exécutions de transfert, où la valeur schedule_time est égale à l'heure actuelle. Les exécutions de transfert peuvent être créées pour une période où le paramètre run_time est compris entre start_time (inclus) et end_time (exclu), ou pour un paramètre run_time spécifique.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.
UpdateTransferConfig

rpc UpdateTransferConfig(UpdateTransferConfigRequest) returns (TransferConfig)

Met à jour une configuration de transfert de données. Tous les champs doivent être définis, même s'ils ne sont pas mis à jour.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la section Présentation de l'authentification.

CheckValidCredsRequest

Requête permettant de déterminer si l'utilisateur dispose d'identifiants valides. Cette méthode permet de limiter le nombre de fenêtres pop-up OAuth dans l'interface utilisateur. L'ID utilisateur est obtenu à partir du contexte d'appel de l'API. Si la source de données dispose du type d'autorisation Google+, cette méthode renvoie la valeur "false", car il est impossible de déterminer si les identifiants sont déjà valides uniquement en fonction de l'ID utilisateur.

Champs
name

string

Obligatoire. La source de données au format suivant : projects/{project_id}/dataSources/{data_source_id} ou projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • bigquery.transfers.get

CheckValidCredsResponse

Une réponse indiquant si les identifiants existent et sont valides.

Champs
has_valid_creds

bool

Si la valeur est définie sur true, les identifiants existent et sont valides.

CreateTransferConfigRequest

Requête permettant de créer une configuration de transfert de données. Si de nouveaux identifiants sont nécessaires pour cette configuration de transfert, un code d'autorisation doit être fourni. Si un code d'autorisation est fourni, la configuration de transfert sera associée à l'ID utilisateur correspondant au code d'autorisation. Sinon, la configuration de transfert sera associée à l'utilisateur appelant.

Champs
parent

string

Obligatoire. ID du projet BigQuery dans lequel la configuration de transfert doit être créée. Doit être au format suivant : projects/{project_id}/locations/{location_id} ou projects/{project_id}. Si l'emplacement spécifié et l'emplacement de l'ensemble de données BigQuery de destination ne correspondent pas, la requête échoue.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • bigquery.transfers.update
transfer_config

TransferConfig

Obligatoire. Configuration de transfert de données à créer.
authorization_code

string

Code d'autorisation OAuth2 facultatif à utiliser avec cette configuration de transfert. Ce paramètre est obligatoire si de nouveaux identifiants sont nécessaires, comme indiqué par CheckValidCreds. Pour obtenir le code d'autorisation, envoyez une demande à https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=

  • client_id doit être l'ID client OAuth de l'API DTS BigQuery pour la source de données présentée, renvoyée par la méthode ListDataSources.
  • data_source_scopes correspond aux champs d'application renvoyés par la méthode ListDataSources.
  • redirect_uri est un paramètre facultatif. S'il n'est pas spécifié, le code d'autorisation est publié lors de l'ouverture de la fenêtre du flux d'autorisation. Sinon, il sera envoyé à l'URI de redirection. Une valeur spéciale de urn:ietf:wg:oauth:2.0:oob signifie que le code d'autorisation doit être renvoyé dans la barre de titre du navigateur, avec le texte de la page invitant l'utilisateur à copier le code et à le coller dans l'application.
version_info

string

Informations facultatives sur la version. Si les utilisateurs souhaitent trouver un jeton d'accès très récent (c'est-à-dire, immédiatement après l'approbation de l'accès), ils doivent définir la revendication version_info dans la requête de jeton. Pour obtenir le paramètre version_info, les utilisateurs doivent utiliser le type de réponse "none+gsession". Cela renvoie un élément version_info dans la réponse d'autorisation qui doit être placé dans une revendication JWT au sein de la requête de jeton.
service_account_name

string

Nom du compte de service facultatif. Si ce champ est défini, la configuration de transfert sera créée avec ces identifiants de compte de service. Nécessite que les utilisateurs qui appellent cette API aient l'autorisation d'agir en tant que compte de service.

DataSource

Représente les métadonnées relatives à la source de données. Les métadonnées sont suffisantes pour afficher l'interface utilisateur et demander des jetons OAuth appropriés.

Champs
name

string

Uniquement en sortie. Nom de la ressource source de données.
data_source_id

string

ID de la source de données.
display_name

string

Nom convivial de la source de données.
description

string

Chaîne de description conviviale de la source de données.
client_id

string

ID client de la source de données à utiliser pour recevoir le jeton d'actualisation.
scopes[]

string

Champs d'application Auth de l'API pour lesquels le jeton d'actualisation doit être obtenu. Il s'agit des champs d'application requis par une source de données pour préparer des données et les intégrer dans BigQuery, par exemple : https://www.googleapis.com/auth/bigquery.
transfer_type
(deprecated)

TransferType

Obsolète. Ce champ n'a aucun effet.
supports_multiple_transfers
(deprecated)

bool

Obsolète. Ce champ n'a aucun effet.
update_deadline_seconds

int32

Nombre de secondes d'attente d'une mise à jour de la source de données avant que le service de transfert de données n'indique l'état ÉCHEC.
default_schedule

string

Planification du transfert de données par défaut. Exemples de planifications valides : 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 et first sunday of quarter 00:00.
supports_custom_schedule

bool

Indique si la source de données est compatible avec une planification définie par l'utilisateur ou fonctionne selon la programmation par défaut. Si ce paramètre est défini sur true, l'utilisateur peut remplacer la programmation par défaut.
parameters[]

DataSourceParameter

Paramètres de source de données
help_url

string

URL du document d'aide de cette source de données.
authorization_type

AuthorizationType

Indique le type d'autorisation.
data_refresh_type

DataRefreshType

Indique si la source de données est compatible avec l'actualisation automatique des données au cours des derniers jours et la manière dont elle est compatible. Pour certaines sources, les données peuvent n'être complètes que quelques jours plus tard. Il est donc utile d'actualiser automatiquement les données.
default_data_refresh_window_days

int32

Fenêtre d'actualisation des données par défaut en fonction des jours. Utile seulement lorsque data_refresh_type est égal à SLIDING_WINDOW.
manual_runs_disabled

bool

Désactive le remplissage et la planification manuelle des exécutions pour la source de données.
minimum_schedule_interval

Duration

Intervalle minimal requis pour la planification des exécutions par le planificateur.

AuthorizationType

Type d'autorisation nécessaire pour cette source de données.

Enums
AUTHORIZATION_TYPE_UNSPECIFIED Type non spécifié.
AUTHORIZATION_CODE Utilisez des codes d'autorisation OAuth 2 pouvant être échangés contre un jeton d'actualisation sur le backend.
GOOGLE_PLUS_AUTHORIZATION_CODE Renvoie un code d'autorisation pour une page Google+ donnée, qui peut ensuite être échangé contre un jeton d'actualisation sur le backend.
FIRST_PARTY_OAUTH Utilisez l'accès OAuth propriétaire en fonction des clients détenus par Loas. L'accès OAuth propriétaire ne nécessite pas de jeton d'actualisation pour obtenir un jeton d'accès hors connexion. Il utilise plutôt une assertion JWT signée par le client pour récupérer un jeton d'accès.

DataRefreshType

Représente la façon dont la source de données est compatible avec l'actualisation automatique des données.

Enums
DATA_REFRESH_TYPE_UNSPECIFIED La source de données n'est pas compatible avec l'actualisation automatique des données, qui est une valeur par défaut.
SLIDING_WINDOW La source de données est compatible avec l'actualisation automatique des données et son exécution est planifiée pendant les derniers jours. Ne permet pas de définir des valeurs personnalisées pour chaque configuration de transfert.
CUSTOM_SLIDING_WINDOW La source de données est compatible avec l'actualisation automatique des données et son exécution est planifiée pendant les derniers jours. Permet de définir des valeurs personnalisées pour chaque configuration de transfert.

DataSourceParameter

Représente un paramètre de source de données avec des règles de validation afin que les paramètres puissent être affichés dans l'interface utilisateur. Ces paramètres nous sont fournis par les sources de données compatibles, et comprennent toutes les informations requises pour l'affichage et la validation. Ainsi, toute personne qui utilise cette API peut décider de générer des interfaces utilisateur génériques ou des formulaires spécifiques aux sources de données personnalisées.

Champs
param_id

string

Identifiant du paramètre.
display_name

string

Nom à afficher du paramètre dans l'interface utilisateur.
description

string

Description du paramètre.
type

Type

Type de paramètre.
required

bool

Paramètre requis.
repeated

bool

Obsolète. Ce champ n'a aucun effet.
validation_regex

string

Expression régulière pouvant être utilisée pour la validation des paramètres.
allowed_values[]

string

Toutes les valeurs possibles du paramètre.
min_value

DoubleValue

Pour les valeurs entières et doubles, spécifiez une valeur minimale autorisée.
max_value

DoubleValue

Pour les valeurs entières et doubles, indiquez une valeur maximale autorisée.
fields[]

DataSourceParameter

Obsolète. Ce champ n'a aucun effet.
validation_description

string

Description des conditions requises pour ce champ, au cas où l'entrée utilisateur ne respecte pas le modèle d'expression régulière ou les valeurs minimales/maximales.
validation_help_url

string

URL d'un document d'aide qui explique plus en détail les règles de dénomination.
immutable

bool

Non modifiable après sa création initiale.
recurse

bool

Obsolète. Ce champ n'a aucun effet.
deprecated

bool

Si la valeur est définie sur "true", elle ne doit pas être utilisée dans de nouveaux transferts et n'est pas visible par les utilisateurs.

Type

Type de paramètre.

Enums
TYPE_UNSPECIFIED Type non spécifié.
STRING Paramètre de chaîne.
INTEGER Paramètre entier (64 bits). Sera sérialisé vers JSON en tant que chaîne.
DOUBLE Paramètre à virgule flottante avec deux décimales.
BOOLEAN Paramètre booléen.
RECORD Obsolète. Ce champ n'a aucun effet.
PLUS_PAGE ID d'une page Google+.

DeleteTransferConfigRequest

Requête permettant de supprimer des informations sur le transfert de données. Toutes les exécutions de transfert et tous les messages de journal associés seront également supprimés.

Champs
name

string

Obligatoire. Le champ contient le nom de la ressource demandée, par exemple : projects/{project_id}/transferConfigs/{config_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • bigquery.transfers.update

DeleteTransferRunRequest

Requête permettant de supprimer des informations sur le transfert de données.

Champs
name

string

Obligatoire. Le champ contient le nom de la ressource demandée, par exemple : projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • bigquery.transfers.update

EmailPreferences

Représente les préférences permettant d'envoyer des notifications par e-mail pour les événements de simulation de transfert.

Champs
enable_failure_email

bool

Si la valeur est définie sur "true", les notifications sont envoyées par e-mail en cas d'échec d'exécution des transferts.

GetDataSourceRequest

Requête permettant d'obtenir des informations sur la source de données.

Champs
name

string

Obligatoire. Le champ contient le nom de la ressource demandée, par exemple : projects/{project_id}/dataSources/{data_source_id} ou projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • bigquery.transfers.get

GetTransferConfigRequest

Requête permettant d'obtenir des informations sur le transfert de données.

Champs
name

string

Obligatoire. Le champ contient le nom de la ressource demandée, par exemple : projects/{project_id}/transferConfigs/{config_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • bigquery.transfers.get

GetTransferRunRequest

Requête permettant d'obtenir des informations sur l'exécution du transfert de données.

Champs
name

string

Obligatoire. Le champ contient le nom de la ressource demandée, par exemple : projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • bigquery.transfers.get

ListDataSourcesRequest

Requête permettant de répertorier les sources de données acceptées et les paramètres de transfert de données.

Champs
parent

string

Obligatoire. ID du projet BigQuery pour lequel les sources de données doivent être renvoyées. Doit se présenter sous la forme : projects/{project_id} ou `projects/{project_id}/locations/{location_id}

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • bigquery.transfers.get
page_token

string

Jeton de pagination qui peut être utilisé pour demander une page spécifique de résultats ListDataSourcesRequest. Pour les résultats de plusieurs pages, ListDataSourcesResponse génère un jeton next_page, qui peut être utilisé comme valeur page_token pour demander la page suivante de résultats.
page_size

int32

Taille de la page. La taille de page par défaut correspond à la valeur maximale de 1 000 résultats.

ListDataSourcesResponse

Renvoie la liste des sources de données acceptées et leurs métadonnées.

Champs
data_sources[]

DataSource

Liste des sources de données acceptées et leurs paramètres de transfert.
next_page_token

string

Uniquement en sortie. Jeton de pagination suivant. Pour les résultats de plusieurs pages, ce jeton peut être utilisé comme ListDataSourcesRequest.page_token pour demander la page suivante de résultats.

ListTransferConfigsRequest

Requête permettant de répertorier les transferts de données configurés pour un projet BigQuery.

Champs
parent

string

Obligatoire. ID du projet BigQuery pour lequel les sources de données doivent être renvoyées : projects/{project_id} ou projects/{project_id}/locations/{location_id}

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • bigquery.transfers.get
data_source_ids[]

string

Si spécifié, seules les configurations des sources de données demandées sont renvoyées.
page_token

string

Jeton de pagination qui peut être utilisé pour demander une page spécifique de résultats ListTransfersRequest. Pour les résultats de plusieurs pages, ListTransfersResponse génère un jeton next_page, qui peut être utilisé comme valeur page_token pour demander la page suivante de résultats.
page_size

int32

Taille de la page. La taille de page par défaut correspond à la valeur maximale de 1 000 résultats.

ListTransferConfigsResponse

Liste des pipelines renvoyés dans le projet.

Champs
transfer_configs[]

TransferConfig

Uniquement en sortie. Configurations de transfert de pipeline stockées.
next_page_token

string

Uniquement en sortie. Jeton de pagination suivant. Pour les résultats de plusieurs pages, ce jeton peut être utilisé comme ListTransferConfigsRequest.page_token pour demander la page suivante de résultats.

ListTransferLogsRequest

Requête permettant d'obtenir les messages de journal destinés aux utilisateurs associés à l'exécution de transfert de données.

Champs
parent

string

Obligatoire. Nom de l'exécution de transfert au format suivant : projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • bigquery.transfers.get
page_token

string

Jeton de pagination qui peut être utilisé pour demander une page spécifique de résultats ListTransferLogsRequest. Pour les résultats de plusieurs pages, ListTransferLogsResponse génère un jeton next_page, qui peut être utilisé comme valeur page_token pour demander la page suivante de résultats.
page_size

int32

Taille de la page. La taille de page par défaut correspond à la valeur maximale de 1 000 résultats.
message_types[]

MessageSeverity

Types de messages à renvoyer. Si la valeur n'est pas renseignée, les messages INFO, WARNING et ERROR sont renvoyés.

ListTransferLogsResponse

Liste des messages d'exécution de transfert renvoyés.

Champs
transfer_messages[]

TransferMessage

Uniquement en sortie. Messages de transfert de pipeline stockés.
next_page_token

string

Uniquement en sortie. Jeton de pagination suivant. Pour les résultats de plusieurs pages, ce jeton peut être utilisé comme GetTransferRunLogRequest.page_token pour demander la page suivante de résultats.

ListTransferRunsRequest

Requête permettant de répertorier les exécutions de transfert de données. L'interface utilisateur peut utiliser cette méthode pour afficher ou filtrer les exécutions de transfert de données spécifiques. La source de données peut utiliser cette méthode pour demander toutes les exécutions de transfert planifiées.

Champs
parent

string

Obligatoire. Nom de la configuration de transfert pour laquelle les exécutions de transfert doivent être récupérées. Le format de nom de la ressource de configuration du transfert est le suivant : projects/{project_id}/transferConfigs/{config_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • bigquery.transfers.get
states[]

TransferState

Si spécifié, seules les exécutions de transfert avec les états demandés sont renvoyées.
page_token

string

Jeton de pagination qui peut être utilisé pour demander une page spécifique de résultats ListTransferRunsRequest. Pour les résultats de plusieurs pages, ListTransferRunsResponse génère un jeton next_page, qui peut être utilisé comme valeur page_token pour demander la page suivante de résultats.
page_size

int32

Taille de la page. La taille de page par défaut correspond à la valeur maximale de 1 000 résultats.
run_attempt

RunAttempt

Indique comment récupérer les tentatives d'exécution.

RunAttempt

Représente les exécutions à extraire.

Enums
RUN_ATTEMPT_UNSPECIFIED Toutes les exécutions doivent être renvoyées.
LATEST Seule la dernière exécution du jour doit être renvoyée.

ListTransferRunsResponse

Liste des pipelines renvoyés dans le projet.

Champs
transfer_runs[]

TransferRun

Uniquement en sortie. Exécutions de transfert de pipeline stockées.
next_page_token

string

Uniquement en sortie. Jeton de pagination suivant. Pour les résultats de plusieurs pages, ce jeton peut être utilisé comme ListTransferRunsRequest.page_token pour demander la page suivante de résultats.

ScheduleOptions

Options permettant de personnaliser la planification du transfert de données.

Champs
disable_auto_scheduling

bool

Si la valeur est "true", la planification automatique des exécutions de transfert de données pour cette configuration sera désactivée. Les exécutions peuvent être démarrées sur une base ad hoc à l'aide de l'API StartManualTransferRun. Lorsque la planification automatique est désactivée, le champ TransferConfig.schedule est ignoré.
start_time

Timestamp

Spécifie l'heure de début de la planification des exécutions de transfert. La première exécution sera planifiée à l'heure de début ou après l'heure de début, selon un modèle de récurrence défini dans la chaîne de planification. L'heure de début peut être modifiée à tout moment. Cette option ne s'applique pas à l'heure à laquelle le transfert de données peut être appliqué manuellement.
end_time

Timestamp

Définit l'heure d'arrêt de la planification des exécutions de transfert. Une exécution de transfert ne peut être planifiée ni à l'heure de fin ni après l'heure de fin. L'heure de fin peut être modifiée à tout moment. Cette option ne s'applique pas à l'heure à laquelle le transfert de données peut être appliqué manuellement.

ScheduleTransferRunsRequest

Requête permettant de planifier des exécutions de transfert pour une période donnée.

Champs
parent

string

Obligatoire. Nom de la configuration de transfert au format suivant : projects/{project_id}/transferConfigs/{config_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • bigquery.transfers.update
start_time

Timestamp

Obligatoire. Heure de début de la plage d'exécutions de transfert. Par exemple, "2017-05-25T00:00:00+00:00".
end_time

Timestamp

Obligatoire. Heure de fin de la plage d'exécutions de transfert. Par exemple, "2017-05-30T00:00:00+00:00".

ScheduleTransferRunsResponse

Réponse permettant de planifier des exécutions de transfert pour une période donnée.

Champs
runs[]

TransferRun

Exécutions de transfert planifiées.

StartManualTransferRunsRequest

Requête permettant de démarrer des exécutions de transfert manuelles.

Champs
parent

string

Nom de la configuration de transfert au format suivant : projects/{project_id}/transferConfigs/{config_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • bigquery.transfers.update
Champ d'union time. Spécification temporelle demandée : il peut s'agir d'une période ou d'une valeur run_time spécifique. time ne peut être qu'un des éléments suivants :
requested_time_range

TimeRange

Période pendant laquelle les exécutions de transfert doivent être démarrées.
requested_run_time

Timestamp

Valeur run_time spécifique pour le démarrage d'une exécution de transfert. La valeur requested_run_time ne doit pas se situer dans le futur.

TimeRange

Une spécification pour une période donnée, requérant que le transfert s'exécute avec le paramètre run_time compris entre la valeur start_time (incluse) et la valeur end_time (exclue).

Champs
start_time

Timestamp

Heure de début de la plage d'exécutions de transfert. Par exemple, "2017-05-25T00:00:00+00:00". La valeur start_time doit être inférieure à la valeur end_time. Crée des exécutions de transfert où le paramètre run_time est compris entre la valeur start_time (incluse) et la valeur end_time (exclue).
end_time

Timestamp

Heure de fin de la plage d'exécutions de transfert. Par exemple, "2017-05-30T00:00:00+00:00". La valeur end_time ne doit pas se situer dans le futur. Crée des exécutions de transfert où le paramètre run_time est compris entre la valeur start_time (incluse) et la valeur end_time (exclue).

StartManualTransferRunsResponse

Réponse permettant de démarrer des exécutions de transfert manuelles.

Champs
runs[]

TransferRun

Exécutions de transfert créées.

TransferConfig

Représente une configuration de transfert de données. Une configuration de transfert contient toutes les métadonnées nécessaires à un transfert de données. Par exemple, destination_dataset_id spécifie l'emplacement de stockage des données. Lorsqu'une configuration de transfert est créée, l'ID destination_dataset_id spécifié est créé si nécessaire et partagé avec le compte de service de source de données approprié.

Champs
name

string

Nom de ressource de la configuration de transfert. Les noms de configuration de transfert se présentent sous le format suivant : projects/{project_id}/locations/{region}/transferConfigs/{config_id}. Le nom est généré automatiquement en fonction de l'élément config_id spécifié dans CreateTransferConfigRequest, avec l'ID de projet et la région. Si vous ne spécifiez pas d'élément config_id (généralement un UUID), un nom sera généré pour config_id même s'il n'est pas garanti ni requis.
display_name

string

Nom à afficher spécifié par l'utilisateur pour le transfert de données.
data_source_id

string

ID de la source de données. Ne peut pas être modifié une fois le transfert de données créé.
params

Struct

Paramètres spécifiques pour le transfert de données.
schedule

string

Planification du transfert de données. Si la source de données n'est pas compatible avec une planification personnalisée, ce champ doit être vide. Si ce champ est vide, la valeur par défaut de la source de données est utilisée. Les heures spécifiées sont exprimées en temps UTC. Exemples de format valide : 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 et first sunday of quarter 00:00. Pour en savoir plus sur le format, consultez la page https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format REMARQUE : La précision doit être d'au moins huit heures ou la fréquence doit être moins élevée.
schedule_options

ScheduleOptions

Options permettant de personnaliser la planification du transfert de données.
data_refresh_window_days

int32

Nombre de jours en fonction desquels l'actualisation automatique des données doit revenir en arrière. Par exemple, si la valeur est définie sur data_refresh_window_days = 10, BigQuery réingérera chaque jour les données pour [aujourd'hui-10, aujourd'hui-1] au lieu d'ingérer des données pour seulement [aujourd'hui-1]. Valide uniquement si la source de données est compatible avec cette fonctionnalité. Définissez la valeur sur zéro pour utiliser la valeur par défaut.
disabled

bool

Spécifie si la configuration est désactivée ou non. Si cette valeur est définie sur "true", aucune exécution n'est programmée pour un transfert donné.
update_time

Timestamp

Uniquement en sortie. Heure de modification du transfert de données. Ignoré par le serveur lors de la saisie.
next_run_time

Timestamp

Uniquement en sortie. La prochaine fois que le transfert de données sera exécuté.
state

TransferState

Uniquement en sortie. État de la dernière exécution de transfert mise à jour.
user_id

int64

Obsolète. Identifiant unique de l'utilisateur au nom duquel le transfert est effectué.
dataset_region

string

Uniquement en sortie. Région dans laquelle se trouve l'ensemble de données BigQuery.
notification_pubsub_topic

string

Sujet Pub/Sub dans lequel les notifications seront envoyées une fois les exécutions de transfert associées à cette configuration de transfert terminées.
email_preferences

EmailPreferences

Les notifications par e-mail seront envoyées en fonction de ces préférences à l'adresse e-mail de l'utilisateur propriétaire de cette configuration de transfert.
destination_dataset_id

string

ID de l'ensemble de données cible BigQuery.

TransferMessage

Représente le message destiné à un utilisateur pour une exécution de transfert de données particulière.

Champs
message_time

Timestamp

Heure à laquelle le message a été consigné.
severity

MessageSeverity

Gravité du message.
message_text

string

Texte du message.

MessageSeverity

Représente le niveau de gravité des messages de transfert de données visibles par l'utilisateur.

Enums
MESSAGE_SEVERITY_UNSPECIFIED Aucun niveau de gravité spécifié.
INFO Message d'information.
WARNING Message d'avertissement.
ERROR Message d'erreur.

TransferRun

Représente une exécution de transfert de données.

Champs
name

string

Nom de ressource de l'exécution de transfert. Les noms des exécutions de transfert se présentent sous la forme suivante : projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. Le nom est ignoré lors de la création d'une exécution de transfert.
schedule_time

Timestamp

Délai minimum après lequel une exécution de transfert peut être lancée.
run_time

Timestamp

Pour les exécutions de transferts par lot, date et heure auxquelles les données doivent être ingérées.
error_status

Status

État de l'exécution de transfert.
start_time

Timestamp

Uniquement en sortie. Heure de début de l'exécution du transfert. Paramètre ignoré par le serveur pour les requêtes d'entrée.
end_time

Timestamp

Uniquement en sortie. Heure de fin de l'exécution du transfert. Paramètre ignoré par le serveur pour les requêtes d'entrée.
update_time

Timestamp

Uniquement en sortie. Heure de la dernière mise à jour de l'état d'exécution du transfert de données.
params

Struct

Uniquement en sortie. Paramètres spécifiques pour le transfert de données.
data_source_id

string

Uniquement en sortie. ID de la source de données.
state

TransferState

État de l'exécution du transfert de données. Ignoré pour les requêtes d'entrée.
user_id

int64

Obsolète. Identifiant unique de l'utilisateur au nom duquel le transfert est effectué.
schedule

string

Uniquement en sortie. Décrit la programmation de cette exécution de transfert si elle a été créée en tant que programmation régulière. Pour les exécutions de transferts par lot qui sont programmées manuellement, ce champ est vide. REMARQUE : Le système peut choisir de retarder la programmation en fonction de la charge actuelle. Par conséquent, schedule_time ne correspond pas toujours à cette règle.
notification_pubsub_topic

string

Uniquement en sortie. Sujet Pub/Sub dans lequel une notification sera envoyée à la fin de cette exécution de transfert.
email_preferences

EmailPreferences

Uniquement en sortie. Les notifications par e-mail seront envoyées en fonction de ces préférences à l'adresse e-mail de l'utilisateur propriétaire de la configuration de transfert dont cette exécution est issue.
destination_dataset_id

string

Uniquement en sortie. ID de l'ensemble de données cible BigQuery.

TransferState

Représente l'état d'exécution du transfert de données.

Enums
TRANSFER_STATE_UNSPECIFIED Espace réservé de l'état.
PENDING Le transfert de données est planifié et attend d'être récupéré par le backend de transfert de données.
RUNNING Le transfert de données est en cours.
SUCCEEDED Le transfert de données est terminé.
FAILED Échec du transfert de données.
CANCELLED Le transfert de données a été annulé.

TransferType

OBSOLÈTE. Représente le type de transfert de données.

Enums
TRANSFER_TYPE_UNSPECIFIED Espace réservé du type de transfert non valide ou inconnu.
BATCH Transfert de données par lot.
STREAMING Transfert de données en streaming. La source de données en streaming n'est actuellement pas compatible avec plusieurs configurations de transfert par projet.

UpdateTransferConfigRequest

Requête permettant de mettre à jour une configuration de transfert. Pour mettre à jour l'ID utilisateur de la configuration de transfert, un code d'autorisation doit être fourni.

Champs
transfer_config

TransferConfig

Obligatoire. Configuration de transfert de données à créer.

L'autorisation IAM suivante est requise pour la ressource transferConfig indiquée :

  • bigquery.transfers.update
authorization_code

string

Code d'autorisation OAuth2 facultatif à utiliser avec cette configuration de transfert. S'il est fourni, la configuration de transfert sera associée à l'utilisateur autorisé. Pour obtenir le code d'autorisation, envoyez une demande à https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=

  • client_id doit être l'ID client OAuth de l'API DTS BigQuery pour la source de données présentée, renvoyée par la méthode ListDataSources.
  • data_source_scopes correspond aux champs d'application renvoyés par la méthode ListDataSources.
  • redirect_uri est un paramètre facultatif. S'il n'est pas spécifié, le code d'autorisation est publié lors de l'ouverture de la fenêtre du flux d'autorisation. Sinon, il sera envoyé à l'URI de redirection. Une valeur spéciale de urn:ietf:wg:oauth:2.0:oob signifie que le code d'autorisation doit être renvoyé dans la barre de titre du navigateur, avec le texte de la page invitant l'utilisateur à copier le code et à le coller dans l'application.
update_mask

FieldMask

Obligatoire. Liste obligatoire des champs à mettre à jour pour cette requête.
version_info

string

Informations facultatives sur la version. Si les utilisateurs souhaitent trouver un jeton d'accès très récent (c'est-à-dire, immédiatement après l'approbation de l'accès), ils doivent définir la revendication version_info dans la requête de jeton. Pour obtenir le paramètre version_info, les utilisateurs doivent utiliser le type de réponse "none+gsession". Cela renvoie un élément version_info dans la réponse d'autorisation qui doit être placé dans une revendication JWT au sein de la requête de jeton.
service_account_name

string

Nom du compte de service facultatif. Si ce champ est défini et que "service_account_name" est défini dans "update_mask", la configuration de transfert sera mise à jour afin d'utiliser ces identifiants de compte de service. Nécessite que les utilisateurs qui appellent cette API aient l'autorisation d'agir en tant que compte de service.