@google-cloud/bigquery-data-transfer
Version:
BigQuery Data Transfer API client for Node.js
1,002 lines • 127 kB
JSON
{
"nested": {
"google": {
"nested": {
"cloud": {
"nested": {
"bigquery": {
"nested": {
"datatransfer": {
"nested": {
"v1": {
"options": {
"csharp_namespace": "Google.Cloud.BigQuery.DataTransfer.V1",
"go_package": "cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb;datatransferpb",
"java_multiple_files": true,
"java_outer_classname": "TransferProto",
"java_package": "com.google.cloud.bigquery.datatransfer.v1",
"php_namespace": "Google\\Cloud\\BigQuery\\DataTransfer\\V1",
"ruby_package": "Google::Cloud::Bigquery::DataTransfer::V1",
"objc_class_prefix": "GCBDT"
},
"nested": {
"DataTransferService": {
"options": {
"(google.api.default_host)": "bigquerydatatransfer.googleapis.com",
"(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform"
},
"methods": {
"GetDataSource": {
"requestType": "GetDataSourceRequest",
"responseType": "DataSource",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/dataSources/*}",
"(google.api.http).additional_bindings.get": "/v1/{name=projects/*/dataSources/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/dataSources/*}",
"additional_bindings": {
"get": "/v1/{name=projects/*/dataSources/*}"
}
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"ListDataSources": {
"requestType": "ListDataSourcesRequest",
"responseType": "ListDataSourcesResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*}/dataSources",
"(google.api.http).additional_bindings.get": "/v1/{parent=projects/*}/dataSources",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*}/dataSources",
"additional_bindings": {
"get": "/v1/{parent=projects/*}/dataSources"
}
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"CreateTransferConfig": {
"requestType": "CreateTransferConfigRequest",
"responseType": "TransferConfig",
"options": {
"(google.api.http).post": "/v1/{parent=projects/*/locations/*}/transferConfigs",
"(google.api.http).body": "transfer_config",
"(google.api.http).additional_bindings.post": "/v1/{parent=projects/*}/transferConfigs",
"(google.api.http).additional_bindings.body": "transfer_config",
"(google.api.method_signature)": "parent,transfer_config"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{parent=projects/*/locations/*}/transferConfigs",
"body": "transfer_config",
"additional_bindings": {
"post": "/v1/{parent=projects/*}/transferConfigs",
"body": "transfer_config"
}
}
},
{
"(google.api.method_signature)": "parent,transfer_config"
}
]
},
"UpdateTransferConfig": {
"requestType": "UpdateTransferConfigRequest",
"responseType": "TransferConfig",
"options": {
"(google.api.http).patch": "/v1/{transfer_config.name=projects/*/locations/*/transferConfigs/*}",
"(google.api.http).body": "transfer_config",
"(google.api.http).additional_bindings.patch": "/v1/{transfer_config.name=projects/*/transferConfigs/*}",
"(google.api.http).additional_bindings.body": "transfer_config",
"(google.api.method_signature)": "transfer_config,update_mask"
},
"parsedOptions": [
{
"(google.api.http)": {
"patch": "/v1/{transfer_config.name=projects/*/locations/*/transferConfigs/*}",
"body": "transfer_config",
"additional_bindings": {
"patch": "/v1/{transfer_config.name=projects/*/transferConfigs/*}",
"body": "transfer_config"
}
}
},
{
"(google.api.method_signature)": "transfer_config,update_mask"
}
]
},
"DeleteTransferConfig": {
"requestType": "DeleteTransferConfigRequest",
"responseType": "google.protobuf.Empty",
"options": {
"(google.api.http).delete": "/v1/{name=projects/*/locations/*/transferConfigs/*}",
"(google.api.http).additional_bindings.delete": "/v1/{name=projects/*/transferConfigs/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"delete": "/v1/{name=projects/*/locations/*/transferConfigs/*}",
"additional_bindings": {
"delete": "/v1/{name=projects/*/transferConfigs/*}"
}
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"GetTransferConfig": {
"requestType": "GetTransferConfigRequest",
"responseType": "TransferConfig",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/transferConfigs/*}",
"(google.api.http).additional_bindings.get": "/v1/{name=projects/*/transferConfigs/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/transferConfigs/*}",
"additional_bindings": {
"get": "/v1/{name=projects/*/transferConfigs/*}"
}
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"ListTransferConfigs": {
"requestType": "ListTransferConfigsRequest",
"responseType": "ListTransferConfigsResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*}/transferConfigs",
"(google.api.http).additional_bindings.get": "/v1/{parent=projects/*}/transferConfigs",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*}/transferConfigs",
"additional_bindings": {
"get": "/v1/{parent=projects/*}/transferConfigs"
}
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"ScheduleTransferRuns": {
"requestType": "ScheduleTransferRunsRequest",
"responseType": "ScheduleTransferRunsResponse",
"options": {
"deprecated": true,
"(google.api.http).post": "/v1/{parent=projects/*/locations/*/transferConfigs/*}:scheduleRuns",
"(google.api.http).body": "*",
"(google.api.http).additional_bindings.post": "/v1/{parent=projects/*/transferConfigs/*}:scheduleRuns",
"(google.api.http).additional_bindings.body": "*",
"(google.api.method_signature)": "parent,start_time,end_time"
},
"parsedOptions": [
{
"deprecated": true
},
{
"(google.api.http)": {
"post": "/v1/{parent=projects/*/locations/*/transferConfigs/*}:scheduleRuns",
"body": "*",
"additional_bindings": {
"post": "/v1/{parent=projects/*/transferConfigs/*}:scheduleRuns",
"body": "*"
}
}
},
{
"(google.api.method_signature)": "parent,start_time,end_time"
}
]
},
"StartManualTransferRuns": {
"requestType": "StartManualTransferRunsRequest",
"responseType": "StartManualTransferRunsResponse",
"options": {
"(google.api.http).post": "/v1/{parent=projects/*/locations/*/transferConfigs/*}:startManualRuns",
"(google.api.http).body": "*",
"(google.api.http).additional_bindings.post": "/v1/{parent=projects/*/transferConfigs/*}:startManualRuns",
"(google.api.http).additional_bindings.body": "*"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{parent=projects/*/locations/*/transferConfigs/*}:startManualRuns",
"body": "*",
"additional_bindings": {
"post": "/v1/{parent=projects/*/transferConfigs/*}:startManualRuns",
"body": "*"
}
}
}
]
},
"GetTransferRun": {
"requestType": "GetTransferRunRequest",
"responseType": "TransferRun",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/transferConfigs/*/runs/*}",
"(google.api.http).additional_bindings.get": "/v1/{name=projects/*/transferConfigs/*/runs/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/transferConfigs/*/runs/*}",
"additional_bindings": {
"get": "/v1/{name=projects/*/transferConfigs/*/runs/*}"
}
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"DeleteTransferRun": {
"requestType": "DeleteTransferRunRequest",
"responseType": "google.protobuf.Empty",
"options": {
"(google.api.http).delete": "/v1/{name=projects/*/locations/*/transferConfigs/*/runs/*}",
"(google.api.http).additional_bindings.delete": "/v1/{name=projects/*/transferConfigs/*/runs/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"delete": "/v1/{name=projects/*/locations/*/transferConfigs/*/runs/*}",
"additional_bindings": {
"delete": "/v1/{name=projects/*/transferConfigs/*/runs/*}"
}
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"ListTransferRuns": {
"requestType": "ListTransferRunsRequest",
"responseType": "ListTransferRunsResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*/transferConfigs/*}/runs",
"(google.api.http).additional_bindings.get": "/v1/{parent=projects/*/transferConfigs/*}/runs",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*/transferConfigs/*}/runs",
"additional_bindings": {
"get": "/v1/{parent=projects/*/transferConfigs/*}/runs"
}
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"ListTransferLogs": {
"requestType": "ListTransferLogsRequest",
"responseType": "ListTransferLogsResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*/transferConfigs/*/runs/*}/transferLogs",
"(google.api.http).additional_bindings.get": "/v1/{parent=projects/*/transferConfigs/*/runs/*}/transferLogs",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*/transferConfigs/*/runs/*}/transferLogs",
"additional_bindings": {
"get": "/v1/{parent=projects/*/transferConfigs/*/runs/*}/transferLogs"
}
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"CheckValidCreds": {
"requestType": "CheckValidCredsRequest",
"responseType": "CheckValidCredsResponse",
"options": {
"(google.api.http).post": "/v1/{name=projects/*/locations/*/dataSources/*}:checkValidCreds",
"(google.api.http).body": "*",
"(google.api.http).additional_bindings.post": "/v1/{name=projects/*/dataSources/*}:checkValidCreds",
"(google.api.http).additional_bindings.body": "*",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{name=projects/*/locations/*/dataSources/*}:checkValidCreds",
"body": "*",
"additional_bindings": {
"post": "/v1/{name=projects/*/dataSources/*}:checkValidCreds",
"body": "*"
}
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"EnrollDataSources": {
"requestType": "EnrollDataSourcesRequest",
"responseType": "google.protobuf.Empty",
"options": {
"(google.api.http).post": "/v1/{name=projects/*/locations/*}:enrollDataSources",
"(google.api.http).body": "*",
"(google.api.http).additional_bindings.post": "/v1/{name=projects/*}:enrollDataSources",
"(google.api.http).additional_bindings.body": "*"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{name=projects/*/locations/*}:enrollDataSources",
"body": "*",
"additional_bindings": {
"post": "/v1/{name=projects/*}:enrollDataSources",
"body": "*"
}
}
}
]
},
"UnenrollDataSources": {
"requestType": "UnenrollDataSourcesRequest",
"responseType": "google.protobuf.Empty",
"options": {
"(google.api.http).post": "/v1/{name=projects/*/locations/*}:unenrollDataSources",
"(google.api.http).body": "*"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{name=projects/*/locations/*}:unenrollDataSources",
"body": "*"
}
}
]
}
}
},
"DataSourceParameter": {
"fields": {
"paramId": {
"type": "string",
"id": 1
},
"displayName": {
"type": "string",
"id": 2
},
"description": {
"type": "string",
"id": 3
},
"type": {
"type": "Type",
"id": 4
},
"required": {
"type": "bool",
"id": 5
},
"repeated": {
"type": "bool",
"id": 6
},
"validationRegex": {
"type": "string",
"id": 7
},
"allowedValues": {
"rule": "repeated",
"type": "string",
"id": 8
},
"minValue": {
"type": "google.protobuf.DoubleValue",
"id": 9
},
"maxValue": {
"type": "google.protobuf.DoubleValue",
"id": 10
},
"fields": {
"rule": "repeated",
"type": "DataSourceParameter",
"id": 11
},
"validationDescription": {
"type": "string",
"id": 12
},
"validationHelpUrl": {
"type": "string",
"id": 13
},
"immutable": {
"type": "bool",
"id": 14
},
"recurse": {
"type": "bool",
"id": 15
},
"deprecated": {
"type": "bool",
"id": 20
}
},
"nested": {
"Type": {
"values": {
"TYPE_UNSPECIFIED": 0,
"STRING": 1,
"INTEGER": 2,
"DOUBLE": 3,
"BOOLEAN": 4,
"RECORD": 5,
"PLUS_PAGE": 6,
"LIST": 7
}
}
}
},
"DataSource": {
"options": {
"(google.api.resource).type": "bigquerydatatransfer.googleapis.com/DataSource",
"(google.api.resource).pattern": "projects/{project}/locations/{location}/dataSources/{data_source}"
},
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"dataSourceId": {
"type": "string",
"id": 2
},
"displayName": {
"type": "string",
"id": 3
},
"description": {
"type": "string",
"id": 4
},
"clientId": {
"type": "string",
"id": 5
},
"scopes": {
"rule": "repeated",
"type": "string",
"id": 6
},
"transferType": {
"type": "TransferType",
"id": 7,
"options": {
"deprecated": true
}
},
"supportsMultipleTransfers": {
"type": "bool",
"id": 8,
"options": {
"deprecated": true
}
},
"updateDeadlineSeconds": {
"type": "int32",
"id": 9
},
"defaultSchedule": {
"type": "string",
"id": 10
},
"supportsCustomSchedule": {
"type": "bool",
"id": 11
},
"parameters": {
"rule": "repeated",
"type": "DataSourceParameter",
"id": 12
},
"helpUrl": {
"type": "string",
"id": 13
},
"authorizationType": {
"type": "AuthorizationType",
"id": 14
},
"dataRefreshType": {
"type": "DataRefreshType",
"id": 15
},
"defaultDataRefreshWindowDays": {
"type": "int32",
"id": 16
},
"manualRunsDisabled": {
"type": "bool",
"id": 17
},
"minimumScheduleInterval": {
"type": "google.protobuf.Duration",
"id": 18
}
},
"nested": {
"AuthorizationType": {
"values": {
"AUTHORIZATION_TYPE_UNSPECIFIED": 0,
"AUTHORIZATION_CODE": 1,
"GOOGLE_PLUS_AUTHORIZATION_CODE": 2,
"FIRST_PARTY_OAUTH": 3
}
},
"DataRefreshType": {
"values": {
"DATA_REFRESH_TYPE_UNSPECIFIED": 0,
"SLIDING_WINDOW": 1,
"CUSTOM_SLIDING_WINDOW": 2
}
}
}
},
"GetDataSourceRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigquerydatatransfer.googleapis.com/DataSource"
}
}
}
},
"ListDataSourcesRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "bigquerydatatransfer.googleapis.com/DataSource"
}
},
"pageToken": {
"type": "string",
"id": 3
},
"pageSize": {
"type": "int32",
"id": 4
}
}
},
"ListDataSourcesResponse": {
"fields": {
"dataSources": {
"rule": "repeated",
"type": "DataSource",
"id": 1
},
"nextPageToken": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
}
}
},
"CreateTransferConfigRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "bigquerydatatransfer.googleapis.com/TransferConfig"
}
},
"transferConfig": {
"type": "TransferConfig",
"id": 2,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"authorizationCode": {
"type": "string",
"id": 3,
"options": {
"deprecated": true
}
},
"versionInfo": {
"type": "string",
"id": 5
},
"serviceAccountName": {
"type": "string",
"id": 6
}
}
},
"UpdateTransferConfigRequest": {
"fields": {
"transferConfig": {
"type": "TransferConfig",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"authorizationCode": {
"type": "string",
"id": 3,
"options": {
"deprecated": true
}
},
"updateMask": {
"type": "google.protobuf.FieldMask",
"id": 4,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"versionInfo": {
"type": "string",
"id": 5
},
"serviceAccountName": {
"type": "string",
"id": 6
}
}
},
"GetTransferConfigRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigquerydatatransfer.googleapis.com/TransferConfig"
}
}
}
},
"DeleteTransferConfigRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigquerydatatransfer.googleapis.com/TransferConfig"
}
}
}
},
"GetTransferRunRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigquerydatatransfer.googleapis.com/Run"
}
}
}
},
"DeleteTransferRunRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigquerydatatransfer.googleapis.com/Run"
}
}
}
},
"ListTransferConfigsRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "bigquerydatatransfer.googleapis.com/TransferConfig"
}
},
"dataSourceIds": {
"rule": "repeated",
"type": "string",
"id": 2
},
"pageToken": {
"type": "string",
"id": 3
},
"pageSize": {
"type": "int32",
"id": 4
}
}
},
"ListTransferConfigsResponse": {
"fields": {
"transferConfigs": {
"rule": "repeated",
"type": "TransferConfig",
"id": 1,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"nextPageToken": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
}
}
},
"ListTransferRunsRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "bigquerydatatransfer.googleapis.com/Run"
}
},
"states": {
"rule": "repeated",
"type": "TransferState",
"id": 2
},
"pageToken": {
"type": "string",
"id": 3
},
"pageSize": {
"type": "int32",
"id": 4
},
"runAttempt": {
"type": "RunAttempt",
"id": 5
}
},
"nested": {
"RunAttempt": {
"values": {
"RUN_ATTEMPT_UNSPECIFIED": 0,
"LATEST": 1
}
}
}
},
"ListTransferRunsResponse": {
"fields": {
"transferRuns": {
"rule": "repeated",
"type": "TransferRun",
"id": 1,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"nextPageToken": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
}
}
},
"ListTransferLogsRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigquerydatatransfer.googleapis.com/Run"
}
},
"pageToken": {
"type": "string",
"id": 4
},
"pageSize": {
"type": "int32",
"id": 5
},
"messageTypes": {
"rule": "repeated",
"type": "TransferMessage.MessageSeverity",
"id": 6
}
}
},
"ListTransferLogsResponse": {
"fields": {
"transferMessages": {
"rule": "repeated",
"type": "TransferMessage",
"id": 1,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"nextPageToken": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
}
}
},
"CheckValidCredsRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigquerydatatransfer.googleapis.com/DataSource"
}
}
}
},
"CheckValidCredsResponse": {
"fields": {
"hasValidCreds": {
"type": "bool",
"id": 1
}
}
},
"ScheduleTransferRunsRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigquerydatatransfer.googleapis.com/TransferConfig"
}
},
"startTime": {
"type": "google.protobuf.Timestamp",
"id": 2,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"endTime": {
"type": "google.protobuf.Timestamp",
"id": 3,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
}
}
},
"ScheduleTransferRunsResponse": {
"fields": {
"runs": {
"rule": "repeated",
"type": "TransferRun",
"id": 1
}
}
},
"StartManualTransferRunsRequest": {
"oneofs": {
"time": {
"oneof": [
"requestedTimeRange",
"requestedRunTime"
]
}
},
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigquerydatatransfer.googleapis.com/TransferConfig"
}
},
"requestedTimeRange": {
"type": "TimeRange",
"id": 3
},
"requestedRunTime": {
"type": "google.protobuf.Timestamp",
"id": 4
}
},
"nested": {
"TimeRange": {
"fields": {
"startTime": {
"type": "google.protobuf.Timestamp",
"id": 1
},
"endTime": {
"type": "google.protobuf.Timestamp",
"id": 2
}
}
}
}
},
"StartManualTransferRunsResponse": {
"fields": {
"runs": {
"rule": "repeated",
"type": "TransferRun",
"id": 1
}
}
},
"Enroll