Package google.cloud.bigquery.datatransfer.v1

색인

DataTransferService

BigQuery 사용자는 Google BigQuery 데이터 전송 서비스 API를 사용하여 다른 Google 제품에서 BigQuery로 데이터 전송을 구성할 수 있습니다. 이 서비스에는 최종 사용자에게 노출된 메소드가 포함됩니다. 이는 프런트엔드를 백업합니다.

CheckValidCreds

rpc CheckValidCreds(CheckValidCredsRequest) returns (CheckValidCredsResponse)

지정된 데이터 소스와 요청 사용자에 대한 유효한 사용자 인증 정보가 있는 경우 true를 반환합니다. 일부 데이터 소스는 서비스 계정을 지원하지 않으므로 우리가 최종 사용자를 대신하여 대화해야 합니다. 이 API는 특정 사용자의 OAuth 토큰이 있는지만 확인하며, 사용자가 전송 설정을 만들려면 이 토큰이 필요합니다.

승인 범위

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

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

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

CreateTransferConfig

rpc CreateTransferConfig(CreateTransferConfigRequest) returns (TransferConfig)

새 데이터 전송 구성을 만듭니다.

승인 범위

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

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

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

DeleteTransferConfig

rpc DeleteTransferConfig(DeleteTransferConfigRequest) returns (Empty)

연결된 전송 실행과 로그를 포함하여 데이터 전송 구성을 삭제합니다.

승인 범위

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

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

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

DeleteTransferRun

rpc DeleteTransferRun(DeleteTransferRunRequest) returns (Empty)

지정된 전송 실행을 삭제합니다.

승인 범위

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

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

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

GetDataSource

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

지원되는 데이터 소스를 가져오고 UI 렌더링에 사용할 수 있는 설정을 반환합니다.

승인 범위

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

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

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

GetTransferConfig

rpc GetTransferConfig(GetTransferConfigRequest) returns (TransferConfig)

데이터 전송 구성 정보를 반환합니다.

승인 범위

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

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

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

GetTransferRun

rpc GetTransferRun(GetTransferRunRequest) returns (TransferRun)

특정 전송 실행 정보를 반환합니다.

승인 범위

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

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

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

ListDataSources

rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse)

지원되는 데이터 소스를 나열하고 UI 렌더링에 사용할 수 있는 설정을 반환합니다.

승인 범위

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

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

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

ListTransferConfigs

rpc ListTransferConfigs(ListTransferConfigsRequest) returns (ListTransferConfigsResponse)

프로젝트의 모든 데이터 전송 정보를 반환합니다.

승인 범위

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

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

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

ListTransferLogs

rpc ListTransferLogs(ListTransferLogsRequest) returns (ListTransferLogsResponse)

데이터 전송 실행에 대한 사용자용 로그 메시지를 반환합니다.

승인 범위

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

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

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

ListTransferRuns

rpc ListTransferRuns(ListTransferRunsRequest) returns (ListTransferRunsResponse)

실행 중인 작업과 완료된 작업 정보를 반환합니다.

승인 범위

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

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

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

ScheduleTransferRuns

rpc ScheduleTransferRuns(ScheduleTransferRunsRequest) returns (ScheduleTransferRunsResponse)

시간 범위 [start_time, end_time]의 전송 실행을 만듭니다. 범위 내의 각 날짜별로 또는 데이터 소스에서 지원하는 세부 단위별로 하나의 전송 실행이 생성됩니다. 실행은 시간 범위의 UTC 시간마다 생성됩니다. 지원 중단됨: StartManualTransferRuns를 대신 사용하세요.

승인 범위

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

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

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

StartManualTransferRuns

rpc StartManualTransferRuns(StartManualTransferRunsRequest) returns (StartManualTransferRunsResponse)

현재 전송 시간과 동일한 schedule_time을 사용하여 수동 전송 실행을 시작합니다. 전송 실행은 run_time이 start_time(포함)과 end_time(제외) 사이에 있는 특정 기간 또는 특정 run_time으로 생성될 수 있습니다.

