Método: transferConfigs.patch

Nome completo: projects.transferConfigs.patch

Atualiza uma configuração de transferência de dados. Todos os campos precisam ser definidos, mesmo que não estejam atualizados.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
transferConfig.name

string

O nome do recurso da configuração de transferência. Os nomes de configuração de transferência têm o formato projects/{projectId}/locations/{region}/transferConfigs/{configId}. O nome é gerado automaticamente com base no configId especificado em CreateTransferConfigRequest com o projectId e a região. Caso o configId não seja inserido, geralmente um uuid, mesmo que não seja garantido ou necessário, será gerado para o configId.

Parâmetros de consulta

Parâmetros
authorizationCode

string

Código de autorização OAuth2 opcional para usar com essa configuração de transferência. Se for fornecido, a configuração de transferência será associada ao usuário que autoriza. Para receber o authorizationCode, faça uma solicitação para https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?clientId=&scope=&redirect_uri=

  • clientId precisa ser o OAuth clientId da API DTS do BigQuery para a fonte de dados fornecida retornada pelo método dataSources.list.
  • data_source_scopes são os escopos retornados pelo método dataSources.list.
  • redirect_uri é um parâmetro opcional. Se não for especificado, o código de autorização será postado na janela de abertura do fluxo de autorização. Caso contrário, será enviado para o URI de redirecionamento. Um valor especial de urn:ietf:wg:oauth:2.0:oob significa que o código de autorização precisa ser retornado na barra de título do navegador, com o texto da página solicitando que o usuário copie o código e cole-o no aplicativo.
updateMask

string (FieldMask format)

Obrigatório. Lista obrigatória de campos a serem atualizados nesta solicitação.

Lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
versionInfo

string

Informações opcionais de versão. Se os usuários quiserem encontrar um token de acesso muito recente, ou seja, logo após aprovar o acesso, será necessário definir a declaração versionInfo na solicitação do token. Para encontrar o versionInfo, os usuários precisam usar o tipo de resposta "none+gsession", que retorna um versionInfo na resposta de autorização que será colocada em uma declaração JWT na solicitação do token.
serviceAccountName

string

Nome opcional da conta de serviço. Se esse campo estiver definido e "serviceAccountName" estiver definido em updateMask, o config de transferência será atualizado para usar as credenciais da conta de serviço. Para isso, o usuário que chama a API precisa ter permissões para realizações ações com essa conta de serviço.

Corpo da solicitação

O corpo da solicitação contém uma instância de TransferConfig.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de TransferConfig.

Escopos da autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral da autenticação.

Faça um teste