메서드: transferConfigs.patch

전체 이름: projects.locations.transferConfigs.patch

데이터 전송 구성을 업데이트합니다. 필드를 모두 업데이트하지 않더라도 모든 필드를 설정해야 합니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
transferConfig.name

string

전송 구성의 리소스 이름입니다. 전송 구성 이름의 형식은 projects/{projectId}/locations/{region}/transferConfigs/{configId}입니다. 이름은 CreateTransferConfigRequest에 지정된 configId를 기반으로 projectId 및 리전과 함께 자동으로 생성됩니다. configId를 제공하지 않으면 일반적으로 configId에 해당하는 uuid가 생성되지만 반드시 그렇거나 그래야 하는 것은 아닙니다.

쿼리 매개변수

매개변수
authorizationCode

string

이 전송 구성에서 사용할 OAuth2 승인 코드(선택사항)입니다. 이 매개변수를 제공하면 전송 구성이 승인하는 사용자와 연결됩니다. authorizationCode를 받으려면 https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?clientId=&scope=&redirect_uri=로 요청을 보내세요.

  • clientId는 dataSources.list 메서드가 반환한 특정 데이터 소스에 대한 BigQuery DTS API의 OAuth clientId여야 합니다.
  • data_source_scopes는 dataSources.list 메소드가 반환한 범위입니다.
  • redirect_uri는 선택적 매개변수입니다. 이 매개변수를 지정하지 않으면 승인 코드가 승인 흐름 창의 상위 창에 게시됩니다. 그 외의 경우 승인 코드가 리디렉션 URI로 전송됩니다. urn:ietf:wg:oauth:2.0:oob라는 특수 값은 브라우저의 제목 표시줄에 승인 코드를 반환해야 함을 의미합니다. 페이지 텍스트는 사용자가 코드를 복사하여 애플리케이션에 붙여 넣어야 한다는 메시지를 표시합니다.
updateMask

string (FieldMask format)

필수. 이 요청에서 업데이트할 필드의 필수 목록입니다.

정규화된 필드 이름을 쉼표로 구분한 목록입니다. 예를 들면 "user.displayName,photo"입니다.
versionInfo

string

선택적 버전 정보. 사용자가 액세스 승인 직후에 가장 최근의 액세스 토큰을 찾으려면 토큰 요청에 versionInfo 클레임을 설정해야 합니다. versionInfo를 가져오려면 사용자가 'none+gsession' 응답 유형을 사용해야 합니다. 그러면 승인 응답에 versionInfo가 다시 반환되고, 토큰 요청의 JWT 클레임에 삽입됩니다.
serviceAccountName

string

서비스 계정 이름(선택사항). 이 필드를 설정하고 updateMask에 'serviceAccountName'을 설정하면 이 서비스 계정 사용자 인증 정보를 사용하도록 전송 구성이 업데이트됩니다. 이 API를 호출하는 사용자에게 이 서비스 계정 역할을 수행할 권한이 필요합니다.

요청 본문

요청 본문에 TransferConfig의 인스턴스가 포함됩니다.

응답 본문

성공한 경우 응답 본문에 TransferConfig의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 개요를 참조하세요.

사용해 보기