승인 범위

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

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

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

UpdateTransferConfig

rpc UpdateTransferConfig(UpdateTransferConfigRequest) returns (TransferConfig)

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

승인 범위

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

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

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

CheckValidCredsRequest

사용자가 유효한 사용자 인증 정보를 가지고 있는지 확인하기 위한 요청입니다. 이 메소드는 사용자 인터페이스에서 OAuth 팝업 수를 제한하는 데 사용됩니다. 사용자 ID는 API 호출 컨텍스트에서 유추됩니다. 데이터 소스에 Google+ 인증 유형이 있는 경우이 메소드는 false를 반환합니다. 사용자 ID만으로는 사용자 인증 정보가 이미 유효한지 여부를 확인할 수 없기 때문입니다.

필드
name

string

필수. projects/{project_id}/dataSources/{data_source_id} 또는 projects/{project_id}/locations/{location_id}/dataSources/{data_source_id} 형식의 데이터 소스입니다.

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.get

CheckValidCredsResponse

사용자 인증 정보가 존재하고 유효한지를 표시하는 응답입니다.

필드
has_valid_creds

bool

true로 설정된 경우 사용자 인증 정보가 존재하며 유효합니다.

CreateTransferConfigRequest

데이터 전송 구성을 만들기 위한 요청입니다. 이 전송 구성에 새로운 사용자 인증 정보가 필요한 경우 승인 코드를 제공해야 합니다. 승인 코드가 제공되면 전송 구성이 승인 코드에 해당하는 사용자 ID와 연결됩니다. 그렇지 않으면 전송 구성이 발신자와 연결됩니다.

필드
parent

string

필수. 전송 구성을 만들어야 하는 BigQuery 프로젝트 ID입니다. projects/{project_id}/locations/{location_id} 또는 projects/{project_id} 형식이어야 합니다. 지정된 위치와 대상 bigquery 데이터 세트의 위치가 일치하지 않으면 요청이 실패합니다.

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.update
transfer_config

TransferConfig

필수. 만들 데이터 전송 구성입니다.

authorization_code

string

이 전송 구성에서 사용할 선택적 OAuth2 승인 코드입니다. CheckValidCreds로 표시되는 대로 새 사용자 인증 정보가 필요한 경우에는 필수입니다. authorization_code를 받으려면 https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=에 요청을 보내세요.

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

string

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

service_account_name

string

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

DataSource

데이터 소스 메타데이터를 나타냅니다. UI를 렌더링하고 적절한 OAuth 토큰을 요청하는 데는 메타데이터로 충분합니다.

필드
name

string

출력 전용. 데이터 소스 리소스 이름입니다.

data_source_id

string

데이터 소스 ID입니다.

display_name

string

사용자 친화적인 데이터 소스 이름입니다.

description

string

사용자 친화적인 데이터 소스 설명 문자열입니다.

client_id

string

갱신 토큰을 받는 데 사용되는 데이터 소스 클라이언트 ID입니다.

scopes[]

string

