"description":"Enables or disables data transfer for a project. This\nmethod requires the additional scope of\n'https://www.googleapis.com/auth/cloudplatformprojects'\nto manage the cloud project permissions.",
"description":"Enables or disables data transfer for a project. This\nmethod requires the additional scope of\n'https://www.googleapis.com/auth/cloudplatformprojects'\nto manage the cloud project permissions."
"description":"The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
"description":"Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
"type":"string",
"location":"query"
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Page size. The default page size is the maximum value of 1000 results.",
"type":"integer"
},
"statuses":{
"repeated":true,
"location":"query",
"enum":[
"TRANSFER_STATUS_UNSPECIFIED",
"INACTIVE",
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"description":"When specified, only transfer runs with requested statuses are returned.",
"type":"string"
},
"runAttempt":{
"description":"Indicates how run attempts are to be pulled.",
"type":"string",
"location":"query",
"enum":[
"RUN_ATTEMPT_UNSPECIFIED",
"LATEST"
]
},
"parent":{
"description":"Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
"description":"The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
"description":"Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
"description":"Required list of fields to be updated in this request.",
"type":"string"
},
"name":{
"description":"The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run.",
"description":"Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
"type":"string"
}
}
},
"get":{
"description":"Returns information about a data transfer config.",
"description":"Returns information about all data transfers in the project.",
"httpMethod":"GET",
"response":{
"$ref":"ListTransferConfigsResponse"
},
"parameterOrder":[
"parent"
],
"parameters":{
"pageToken":{
"location":"query",
"description":"Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
"type":"string"
},
"pageSize":{
"format":"int32",
"description":"Page size. The default page size is the maximum value of 1000 results.",
"type":"integer",
"location":"query"
},
"dataSourceIds":{
"type":"string",
"repeated":true,
"location":"query",
"description":"When specified, only configurations of requested data sources are returned."
"description":"Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application."
"description":"The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
"description":"Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
"description":"Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
"description":"When specified, only configurations of requested data sources are returned.",
"type":"string",
"repeated":true,
"location":"query"
},
"parent":{
"location":"path",
"description":"The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
"type":"string",
"required":true,
"pattern":"^projects/[^/]+$"
},
"pageToken":{
"location":"query",
"description":"Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
"type":"string"
},
"pageSize":{
"type":"integer",
"location":"query",
"format":"int32",
"description":"Page size. The default page size is the maximum value of 1000 results."
"description":"Returns information about all data transfers in the project."
},
"create":{
"response":{
"$ref":"TransferConfig"
},
"parameterOrder":[
"parent"
],
"httpMethod":"POST",
"parameters":{
"authorizationCode":{
"description":"Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
"type":"string",
"location":"query"
},
"parent":{
"description":"The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
"description":"Creates a new data transfer configuration.",
"request":{
"$ref":"TransferConfig"
}
},
"scheduleRuns":{
"description":"Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
"description":"The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run.",
"description":"Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application."
},
"updateMask":{
"location":"query",
"format":"google-fieldmask",
"description":"Required list of fields to be updated in this request.",
"description":"The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
"description":"Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
"type":"string",
"required":true
},
"pageToken":{
"description":"Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
"type":"string",
"location":"query"
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Page size. The default page size is the maximum value of 1000 results.",
"type":"integer"
},
"statuses":{
"location":"query",
"enum":[
"TRANSFER_STATUS_UNSPECIFIED",
"INACTIVE",
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"description":"When specified, only transfer runs with requested statuses are returned.",
"description":"The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
"description":"Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
"type":"string",
"required":true
},
"pageToken":{
"description":"Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
"description":"Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
"httpMethod":"GET",
"response":{
"$ref":"ListDataSourcesResponse"
},
"parameterOrder":[
"parent"
],
"parameters":{
"pageToken":{
"location":"query",
"description":"Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
"type":"string"
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"Page size. The default page size is the maximum value of 1000 results.",
"type":"integer"
},
"parent":{
"pattern":"^projects/[^/]+$",
"location":"path",
"description":"The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"description":"The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
"Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project."
],
"enum":[
"TRANSFER_TYPE_UNSPECIFIED",
"BATCH",
"STREAMING"
],
"description":"Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.",
"type":"string"
},
"description":{
"description":"User friendly data source description string.",
"type":"string"
},
"dataSourceId":{
"description":"Data source id.",
"type":"string"
},
"scopes":{
"description":"Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
"description":"Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
"type":"string"
},
"authorizationType":{
"enumDescriptions":[
"Type unspecified.",
"Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
"Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
"description":"Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule.",
"The data source won't support data auto refresh, which is default value.",
"The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.",
"The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
"description":"Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
"description":"Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
"type":"string"
},
"supportsMultipleTransfers":{
"description":"Indicates whether the data source supports multiple transfers\nto different BigQuery targets.",
"description":"A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"description":"Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account.",
"type":"object",
"properties":{
"nextRunTime":{
"format":"google-datetime",
"description":"Next time when data transfer will run. Output only. Applicable\nonly for batch data transfers.\n@OutputOnly",
"type":"string"
},
"disabled":{
"description":"Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
"type":"boolean"
},
"schedule":{
"description":"Data transfer schedule in GROC format.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid GROC include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
"type":"string"
},
"updateTime":{
"format":"google-datetime",
"description":"Data transfer modification time. Ignored by server on input.\n@OutputOnly",
"type":"string"
},
"dataRefreshWindowDays":{
"format":"int32",
"description":"The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
"type":"integer"
},
"dataSourceId":{
"description":"Data source id. Cannot be changed once data transfer is created.",
"type":"string"
},
"status":{
"type":"string",
"enumDescriptions":[
"Status placeholder.",
"Data transfer is inactive.",
"Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
"Data transfer is in progress.",
"Data transfer completed successsfully.",
"Data transfer failed.",
"Data transfer is cancelled."
],
"enum":[
"TRANSFER_STATUS_UNSPECIFIED",
"INACTIVE",
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"description":"Status of the most recently updated transfer run.\n@OutputOnly"
},
"destinationDatasetId":{
"description":"The BigQuery target dataset id.",
"type":"string"
},
"userId":{
"format":"int64",
"description":"GaiaID of the user on whose behalf transfer is done. Applicable only\nto data sources that do not support service accounts. When set to 0,\nthe data source service account credentials are used.\n@OutputOnly",
"type":"string"
},
"name":{
"description":"The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run.",
"type":"string"
},
"params":{
"description":"Data transfer specific parameters.",
"type":"object",
"additionalProperties":{
"description":"Properties of the object.",
"type":"any"
}
},
"datasetRegion":{
"description":"Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
"type":"string"
},
"displayName":{
"description":"User specified display name for the data transfer.",
"description":"Describes the schedule of this transfer run if it was created as part of\na regular schedule. For batch transfer runs that are directly created,\nthis is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.\n@OutputOnly"
},
"updateTime":{
"format":"google-datetime",
"description":"Last time the data transfer run status was updated.\n@OutputOnly",
"type":"string"
},
"runTime":{
"type":"string",
"format":"google-datetime",
"description":"For batch transfer runs, specifies the date and time that\ndata should be ingested."
"description":"The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
"description":"Minimum time after which a transfer run can be started.",
"type":"string"
}
},
"id":"TransferRun"
},
"CheckValidCredsRequest":{
"description":"A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.",
"type":"object",
"properties":{},
"id":"CheckValidCredsRequest"
},
"CheckValidCredsResponse":{
"description":"A response indicating whether the credentials exist and are valid.",
"type":"object",
"properties":{
"hasValidCreds":{
"type":"boolean",
"description":"If set to `true`, the credentials exist and are valid."
}
},
"id":"CheckValidCredsResponse"
},
"ScheduleTransferRunsResponse":{
"description":"A response to schedule transfer runs for a time range.",
"type":"object",
"properties":{
"createdRuns":{
"description":"The transfer runs that were created.",
"items":{
"$ref":"TransferRun"
},
"type":"array"
}
},
"id":"ScheduleTransferRunsResponse"
},
"ListTransferLogsResponse":{
"description":"The returned list transfer run messages.",
"type":"object",
"properties":{
"transferMessages":{
"description":"The stored pipeline transfer messages.\n@OutputOnly",
"description":"The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
"description":"The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_token`\nto request the next page of list results.\n@OutputOnly"
}
},
"id":"ListDataSourcesResponse",
"description":"Returns list of supported data sources and their metadata.",
"type":"object"
},
"DataSourceParameter":{
"id":"DataSourceParameter",
"description":"Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
"type":"object",
"properties":{
"displayName":{
"description":"Parameter display name in the user interface.",
"description":"The stored pipeline transfer runs.\n@OutputOnly",
"items":{
"$ref":"TransferRun"
},
"type":"array"
},
"nextPageToken":{
"description":"The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
