Methode: transferConfigs.patch

Vollständiger Name: projects.locations.transferConfigs.patch

Aktualisiert eine Datenübertragungskonfiguration. Alle Felder müssen festgelegt werden, auch wenn sie nicht aktualisiert werden.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
transferConfig.name

string

Der Ressourcenname der Übertragungskonfiguration. Namen von Übertragungskonfigurationen haben das Format projects/{projectId}/locations/{region}/transferConfigs/{configId}. Der Name wird automatisch anhand der in CreateTransferConfigRequest angegebenen configId zusammen mit der projectId und der Region generiert. Wenn keine configId angegeben ist, wird dafür normalerweise eine uuid generiert, auch wenn dies weder garantiert noch erforderlich ist.

Abfrageparameter

Parameter
authorizationCode

string

Ein optionaler OAuth2-Autorisierungscode zur Verwendung mit dieser Übertragungskonfiguration. Wenn angegeben, wird die Übertragungskonfiguration dem autorisierenden Nutzer zugeordnet. Senden Sie zum Abrufen des Authorisierungscodes eine Anfrage an https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?clientId=&scope=&redirect_uri=.

  • clientId muss die OAuth-clientId der BigQuery DTS API für die angegebene Datenquelle sein, die von der Methode „dataSources.list“ zurückgegeben wird.
  • "data_source_scopes" sind die Bereiche, die von der Methode "dataSources.list" zurückgegeben werden.
  • "redirect_uri" ist ein optionaler Parameter. Wenn er nicht angegeben ist, wird der Autorisierungscode an den Öffner des Autorisierungsfensters gesendet. Andernfalls wird er an den Weiterleitungs-URI gesendet. Der spezielle Wert „urn:ietf:wg:oauth:2.0:oob“ bedeutet, dass der Autorisierungscode in die Titelleiste des Browsers zurückgegeben werden soll. Dabei wird der Nutzer im Text der Seite aufgefordert, den Code zu kopieren und in die Anwendung einzufügen.
updateMask

string (FieldMask format)

Erforderlich. Erforderliche Liste der Felder, die in dieser Anfrage aktualisiert werden sollen.

Eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".
versionInfo

string

Optionale Versionsinformation. Wenn Nutzer ein sehr aktuelles Zugriffstoken suchen, also unmittelbar nach der Genehmigung des Zugriffs, müssen sie in der Tokenanfrage die versionInfo-Anforderung festlegen. Zum Abrufen von versionInfo müssen Nutzer den Antworttyp „none+gsession“ verwenden, der den Wert von versionInfo in der Autorisierungsantwort zurückgibt. Diese wird in eine JWT-Anforderung in der Tokenanfrage eingefügt.
serviceAccountName

string

Optionaler Dienstkontoname. Wenn dieses Feld festgelegt und „serviceAccountName“ in updateMask angegeben ist, wird die Übertragungskonfiguration so aktualisiert, dass die Anmeldedaten dieses Dienstkontos verwendet werden. Dies setzt voraus, dass Nutzer, die diese API aufrufen, Berechtigungen zum Arbeiten in diesem Dienstkonto haben.

Anfragetext

Der Anfragetext enthält eine Instanz von TransferConfig.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von TransferConfig.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

Testen!