갱신 토큰을 받아야 하는 API 인증 범위입니다. 이 범위는 데이터 소스에서 데이터를 준비하여 BigQuery에 수집하는 데 필요한 범위입니다(예: https://www.googleapis.com/auth/bigquery).

transfer_type
(deprecated)

TransferType

지원이 중단되었습니다. 이 필드는 아무 영향도 미치지 않습니다.

supports_multiple_transfers
(deprecated)

bool

지원이 중단되었습니다. 이 필드는 아무 영향도 미치지 않습니다.

update_deadline_seconds

int32

데이터 전송 서비스가 전송을 실패하기 전에 데이터 소스에서 업데이트를 기다리는 시간(초)입니다.

default_schedule

string

기본 데이터 전송 일정입니다. 유효한 일정의 예로는 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, first sunday of quarter 00:00이 있습니다.

supports_custom_schedule

bool

데이터 소스가 사용자 정의 일정을 지원하는지 아니면 기본 일정에 따라 작동하는지를 지정합니다. true로 설정하면 사용자가 기본 일정을 재정의할 수 있습니다.

parameters[]

DataSourceParameter

데이터 소스 매개변수입니다.

help_url

string

이 데이터 소스와 관련한 도움말 문서의 URL입니다.

authorization_type

AuthorizationType

승인 유형을 나타냅니다.

data_refresh_type

DataRefreshType

데이터 소스가 지난 며칠에 대하여 자동 데이터 새로고침을 지원하는지 여부와 새로고침을 지원하는 방법을 지정합니다. 일부 데이터 소스의 경우, 며칠이 지나야만 데이터가 완전해지므로 데이터 자동 새로고침을 사용하는 것이 유용합니다.

default_data_refresh_window_days

int32

기본 데이터 새로고침 기간(일)입니다. data_refresh_type = SLIDING_WINDOW인 경우에만 의미가 있습니다.

manual_runs_disabled

bool

데이터 소스의 백필 및 수동 실행 예약을 사용 중지합니다.

minimum_schedule_interval

Duration

스케줄러가 실행을 예약할 최소 간격입니다.

AuthorizationType

이 데이터 소스에 필요한 승인 유형입니다.

열거형
AUTHORIZATION_TYPE_UNSPECIFIED 유형이 지정되지 않습니다.
AUTHORIZATION_CODE 백엔드에서 갱신 토큰과 교환할 수 있는 OAuth 2 승인 코드를 사용합니다.
GOOGLE_PLUS_AUTHORIZATION_CODE 특정 Google+ 페이지에 대하여 백엔드에서 갱신 토큰과 교환할 수 있는 승인 코드를 반환합니다.
FIRST_PARTY_OAUTH Loas 소유의 클라이언트를 기반으로 하는 자사 OAuth를 사용합니다. 자사 OAuth는 오프라인 액세스 토큰을 얻는 데 갱신 토큰이 필요하지 않습니다. 그 대신, 클라이언트 서명 JWT 어설션을 사용하여 액세스 토큰을 검색합니다.

DataRefreshType

데이터 소스가 데이터 자동 새로고침을 지원하는 방식을 나타냅니다.

열거형
DATA_REFRESH_TYPE_UNSPECIFIED 데이터 소스가 데이터 자동 새로고침을 지원하지 않습니다(기본값).
SLIDING_WINDOW 데이터 소스가 데이터 자동 새로고침을 지원하며 지난 며칠간에 대해 실행이 예약됩니다. 각 전송 구성에 맞춤 값을 설정할 수 없습니다.
CUSTOM_SLIDING_WINDOW 데이터 소스가 데이터 자동 새로고침을 지원하며 지난 며칠간에 대해 실행이 예약됩니다. 각 전송 구성에 커스텀 값을 설정할 수 있습니다.

DataSourceParameter

유효성 검사 규칙이 포함된 데이터 소스 매개변수를 나타내며, 따라서 UI에서 매개변수를 렌더링할 수 있습니다. 이러한 매개변수는 지원되는 데이터 소스에서 제공되며, 렌더링 및 유효성 검사에 필요한 모든 정보를 포함합니다. 따라서 이 API를 사용하는 경우 누구든지 일반 UI를 생성할지 아니면 커스텀 데이터 소스 관련 양식을 생성할지 결정할 수 있습니다.

필드
param_id

string

매개 변수 식별자입니다.

display_name

string

사용자 인터페이스에서 사용되는 매개변수 표시 이름입니다.

description

string

매개변수 설명입니다.

type

Type

매개변수 유형입니다.

required

bool

매개변수가 필수인지 여부입니다.

repeated

bool

지원이 중단되었습니다. 이 필드는 아무 영향도 미치지 않습니다.

validation_regex

string

매개변수 유효성 검사에 사용할 수 있는 정규 표현식입니다.

allowed_values[]

string

매개변수에 사용할 수 있는 모든 값입니다.

min_value

DoubleValue

정수 및 배정밀도 값에 허용되는 최소값을 지정합니다.

max_value

DoubleValue

정수 및 배정밀도 값에 허용되는 최대값을 지정합니다.

fields[]

DataSourceParameter

지원이 중단되었습니다. 이 필드는 아무 영향도 미치지 않습니다.

validation_description

string

사용자 입력이 정규식 패턴 또는 최소값/최대값 제한을 충족하지 않는 경우 이 필드의 요구사항에 대한 설명입니다.

validation_help_url

string

이름 지정 요구사항을 자세히 설명하는 도움말 문서의 URL입니다.

immutable

bool

최초 생성 후에 변경할 수 없음을 나타냅니다.

recurse

bool

지원이 중단되었습니다. 이 필드는 아무 영향도 미치지 않습니다.

deprecated

bool

true인 경우 새로운 전송에서 사용할 수 없으며 사용자에게 표시되지 않아야 합니다.

유형

매개변수 유형입니다.

열거형
TYPE_UNSPECIFIED 유형이 지정되지 않습니다.
STRING 문자열 매개변수
INTEGER 정수 매개변수(64비트). json 문자열로 직렬화됩니다.
DOUBLE 배정밀도 부동 소수점 매개변수
BOOLEAN 부울 매개변수
RECORD 지원이 중단되었습니다. 이 필드는 아무 영향도 미치지 않습니다.
PLUS_PAGE Google+ 페이지의 페이지 ID입니다.

DeleteTransferConfigRequest

데이터 전송 정보를 삭제하기 위한 요청입니다. 관련된 모든 전송 실행 및 로그 메시지도 함께 삭제됩니다.

필드
name

string

필수. 이 필드에는 요청된 리소스의 이름이 포함됩니다(예: projects/{project_id}/transferConfigs/{config_id} 또는 projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}).

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.update

