Méthode : transferConfigs.patch

Nom complet : projects.transferConfigs.patch

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.

Requête HTTP

PATCH https://bigquerydatatransfer.googleapis.com/v1/{transferConfig.name=projects/*/transferConfigs/*}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
transferConfig.name

string

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

Paramètres de requête

Paramètres
authorizationCode

string

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

  • clientId 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 dataSources.list.
  • data_source_scopes correspond aux champs d'application renvoyés par la méthode dataSources.list.
  • 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 est 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.
updateMask

string (FieldMask format)

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

Liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo".
versionInfo

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 versionInfo dans la requête de jeton. Pour obtenir le paramètre versionInfo, les utilisateurs doivent utiliser le type de réponse "none+gsession". Le champ versionInfo est ainsi renvoyé dans la réponse d'autorisation qui doit être placée dans une revendication JWT au sein de la requête de jeton.
serviceAccountName

string

Nom du compte de service facultatif. Si ce champ est défini et que "serviceAccountName" est défini dans "updateMask", 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.

Corps de la requête

Le corps de la requête contient une instance de TransferConfig.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de TransferConfig.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

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

Essayer