DeleteTransferRunRequest

데이터 전송 실행 정보를 삭제하기 위한 요청입니다.

필드
name

string

필수. 이 필드에는 요청된 리소스의 이름이 포함됩니다(예: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} 또는 projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}).

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.update

EmailPreferences

전송 실행 이벤트에 대한 이메일 알림을 전송하는 환경설정을 나타냅니다.

필드
enable_failure_email

bool

true인 경우 전송 실행 실패 시 이메일 알림이 전송됩니다.

GetDataSourceRequest

데이터 소스 정보를 가져오기 위한 요청입니다.

필드
name

string

필수. 이 필드에는 요청된 리소스의 이름이 포함됩니다(예: projects/{project_id}/dataSources/{data_source_id} 또는 projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}).

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.get

GetTransferConfigRequest

데이터 전송 정보를 얻기 위한 요청입니다.

필드
name

string

필수. 이 필드에는 요청된 리소스의 이름이 포함됩니다(예: projects/{project_id}/transferConfigs/{config_id} 또는 projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}).

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.get

GetTransferRunRequest

데이터 전송 실행 정보를 얻기 위한 요청입니다.

필드
name

string

필수. 이 필드에는 요청된 리소스의 이름이 포함됩니다(예: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} 또는 projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}).

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.get

ListDataSourcesRequest

지원되는 데이터 소스 및 데이터 전송 설정을 나열하기 위한 요청입니다.

필드
parent

string

필수. 데이터 소스를 반환해야 하는 BigQuery 프로젝트 ID입니다. projects/{project_id} 또는`projects/{project_id}/locations/{location_id} 형식이어야 합니다.

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.get
page_token

string

ListDataSourcesRequest 목록 결과의 특정 페이지를 요청하는 데 사용할 수 있는 페이지로 나누기 토큰입니다. 결과가 여러 페이지인 경우 ListDataSourcesResponse는 목록 결과의 다음 페이지를 요청하기 위해 page_token 값으로 사용할 수 있는 next_page 토큰을 출력합니다.

page_size

int32

페이지 크기. 기본 페이지 크기는 1,000개의 결과에 해당하는 최대값입니다.

ListDataSourcesResponse

지원되는 데이터 소스 및 해당 메타데이터 목록을 반환합니다.

필드
data_sources[]

DataSource

지원되는 데이터 소스 및 해당 전송 설정의 목록입니다.

next_page_token

string

출력 전용. 다음 페이지로 나누기 토큰입니다. 여러 페이지로 이루어진 목록 결과인 경우 이 토큰을 ListDataSourcesRequest.page_token으로 사용해 목록 결과의 다음 페이지를 요청할 수 있습니다.

ListTransferConfigsRequest

BigQuery 프로젝트에 구성된 데이터 전송을 나열하기 위한 요청입니다.

필드
parent

string

필수. 데이터 소스를 반환해야 하는 BigQuery 프로젝트 ID입니다(projects/{project_id} 또는 projects/{project_id}/locations/{location_id}).

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.get
data_source_ids[]

string

지정하면 요청된 데이터 소스의 구성만 반환됩니다.

page_token

string

ListTransfersRequest 목록 결과의 특정 페이지를 요청하는 데 사용할 수 있는 페이지로 나누기 토큰입니다. 결과가 여러 페이지인 경우 ListTransfersResponse는 목록 결과의 다음 페이지를 요청하기 위해 page_token 값으로 사용할 수 있는 next_page 토큰을 출력합니다.

page_size

int32

페이지 크기. 기본 페이지 크기는 1,000개의 결과에 해당하는 최대값입니다.

ListTransferConfigsResponse

프로젝트의 파이프라인의 반환된 목록입니다.

필드
transfer_configs[]

TransferConfig

출력 전용. 저장된 파이프라인 전송 구성입니다.

next_page_token

string

출력 전용. 다음 페이지로 나누기 토큰입니다. 여러 페이지로 이루어진 목록 결과인 경우 이 토큰을 ListTransferConfigsRequest.page_token으로 사용해 목록 결과의 다음 페이지를 요청할 수 있습니다.

ListTransferLogsRequest

데이터 전송 실행과 관련하여 사용자에게 표시되는 로그 메시지를 가져오기 위한 요청입니다.

필드
parent

string

필수. projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} 또는 projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id} 형식의 전송 실행 이름

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.get
page_token

string

ListTransferLogsRequest 목록 결과의 특정 페이지를 요청하는 데 사용할 수 있는 페이지로 나누기 토큰입니다. 결과가 여러 페이지인 경우 ListTransferLogsResponse는 목록 결과의 다음 페이지를 요청하기 위해 page_token 값으로 사용할 수 있는 next_page 토큰을 출력합니다.

page_size

int32

페이지 크기. 기본 페이지 크기는 1,000개의 결과에 해당하는 최대값입니다.

message_types[]

MessageSeverity

반환되는 메시지 유형. 입력되지 않으면 INFO, WARNING, ERROR 메시지가 반환됩니다.

ListTransferLogsResponse

반환되는 목록 전송 실행 메시지입니다.

필드
transfer_messages[]

TransferMessage

출력 전용. 저장된 파이프 라인 전송 메시지입니다.

next_page_token

string

출력 전용. 다음 페이지로 나누기 토큰입니다. 여러 페이지로 이루어진 목록 결과인 경우 이 토큰을 GetTransferRunLogRequest.page_token으로 사용해 목록 결과의 다음 페이지를 요청할 수 있습니다.

ListTransferRunsRequest

데이터 전송 실행을 나열하는 요청입니다. UI는 이 메소드를 사용하여 특정 데이터 전송 실행을 표시/필터링할 수 있습니다. 데이터 소스는 이 메소드를 사용하여 모든 예약된 전송 실행을 요청할 수 있습니다.

필드
parent

string

필수. 전송 실행을 검색할 전송 구성의 이름입니다. 전송 구성 리소스 이름의 형식은 projects/{project_id}/transferConfigs/{config_id} 또는 projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}입니다.

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.get
states[]

TransferState

지정하면 요청된 상태의 전송 실행만 반환됩니다.

page_token

string

ListTransferRunsRequest 목록 결과의 특정 페이지를 요청하는 데 사용할 수 있는 페이지로 나누기 토큰입니다. 결과가 여러 페이지인 경우 ListTransferRunsResponse는 목록 결과의 다음 페이지를 요청하기 위해 page_token 값으로 사용할 수 있는 next_page 토큰을 출력합니다.

page_size

int32

페이지 크기. 기본 페이지 크기는 1,000개의 결과에 해당하는 최대값입니다.

run_attempt

RunAttempt

실행 시도를 가져오는 방법을 나타냅니다.

RunAttempt

어느 실행을 가져올지 나타냅니다.

열거형
RUN_ATTEMPT_UNSPECIFIED 모든 실행을 반환해야 합니다.
LATEST 하루 단위로 최신 실행만 반환됩니다.

ListTransferRunsResponse

프로젝트의 파이프라인의 반환된 목록입니다.

필드
transfer_runs[]

TransferRun

출력 전용. 저장된 파이프라인 전송 실행입니다.

next_page_token

string

출력 전용. 다음 페이지로 나누기 토큰입니다. 여러 페이지로 이루어진 목록 결과인 경우 이 토큰을 ListTransferRunsRequest.page_token으로 사용해 목록 결과의 다음 페이지를 요청할 수 있습니다.

ScheduleOptions

데이터 전송 일정을 맞춤설정하는 옵션입니다.

필드
disable_auto_scheduling

bool

true이면 이 구성의 데이터 전송 실행 자동 예약이 사용 중지됩니다. StartManualTransferRuns API를 사용하여 임시로 실행을 시작할 수 있습니다. 자동 예약이 사용 중지되면 TransferConfig.schedule 필드가 무시됩니다.

start_time

Timestamp

전송 실행 예약 시작 시간을 지정합니다. 첫 번째 실행은 일정 문자열에 정의된 반복 패턴에 따라 시작 시간 또는 그 이후에 예약됩니다. 시작 시간은 언제든지 변경할 수 있습니다. 데이터 전송을 직접 트리거할 수 있는 시간은 이 옵션으로 제한되지 않습니다.

end_time

Timestamp

전송 실행 예약 중지 시간을 정의합니다. 종료 시간 또는 그 이후에는 전송 실행을 예약할 수 없습니다. 종료 시간은 언제든지 변경할 수 있습니다. 데이터 전송을 직접 트리거할 수 있는 시간은 이 옵션으로 제한되지 않습니다.

ScheduleTransferRunsRequest

일정 기간 동안 전송 실행을 예약하기 위한 요청입니다.

필드
parent

string

필수. projects/{project_id}/transferConfigs/{config_id} 또는 projects/{project_id}/locations/{location_id}/transferConfigs/{config_id} 형식의 전송 구성 이름입니다.

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.update
start_time

Timestamp

필수. 전송 실행 범위의 시작 시간입니다. 예를 들면 "2017-05-25T00:00:00+00:00"입니다.

end_time

Timestamp

필수. 전송 실행 범위의 종료 시간입니다. 예를 들면 "2017-05-30T00:00:00+00:00"입니다.

ScheduleTransferRunsResponse

일정 기간의 전송 실행 예약에 대한 응답입니다.

필드
runs[]

TransferRun

예약된 전송 실행입니다.

StartManualTransferRunsRequest

수동 전송 실행 시작 요청입니다.

필드
parent

string

projects/{project_id}/transferConfigs/{config_id} 또는 projects/{project_id}/locations/{location_id}/transferConfigs/{config_id} 형식의 전송 구성 이름입니다.

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.update
통합 필드 time. 요청된 시간 지정 - 시간 범위 또는 특정 run_time이 될 수 있습니다. time은 다음 중 하나여야 합니다.
requested_time_range

TimeRange

시작되어야 하는 전송 실행의 시간 범위

requested_run_time

Timestamp

전송 실행을 시작할 특정 run_time. requested_run_time은 미래일 수 없습니다.

TimeRange

시간 범위 사양으로, start_time(포함)과 end_time(제외) 사이의 run_time을 사용하여 전송 실행을 요청합니다.

필드
start_time

Timestamp

전송 실행 범위의 시작 시간입니다. 예를 들면 "2017-05-25T00:00:00+00:00"입니다. start_time은 end_time보다 짧아야 합니다. run_time이 start_time(포함)과 end_time(제외) 사이의 범위에 있는 전송 실행을 만듭니다.

end_time

Timestamp

전송 실행 범위의 종료 시간입니다. 예를 들면 "2017-05-30T00:00:00+00:00"입니다. end_time은 미래일 수 없습니다. run_time이 start_time(포함)과 end_time(제외) 사이의 범위에 있는 전송 실행을 만듭니다.

StartManualTransferRunsResponse

수동 전송 실행 시작에 대한 응답입니다.

필드
runs[]

TransferRun

생성된 전송 실행입니다.

TransferConfig

데이터 전송 구성을 나타냅니다. 전송 구성에는 데이터 전송을 수행하는 데 필요한 모든 메타데이터가 포함됩니다. 예를 들어 destination_dataset_id는 데이터가 저장되어야 하는 위치를 지정합니다. 새 전송 구성을 만들 때 필요한 경우 지정된 destination_dataset_id가 생성되고 적절한 데이터 소스 서비스 계정과 공유됩니다.

필드
name

string

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

display_name

string

데이터 전송의 사용자 지정 표시 이름입니다.

data_source_id

string

데이터 소스 ID입니다. 데이터 전송이 생성된 후에는 변경할 수 없습니다.

params

Struct

데이터 전송별 매개변수입니다.

schedule

string

데이터 전송 일정. 데이터 소스가 맞춤 일정을 지원하지 않는 경우 비어 있어야 합니다. 비어 있으면 데이터 소스의 기본값이 사용됩니다. 지정된 시간은 UTC 형식입니다. 유효한 형식의 예를 들면 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, first sunday of quarter 00:00입니다. 형식에 대한 자세한 설명은 https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format을 참조하세요. 참고: 단위는 최소 8시간이거나 빈도가 더 낮아야 합니다.

schedule_options

ScheduleOptions

데이터 전송 일정을 맞춤설정하는 옵션입니다.

data_refresh_window_days

int32

데이터를 자동으로 새로 고치기 위해 확인할 과거의 날짜 수입니다. 예를 들어 data_refresh_window_days = 10이면 BigQuery는 매일 [오늘-1]의 데이터만 수집하지 않고 [오늘-10, 오늘-1]의 데이터를 다시 수집합니다. 데이터 소스가 이 기능을 지원하는 경우에만 유효합니다. 기본값을 사용하려면 이 값을 0으로 설정합니다.

disabled

bool

이 구성의 사용이 중지되었는지 여부입니다. true로 설정하면 지정된 전송의 실행이 예약되지 않습니다.

update_time

Timestamp

출력 전용. 데이터 전송 수정 시간입니다. 입력 시 서버에서 무시됩니다.

next_run_time

Timestamp

출력 전용. 다음에 데이터 전송이 실행되는 시간입니다.

state

TransferState

출력 전용. 가장 최근에 업데이트된 전송 실행의 상태입니다.

user_id

int64

지원이 중단되었습니다. 전송이 처리되는 사용자의 고유 ID입니다.

dataset_region

string

출력 전용. BigQuery 데이터 세트가 있는 리전입니다.

notification_pubsub_topic

string

이 전송 구성과 연결된 전송 실행이 완료된 후 알림을 전송할 Pub/Sub 주제입니다.

email_preferences

EmailPreferences

이러한 환경설정에 따라 이 전송 구성의 소유자 이메일 주소로 이메일 알림이 전송됩니다.

destination_dataset_id

string

BigQuery 대상 데이터 세트 ID입니다.

TransferMessage

특정 데이터 전송 실행과 관련하여 사용자에게 표시되는 메시지를 나타냅니다.

필드
message_time

Timestamp

메시지가 기록된 시간입니다.

severity

MessageSeverity

메시지 심각도입니다.

message_text

string

메시지 텍스트입니다.

MessageSeverity

데이터 전송 사용자용 메시지 심각도를 나타냅니다.

열거형
MESSAGE_SEVERITY_UNSPECIFIED 심각도가 지정되지 않았습니다.
INFO 정보 메시지
WARNING 경고 메시지
ERROR 오류 메시지

TransferRun

데이터 전송 실행을 나타냅니다.

필드
name

string

전송 실행의 리소스 이름입니다. 전송 실행 이름의 형식은 projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}입니다. 전송 실행 생성 시 이름은 무시됩니다.

schedule_time

Timestamp

전송 실행이 시작되기 전에 경과해야 하는 최소 시간입니다.

run_time

Timestamp

일괄 전송 실행의 경우 수집해야 할 데이터의 날짜 및 시간을 지정합니다.

error_status

Status

전송 실행 상태입니다.

start_time

Timestamp

출력 전용. 전송 실행이 시작된 시간입니다. 입력 요청의 경우 서버에서 무시되는 매개변수입니다.

end_time

Timestamp

출력 전용. 전송 실행이 끝난 시간입니다. 입력 요청의 경우 서버에서 무시되는 매개변수입니다.

update_time

Timestamp

출력 전용. 데이터 전송 실행 상태가 마지막으로 업데이트된 시간입니다.

params

Struct

출력 전용. 데이터 전송용 매개변수입니다.

data_source_id

string

출력 전용. 데이터 소스 ID입니다.

state

TransferState

데이터 전송 실행 상태. 입력 요청 시 무시됩니다.

user_id

int64

지원이 중단되었습니다. 전송이 처리되는 사용자의 고유 ID입니다.

schedule

string

출력 전용. 전송 실행이 정기 일정으로 생성된 경우, 전송 실행의 일정을 설명합니다. 수동으로 예약된 일괄 전송 실행은 이 값이 비어 있습니다. 참고: 현재 로드에 따라 시스템에서 일정 지연을 선택할 수도 있으므로 schedule_time이 항상 이 값과 일치하지는 않습니다.

notification_pubsub_topic

string

출력 전용. 이 전송 실행이 완료된 후 알림을 전송할 Pub/Sub 주제

email_preferences

EmailPreferences

출력 전용. 이러한 환경설정에 따라 이 실행이 시작된 전송 구성의 소유자 이메일 주소로 이메일 알림이 전송됩니다.

destination_dataset_id

string

출력 전용. BigQuery 대상 데이터 세트 ID입니다.

TransferState

데이터 전송 실행 상태를 나타냅니다.

열거형
TRANSFER_STATE_UNSPECIFIED 상태 자리표시자입니다.
PENDING 데이터 전송 일정이 예약되어 있고 데이터 전송 백엔드에 의해 선택되기를 대기 중입니다.
RUNNING 데이터 전송이 진행 중입니다.
SUCCEEDED 데이터 전송이 완료되었습니다.
FAILED 데이터 전송이 실패했습니다.
CANCELLED 데이터 전송이 취소되었습니다.

TransferType

지원 중단됨. 데이터 전송 유형을 나타냅니다.

열거형
TRANSFER_TYPE_UNSPECIFIED 잘못되었거나 알 수 없는 전송 유형 자리표시자입니다.
BATCH 일괄 데이터 전송입니다.
STREAMING 스트리밍 데이터 전송입니다. 스트리밍 데이터 소스는 현재 하나의 프로젝트에 여러 개의 전송 구성을 지원하지 않습니다.

UpdateTransferConfigRequest

전송 구성을 업데이트하기 위한 요청입니다. 전송 구성의 사용자 ID를 업데이트하려면 승인 코드가 제공되어야 합니다.

필드
transfer_config

TransferConfig

필수. 만들 데이터 전송 구성입니다.

승인을 처리하려면 지정된 리소스 transferConfig에 대해 다음과 같은 IAM 권한이 필요합니다.

  • bigquery.transfers.update
authorization_code

string

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

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

FieldMask

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

version_info

string

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

service_account_name

string

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