{ "protocol": "rest", "kind": "discovery#restDescription", "canonicalName": "BigQuery Data Transfer", "title": "BigQuery Data Transfer API", "revision": "20260831", "mtlsRootUrl": "https://bigquerydatatransfer.mtls.googleapis.com/", "version": "v1", "discoveryVersion": "v1", "name": "bigquerydatatransfer", "endpoints": [ { "location": "asia-south1", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.asia-south1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.asia-south2.rep.googleapis.com/", "location": "asia-south2" }, { "endpointUrl": "https://bigquerydatatransfer.europe-west1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west1" }, { "location": "europe-west2", "endpointUrl": "https://bigquerydatatransfer.europe-west2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "europe-west3", "endpointUrl": "https://bigquerydatatransfer.europe-west3.rep.googleapis.com/" }, { "location": "europe-west4", "endpointUrl": "https://bigquerydatatransfer.europe-west4.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west6.rep.googleapis.com/", "location": "europe-west6" }, { "description": "Regional Endpoint", "location": "europe-west8", "endpointUrl": "https://bigquerydatatransfer.europe-west8.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.europe-west9.rep.googleapis.com/", "location": "europe-west9", "description": "Regional Endpoint" }, { "endpointUrl": "https://bigquerydatatransfer.me-central2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "me-central2" }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1" }, { "location": "northamerica-northeast2", "endpointUrl": "https://bigquerydatatransfer.northamerica-northeast2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-central1", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-central1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-central2.rep.googleapis.com/", "location": "us-central2" }, { "location": "us-east1", "endpointUrl": "https://bigquerydatatransfer.us-east1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://bigquerydatatransfer.us-east4.rep.googleapis.com/", "location": "us-east4", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "us-east5", "endpointUrl": "https://bigquerydatatransfer.us-east5.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-east7.rep.googleapis.com/", "location": "us-east7" }, { "endpointUrl": "https://bigquerydatatransfer.us-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-south1" }, { "endpointUrl": "https://bigquerydatatransfer.us-west1.rep.googleapis.com/", "location": "us-west1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "us-west2", "endpointUrl": "https://bigquerydatatransfer.us-west2.rep.googleapis.com/" }, { "location": "us-west3", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-west3.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.us-west4.rep.googleapis.com/", "location": "us-west4", "description": "Regional Endpoint" }, { "location": "us-west8", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-west8.rep.googleapis.com/" } ], "fullyEncodeReservedExpansion": true, "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/bigquery": { "description": "View and manage your data in Google BigQuery and see the email address for your Google Account" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud services and see the email address of your Google Account" } } } }, "basePath": "", "batchPath": "batch", "resources": { "projects": { "methods": { "enrollDataSources": { "id": "bigquerydatatransfer.projects.enrollDataSources", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).", "flatPath": "v1/projects/{projectsId}:enrollDataSources", "response": { "$ref": "Empty" }, "request": { "$ref": "EnrollDataSourcesRequest" }, "path": "v1/{+name}:enrollDataSources", "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the project resource in the form: `projects/{project_id}`", "type": "string", "pattern": "^projects/[^/]+$" } }, "parameterOrder": [ "name" ] } }, "resources": { "transferConfigs": { "methods": { "scheduleRuns": { "path": "v1/{+parent}:scheduleRuns", "httpMethod": "POST", "deprecated": true, "parameters": { "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`" } }, "description": "Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns", "request": { "$ref": "ScheduleTransferRunsRequest" }, "response": { "$ref": "ScheduleTransferRunsResponse" }, "parameterOrder": [ "parent" ] }, "patch": { "response": { "$ref": "TransferConfig" }, "description": "Updates a data transfer configuration. All fields must be set, even if they are not updated.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.transferConfigs.patch", "request": { "$ref": "TransferConfig" }, "path": "v1/{+name}", "httpMethod": "PATCH", "parameters": { "updateMask": { "description": "Required. Required list of fields to be updated in this request.", "format": "google-fieldmask", "type": "string", "location": "query" }, "serviceAccountName": { "description": "Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).", "location": "query", "type": "string" }, "authorizationCode": { "location": "query", "deprecated": true, "type": "string", "description": "Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config." }, "versionInfo": { "type": "string", "location": "query", "description": "Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config." }, "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "description": "Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config." } } }, "list": { "parameters": { "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Page size. The default page size is the maximum value of 1000 results." }, "dataSourceIds": { "type": "string", "location": "query", "description": "When specified, only configurations of requested data sources are returned.", "repeated": true }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+$", "type": "string", "description": "Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must be `US` and `parent` should be in the following form: * `projects/{project_id} If you are using the regionalized method, `parent` should be in the following form: * `projects/{project_id}/locations/{location_id}`" }, "pageToken": { "description": "Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query", "type": "string" } }, "httpMethod": "GET", "id": "bigquerydatatransfer.projects.transferConfigs.list", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "ListTransferConfigsResponse" }, "flatPath": "v1/projects/{projectsId}/transferConfigs", "path": "v1/{+parent}/transferConfigs", "parameterOrder": [ "parent" ], "description": "Returns information about all transfer configs owned by a project in the specified location." }, "create": { "flatPath": "v1/projects/{projectsId}/transferConfigs", "path": "v1/{+parent}/transferConfigs", "response": { "$ref": "TransferConfig" }, "request": { "$ref": "TransferConfig" }, "description": "Creates a new data transfer configuration.", "id": "bigquerydatatransfer.projects.transferConfigs.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "versionInfo": { "location": "query", "description": "Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", "type": "string" }, "authorizationCode": { "type": "string", "deprecated": true, "location": "query", "description": "Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config." }, "parent": { "location": "path", "required": true, "description": "Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.", "type": "string", "pattern": "^projects/[^/]+$" }, "serviceAccountName": { "description": "Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST" }, "startManualRuns": { "description": "Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each.", "request": { "$ref": "StartManualTransferRunsRequest" }, "httpMethod": "POST", "response": { "$ref": "StartManualTransferRunsResponse" }, "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns", "path": "v1/{+parent}:startManualRuns", "id": "bigquerydatatransfer.projects.transferConfigs.startManualRuns" }, "get": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1/{+name}", "id": "bigquerydatatransfer.projects.transferConfigs.get", "parameterOrder": [ "name" ], "description": "Returns information about a data transfer config.", "response": { "$ref": "TransferConfig" }, "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "type": "string", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" } }, "httpMethod": "GET" }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "httpMethod": "DELETE", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The name of the resource to delete. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" } }, "description": "Deletes a data transfer configuration, including any associated transfer runs and logs.", "id": "bigquerydatatransfer.projects.transferConfigs.delete" } }, "resources": { "transferResources": { "methods": { "get": { "id": "bigquerydatatransfer.projects.transferConfigs.transferResources.get", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "description": "Returns a transfer resource.", "path": "v1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the transfer resource in the form of: * `projects/{project}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` * `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}`", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/transferConfigs/[^/]+/transferResources/[^/]+$" } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/transferResources/{transferResourcesId}", "response": { "$ref": "TransferResource" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "description": "Returns information about transfer resources.", "id": "bigquerydatatransfer.projects.transferConfigs.transferResources.list", "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "type": "string", "description": "Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following forms: * `projects/{project}/transferConfigs/{transfer_config}` * `projects/{project}/locations/{location_id}/transferConfigs/{transfer_config}`", "location": "path", "required": true }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTransferResources` must match the call that provided the page token.", "type": "string" }, "filter": { "type": "string", "description": "Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name=\"*123\" AND (type=\"TABLE\" OR latest_status_detail.state=\"SUCCEEDED\")` * `update_time \u003e= \"2012-04-21T11:30:00-04:00\"` * `hierarchy_detail.partition_detail.table = \"table1\"`", "location": "query" } }, "path": "v1/{+parent}/transferResources", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/transferResources", "response": { "$ref": "ListTransferResourcesResponse" }, "parameterOrder": [ "parent" ] } } }, "runs": { "resources": { "transferLogs": { "methods": { "list": { "path": "v1/{+parent}/transferLogs", "httpMethod": "GET", "parameters": { "messageTypes": { "type": "string", "enumDescriptions": [ "No severity specified.", "Informational message.", "Warning message.", "Error message." ], "location": "query", "repeated": true, "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "description": "Message types to return. If not populated - INFO, WARNING and ERROR messages are returned." }, "pageSize": { "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "location": "path", "required": true, "description": "Required. Transfer run name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "type": "string", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results." } }, "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list", "description": "Returns log messages for the transfer run.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "ListTransferLogsResponse" }, "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs" } } } }, "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "required": true, "type": "string" } }, "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "response": { "$ref": "Empty" }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete", "description": "Deletes the specified transfer run." }, "get": { "description": "Returns information about the particular transfer run.", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "required": true, "type": "string" } }, "id": "bigquerydatatransfer.projects.transferConfigs.runs.get", "parameterOrder": [ "name" ], "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "response": { "$ref": "TransferRun" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1/{+parent}/runs", "id": "bigquerydatatransfer.projects.transferConfigs.runs.list", "description": "Returns information about running and completed transfer runs.", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs", "response": { "$ref": "ListTransferRunsResponse" }, "parameters": { "states": { "type": "string", "description": "When specified, only transfer runs with requested states are returned.", "enum": [ "TRANSFER_STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "repeated": true, "enumDescriptions": [ "State placeholder (0).", "Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).", "Data transfer is in progress (3).", "Data transfer completed successfully (4).", "Data transfer failed (5).", "Data transfer is cancelled (6)." ], "location": "query" }, "parent": { "description": "Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "format": "int32", "location": "query", "description": "Page size. The default page size is the maximum value of 1000 results.", "type": "integer" }, "runAttempt": { "enum": [ "RUN_ATTEMPT_UNSPECIFIED", "LATEST" ], "enumDescriptions": [ "All runs should be returned.", "Only latest run per day should be returned." ], "description": "Indicates how run attempts are to be pulled.", "type": "string", "location": "query" }, "pageToken": { "description": "Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "type": "string", "location": "query" } }, "httpMethod": "GET" } } } } }, "dataSources": { "methods": { "checkValidCreds": { "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/dataSources/[^/]+$", "description": "Required. The name of the data source. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/dataSources/{data_source_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`" } }, "httpMethod": "POST", "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "description": "Returns true if valid credentials exist for the given data source and requesting user.", "request": { "$ref": "CheckValidCredsRequest" }, "response": { "$ref": "CheckValidCredsResponse" }, "path": "v1/{+name}:checkValidCreds", "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds", "parameterOrder": [ "name" ] }, "list": { "flatPath": "v1/projects/{projectsId}/dataSources", "response": { "$ref": "ListDataSourcesResponse" }, "parameterOrder": [ "parent" ], "id": "bigquerydatatransfer.projects.dataSources.list", "path": "v1/{+parent}/dataSources", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "description": "Lists supported data sources and returns their settings.", "parameters": { "pageSize": { "location": "query", "description": "Page size. The default page size is the maximum value of 1000 results.", "format": "int32", "type": "integer" }, "parent": { "location": "path", "required": true, "description": "Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`", "type": "string", "pattern": "^projects/[^/]+$" }, "pageToken": { "type": "string", "description": "Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query" } }, "httpMethod": "GET" }, "get": { "response": { "$ref": "DataSource" }, "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}", "path": "v1/{+name}", "parameterOrder": [ "name" ], "description": "Retrieves a supported data source and returns its settings.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/dataSources/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/dataSources/{data_source_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "bigquerydatatransfer.projects.dataSources.get" } } }, "locations": { "resources": { "dataSources": { "methods": { "list": { "path": "v1/{+parent}/dataSources", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources", "response": { "$ref": "ListDataSourcesResponse" }, "description": "Lists supported data sources and returns their settings.", "id": "bigquerydatatransfer.projects.locations.dataSources.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "GET", "parameters": { "pageSize": { "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`" }, "pageToken": { "description": "Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query", "type": "string" } } }, "checkValidCreds": { "path": "v1/{+name}:checkValidCreds", "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds", "request": { "$ref": "CheckValidCredsRequest" }, "response": { "$ref": "CheckValidCredsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds", "parameterOrder": [ "name" ], "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the data source. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/dataSources/{data_source_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "description": "Returns true if valid credentials exist for the given data source and requesting user." }, "get": { "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/dataSources/{data_source_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", "location": "path", "required": true } }, "response": { "$ref": "DataSource" }, "httpMethod": "GET", "description": "Retrieves a supported data source and returns its settings.", "id": "bigquerydatatransfer.projects.locations.dataSources.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] } } }, "transferConfigs": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "description": "Returns information about all transfer configs owned by a project in the specified location.", "response": { "$ref": "ListTransferConfigsResponse" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs", "httpMethod": "GET", "id": "bigquerydatatransfer.projects.locations.transferConfigs.list", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must be `US` and `parent` should be in the following form: * `projects/{project_id} If you are using the regionalized method, `parent` should be in the following form: * `projects/{project_id}/locations/{location_id}`", "type": "string", "location": "path", "required": true }, "pageToken": { "type": "string", "location": "query", "description": "Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results." }, "dataSourceIds": { "location": "query", "type": "string", "description": "When specified, only configurations of requested data sources are returned.", "repeated": true }, "pageSize": { "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "type": "integer", "format": "int32" } }, "path": "v1/{+parent}/transferConfigs" }, "get": { "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "TransferConfig" }, "description": "Returns information about a data transfer config.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.get" }, "startManualRuns": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}:startManualRuns", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$" } }, "httpMethod": "POST", "response": { "$ref": "StartManualTransferRunsResponse" }, "request": { "$ref": "StartManualTransferRunsRequest" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns", "description": "Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each." }, "scheduleRuns": { "description": "Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.", "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns", "request": { "$ref": "ScheduleTransferRunsRequest" }, "path": "v1/{+parent}:scheduleRuns", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "type": "string", "location": "path", "required": true } }, "response": { "$ref": "ScheduleTransferRunsResponse" }, "httpMethod": "POST", "deprecated": true, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns" }, "delete": { "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a data transfer configuration, including any associated transfer runs and logs.", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", "path": "v1/{+name}", "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "description": "Required. The name of the resource to delete. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`" } }, "httpMethod": "DELETE" }, "create": { "httpMethod": "POST", "parameters": { "authorizationCode": { "description": "Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", "deprecated": true, "location": "query", "type": "string" }, "parent": { "location": "path", "required": true, "type": "string", "description": "Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "versionInfo": { "location": "query", "type": "string", "description": "Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config." }, "serviceAccountName": { "type": "string", "description": "Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/transferConfigs", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs", "request": { "$ref": "TransferConfig" }, "description": "Creates a new data transfer configuration.", "response": { "$ref": "TransferConfig" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.create", "parameterOrder": [ "parent" ] }, "patch": { "parameterOrder": [ "name" ], "httpMethod": "PATCH", "parameters": { "versionInfo": { "description": "Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", "location": "query", "type": "string" }, "authorizationCode": { "description": "Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", "type": "string", "location": "query", "deprecated": true }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Required. Required list of fields to be updated in this request." }, "serviceAccountName": { "location": "query", "description": "Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).", "type": "string" }, "name": { "description": "Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$" } }, "request": { "$ref": "TransferConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch", "response": { "$ref": "TransferConfig" }, "description": "Updates a data transfer configuration. All fields must be set, even if they are not updated.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}" } }, "resources": { "transferResources": { "methods": { "get": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the transfer resource in the form of: * `projects/{project}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` * `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/transferResources/[^/]+$", "type": "string" } }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.transferResources.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/transferResources/{transferResourcesId}", "description": "Returns a transfer resource.", "response": { "$ref": "TransferResource" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTransferResources` must match the call that provided the page token.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following forms: * `projects/{project}/transferConfigs/{transfer_config}` * `projects/{project}/locations/{location_id}/transferConfigs/{transfer_config}`" }, "filter": { "location": "query", "description": "Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name=\"*123\" AND (type=\"TABLE\" OR latest_status_detail.state=\"SUCCEEDED\")` * `update_time \u003e= \"2012-04-21T11:30:00-04:00\"` * `hierarchy_detail.partition_detail.table = \"table1\"`", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "description": "Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results.", "type": "integer" } }, "parameterOrder": [ "parent" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.transferResources.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/transferResources", "path": "v1/{+parent}/transferResources", "description": "Returns information about transfer resources.", "response": { "$ref": "ListTransferResourcesResponse" } } } }, "runs": { "methods": { "list": { "response": { "$ref": "ListTransferRunsResponse" }, "path": "v1/{+parent}/runs", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list", "parameterOrder": [ "parent" ], "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results." }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "description": "Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "type": "string" }, "runAttempt": { "enum": [ "RUN_ATTEMPT_UNSPECIFIED", "LATEST" ], "type": "string", "description": "Indicates how run attempts are to be pulled.", "location": "query", "enumDescriptions": [ "All runs should be returned.", "Only latest run per day should be returned." ] }, "states": { "description": "When specified, only transfer runs with requested states are returned.", "enum": [ "TRANSFER_STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "enumDescriptions": [ "State placeholder (0).", "Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).", "Data transfer is in progress (3).", "Data transfer completed successfully (4).", "Data transfer failed (5).", "Data transfer is cancelled (6)." ], "repeated": true, "location": "query", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "description": "Page size. The default page size is the maximum value of 1000 results.", "type": "integer" } }, "description": "Returns information about running and completed transfer runs." }, "get": { "response": { "$ref": "TransferRun" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "parameters": { "name": { "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string", "location": "path", "required": true } }, "httpMethod": "GET", "path": "v1/{+name}", "description": "Returns information about the particular transfer run.", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameterOrder": [ "name" ] }, "delete": { "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete", "description": "Deletes the specified transfer run.", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`" } }, "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "path": "v1/{+name}", "parameterOrder": [ "name" ] } }, "resources": { "transferLogs": { "methods": { "list": { "httpMethod": "GET", "parameters": { "pageSize": { "type": "integer", "description": "Page size. The default page size is the maximum value of 1000 results.", "format": "int32", "location": "query" }, "parent": { "description": "Required. Transfer run name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$" }, "messageTypes": { "type": "string", "description": "Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.", "enumDescriptions": [ "No severity specified.", "Informational message.", "Warning message.", "Error message." ], "location": "query", "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "repeated": true }, "pageToken": { "location": "query", "type": "string", "description": "Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results." } }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list", "description": "Returns log messages for the transfer run.", "path": "v1/{+parent}/transferLogs", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs", "parameterOrder": [ "parent" ], "response": { "$ref": "ListTransferLogsResponse" } } } } } } } } }, "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "Location" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Resource name for the location." } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "bigquerydatatransfer.projects.locations.get", "description": "Gets information about a location." }, "list": { "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+$", "description": "The resource that owns the locations collection, if applicable." }, "extraLocationTypes": { "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "type": "string", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query" } }, "id": "bigquerydatatransfer.projects.locations.list", "flatPath": "v1/projects/{projectsId}/locations", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "ListLocationsResponse" }, "path": "v1/{+name}/locations", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "parameterOrder": [ "name" ] }, "enrollDataSources": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:enrollDataSources", "response": { "$ref": "Empty" }, "request": { "$ref": "EnrollDataSourcesRequest" }, "description": "Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).", "path": "v1/{+name}:enrollDataSources", "id": "bigquerydatatransfer.projects.locations.enrollDataSources", "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the project resource in the form: `projects/{project_id}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "unenrollDataSources": { "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:unenrollDataSources", "id": "bigquerydatatransfer.projects.locations.unenrollDataSources", "path": "v1/{+name}:unenrollDataSources", "description": "Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the [BigQuery UI](https://console.cloud.google.com/bigquery). Data transfers configurations of unenrolled data sources will not be scheduled.", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the project resource in the form: `projects/{project_id}`" } }, "httpMethod": "POST", "request": { "$ref": "UnenrollDataSourcesRequest" } } } } } } }, "description": "Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.", "servicePath": "", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "TimeBasedSchedule": { "description": "Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.", "id": "TimeBasedSchedule", "properties": { "startTime": { "type": "string", "description": "Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment.", "format": "google-datetime" }, "endTime": { "description": "Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment.", "format": "google-datetime", "type": "string" }, "schedule": { "type": "string", "description": "Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source." } }, "type": "object" }, "DataplexConfiguration": { "type": "object", "description": "Configuration for Dataplex destination.", "id": "DataplexConfiguration", "properties": { "entryGroup": { "description": "Required. The Dataplex Universal Catalog entry group for importing the metadata. entry_group has the format of `projects/{project_id}/locations/{region}/entryGroups/{entry_group_id}`.", "type": "string" } } }, "TransferResourceStatusDetail": { "properties": { "summary": { "description": "Optional. Transfer status summary of the resource.", "$ref": "TransferStatusSummary" }, "error": { "$ref": "Status", "description": "Optional. Transfer error details for the resource." }, "completedPercentage": { "type": "number", "description": "Output only. Percentage of the transfer completed. Valid values: 0-100.", "readOnly": true, "format": "double" }, "state": { "type": "string", "enum": [ "RESOURCE_TRANSFER_STATE_UNSPECIFIED", "RESOURCE_TRANSFER_PENDING", "RESOURCE_TRANSFER_RUNNING", "RESOURCE_TRANSFER_SUCCEEDED", "RESOURCE_TRANSFER_FAILED", "RESOURCE_TRANSFER_CANCELLED" ], "description": "Optional. Transfer state of the resource.", "enumDescriptions": [ "Default value.", "Resource is waiting to be transferred.", "Resource transfer is running.", "Resource transfer is a success.", "Resource transfer failed.", "Resource transfer was cancelled." ] } }, "description": "Status details of the resource being transferred.", "id": "TransferResourceStatusDetail", "type": "object" }, "ScheduleTransferRunsResponse": { "properties": { "runs": { "description": "The transfer runs that were scheduled.", "type": "array", "items": { "$ref": "TransferRun" } } }, "type": "object", "description": "A response to schedule transfer runs for a time range.", "id": "ScheduleTransferRunsResponse" }, "UserInfo": { "description": "Information about a user.", "type": "object", "id": "UserInfo", "properties": { "email": { "description": "E-mail address of the user.", "type": "string" } } }, "CheckValidCredsRequest": { "id": "CheckValidCredsRequest", "description": "A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.", "type": "object", "properties": {} }, "HierarchyDetail": { "description": "Details about the hierarchy.", "id": "HierarchyDetail", "type": "object", "properties": { "partitionDetail": { "description": "Optional. Partition details related to hierarchy.", "$ref": "PartitionDetail" }, "tableDetail": { "$ref": "TableDetail", "description": "Optional. Table details related to hierarchy." } } }, "Status": { "properties": { "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "type": "array" } }, "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "id": "Status" }, "EventDrivenSchedule": { "description": "Options customizing EventDriven transfers schedule.", "type": "object", "id": "EventDrivenSchedule", "properties": { "pubsubSubscription": { "type": "string", "description": "Pub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription}" } } }, "ScheduleOptions": { "description": "Options customizing the data transfer schedule.", "id": "ScheduleOptions", "properties": { "startTime": { "description": "Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.", "type": "string", "format": "google-datetime" }, "disableAutoScheduling": { "description": "If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.", "type": "boolean" }, "endTime": { "format": "google-datetime", "type": "string", "description": "Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option." } }, "type": "object" }, "TransferResource": { "properties": { "latestRun": { "$ref": "TransferRunBrief", "description": "Optional. Run details for the latest run." }, "destination": { "enumDescriptions": [ "Default value.", "BigQuery.", "Dataproc Metastore.", "BigLake Metastore.", "BigLake REST Catalog.", "BigLake Hive Catalog." ], "description": "Optional. Resource destination.", "type": "string", "enum": [ "RESOURCE_DESTINATION_UNSPECIFIED", "RESOURCE_DESTINATION_BIGQUERY", "RESOURCE_DESTINATION_DATAPROC_METASTORE", "RESOURCE_DESTINATION_BIGLAKE_METASTORE", "RESOURCE_DESTINATION_BIGLAKE_REST_CATALOG", "RESOURCE_DESTINATION_BIGLAKE_HIVE_CATALOG" ] }, "lastSuccessfulRun": { "readOnly": true, "$ref": "TransferRunBrief", "description": "Output only. Run details for the last successful run." }, "hierarchyDetail": { "description": "Optional. Details about the hierarchy.", "$ref": "HierarchyDetail" }, "type": { "type": "string", "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "RESOURCE_TYPE_TABLE", "RESOURCE_TYPE_PARTITION" ], "enumDescriptions": [ "Default value.", "Table resource type.", "Partition resource type." ], "description": "Optional. Resource type." }, "name": { "description": "Identifier. Resource name.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Time when the resource was last updated." }, "latestStatusDetail": { "$ref": "TransferResourceStatusDetail", "description": "Optional. Status details for the latest run." } }, "id": "TransferResource", "description": "Resource (table/partition) that is being transferred.", "type": "object" }, "ListTransferResourcesResponse": { "id": "ListTransferResourcesResponse", "type": "object", "description": "Response for the `ListTransferResources` RPC.", "properties": { "nextPageToken": { "type": "string", "readOnly": true, "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "transferResources": { "readOnly": true, "description": "Output only. The transfer resources.", "items": { "$ref": "TransferResource" }, "type": "array" } } }, "TransferStatusSummary": { "id": "TransferStatusSummary", "description": "Status summary of the resource being transferred.", "type": "object", "properties": { "progressUnit": { "type": "string", "enum": [ "TRANSFER_STATUS_UNIT_UNSPECIFIED", "TRANSFER_STATUS_UNIT_BYTES", "TRANSFER_STATUS_UNIT_OBJECTS" ], "enumDescriptions": [ "Default value.", "Bytes.", "Objects." ], "description": "Input only. Unit based on which transfer status progress should be calculated." }, "metrics": { "type": "array", "items": { "$ref": "TransferStatusMetric" }, "description": "Optional. List of transfer status metrics." } } }, "ScheduleTransferRunsRequest": { "type": "object", "description": "A request to schedule transfer runs for a time range.", "properties": { "endTime": { "description": "Required. End time of the range of transfer runs. For example, `\"2017-05-30T00:00:00+00:00\"`.", "format": "google-datetime", "type": "string" }, "startTime": { "type": "string", "description": "Required. Start time of the range of transfer runs. For example, `\"2017-05-25T00:00:00+00:00\"`.", "format": "google-datetime" } }, "id": "ScheduleTransferRunsRequest" }, "TransferRunBrief": { "type": "object", "id": "TransferRunBrief", "description": "Basic information about a transfer run.", "properties": { "run": { "description": "Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}`", "type": "string" }, "startTime": { "format": "google-datetime", "description": "Optional. Start time of the transfer run.", "type": "string" } } }, "TransferConfig": { "type": "object", "properties": { "notificationPubsubTopic": { "type": "string", "description": "Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`" }, "scheduleOptionsV2": { "description": "Options customizing different types of data transfer schedule. This field replaces \"schedule\" and \"schedule_options\" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.", "$ref": "ScheduleOptionsV2" }, "disabled": { "description": "Is this config disabled. When set to true, no runs will be scheduled for this transfer config.", "type": "boolean" }, "displayName": { "description": "User specified display name for the data transfer.", "type": "string" }, "metadataDestination": { "$ref": "MetadataDestination", "description": "The metadata destination of the transfer config." }, "ownerInfo": { "description": "Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.", "readOnly": true, "$ref": "UserInfo" }, "encryptionConfiguration": { "$ref": "EncryptionConfiguration", "description": "The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent." }, "userId": { "format": "int64", "description": "Deprecated. Unique ID of the user on whose behalf transfer is done.", "type": "string" }, "managedTableType": { "enumDescriptions": [ "Type unspecified. This defaults to `NATIVE` table.", "The managed table is a native BigQuery table. This is the default value.", "The managed table is a BigQuery table for Apache Iceberg (formerly BigLake managed tables), with a BigLake configuration." ], "description": "The classification of the destination table.", "type": "string", "enum": [ "MANAGED_TABLE_TYPE_UNSPECIFIED", "NATIVE", "BIGLAKE" ] }, "emailPreferences": { "$ref": "EmailPreferences", "description": "Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config." }, "params": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq" }, "state": { "enumDescriptions": [ "State placeholder (0).", "Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).", "Data transfer is in progress (3).", "Data transfer completed successfully (4).", "Data transfer failed (5).", "Data transfer is cancelled (6)." ], "enum": [ "TRANSFER_STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "description": "Output only. State of the most recently updated transfer run.", "readOnly": true, "type": "string" }, "scheduleOptions": { "$ref": "ScheduleOptions", "description": "Options customizing the data transfer schedule." }, "dataRefreshWindowDays": { "type": "integer", "format": "int32", "description": "The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value." }, "name": { "description": "Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.", "type": "string" }, "error": { "$ref": "Status", "readOnly": true, "description": "Output only. Error code with detailed information about reason of the latest config failure." }, "nextRunTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Next time when data transfer will run." }, "dataSourceId": { "type": "string", "description": "Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list" }, "updateTime": { "description": "Output only. Data transfer modification time. Ignored by server on input.", "format": "google-datetime", "readOnly": true, "type": "string" }, "destinationDatasetId": { "description": "The BigQuery target dataset id.", "type": "string" }, "datasetRegion": { "type": "string", "description": "Output only. Region in which BigQuery dataset is located.", "readOnly": true }, "schedule": { "type": "string", "description": "Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source." } }, "description": "Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.", "id": "TransferConfig" }, "EmailPreferences": { "id": "EmailPreferences", "description": "Represents preferences for sending email notifications for transfer run events.", "properties": { "enableFailureEmail": { "type": "boolean", "description": "If true, email notifications will be sent on transfer run failures." } }, "type": "object" }, "TransferStatusMetric": { "type": "object", "id": "TransferStatusMetric", "properties": { "failed": { "type": "string", "description": "Optional. Number of units that failed to transfer.", "format": "int64" }, "unit": { "enumDescriptions": [ "Default value.", "Bytes.", "Objects." ], "description": "Optional. Unit for measuring progress (e.g., BYTES).", "type": "string", "enum": [ "TRANSFER_STATUS_UNIT_UNSPECIFIED", "TRANSFER_STATUS_UNIT_BYTES", "TRANSFER_STATUS_UNIT_OBJECTS" ] }, "completed": { "description": "Optional. Number of units transferred successfully.", "format": "int64", "type": "string" }, "total": { "format": "int64", "description": "Optional. Total number of units for the transfer.", "type": "string" }, "pending": { "type": "string", "format": "int64", "description": "Optional. Number of units pending transfer." } }, "description": "Metrics for tracking the transfer status." }, "EnrollDataSourcesRequest": { "id": "EnrollDataSourcesRequest", "properties": { "dataSourceIds": { "type": "array", "description": "Data sources that are enrolled. It is required to provide at least one data source id.", "items": { "type": "string" } } }, "description": "A request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab.", "type": "object" }, "DataSource": { "description": "Defines the properties and custom parameters for a data source.", "id": "DataSource", "properties": { "defaultDataRefreshWindowDays": { "format": "int32", "type": "integer", "description": "Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`." }, "name": { "type": "string", "description": "Output only. Data source resource name.", "readOnly": true }, "minimumScheduleInterval": { "description": "The minimum interval for scheduler to schedule runs.", "type": "string", "format": "google-duration" }, "clientId": { "description": "Data source client id which should be used to receive refresh token.", "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "DataSourceParameter" }, "description": "Data source parameters." }, "manualRunsDisabled": { "description": "Disables backfilling and manual run scheduling for the data source.", "type": "boolean" }, "dataRefreshType": { "description": "Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.", "enumDescriptions": [ "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 for the past few days. Does not allow custom values to be set for each transfer config.", "The data source supports data auto refresh, and runs will be scheduled for the past few days. Allows custom values to be set for each transfer config." ], "type": "string", "enum": [ "DATA_REFRESH_TYPE_UNSPECIFIED", "SLIDING_WINDOW", "CUSTOM_SLIDING_WINDOW" ] }, "supportsCustomSchedule": { "type": "boolean", "description": "Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule." }, "displayName": { "description": "User friendly data source name.", "type": "string" }, "defaultSchedule": { "type": "string", "description": "Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`." }, "dataSourceId": { "type": "string", "description": "Data source id." }, "scopes": { "description": "Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery", "items": { "type": "string" }, "type": "array" }, "updateDeadlineSeconds": { "format": "int32", "description": "The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.", "type": "integer" }, "supportsMultipleTransfers": { "description": "Deprecated. This field has no effect.", "deprecated": true, "type": "boolean" }, "helpUrl": { "description": "Url for the help document for this data source.", "type": "string" }, "transferType": { "deprecated": true, "enum": [ "TRANSFER_TYPE_UNSPECIFIED", "BATCH", "STREAMING" ], "enumDescriptions": [ "Invalid or Unknown transfer type placeholder.", "Batch data transfer.", "Streaming data transfer. Streaming data source currently doesn't support multiple transfer configs per project." ], "description": "Deprecated. This field has no effect.", "type": "string" }, "description": { "type": "string", "description": "User friendly data source description string." }, "authorizationType": { "description": "Indicates the type of authorization.", "type": "string", "enum": [ "AUTHORIZATION_TYPE_UNSPECIFIED", "AUTHORIZATION_CODE", "GOOGLE_PLUS_AUTHORIZATION_CODE", "FIRST_PARTY_OAUTH" ], "enumDescriptions": [ "Type unspecified.", "Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend.", "Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend.", "Use First Party OAuth." ] } }, "type": "object" }, "UnenrollDataSourcesRequest": { "description": "A request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's `Transfer` tab.", "type": "object", "properties": { "dataSourceIds": { "items": { "type": "string" }, "type": "array", "description": "Data sources that are unenrolled. It is required to provide at least one data source id." } }, "id": "UnenrollDataSourcesRequest" }, "ListTransferConfigsResponse": { "type": "object", "properties": { "transferConfigs": { "description": "Output only. The stored pipeline transfer configurations.", "items": { "$ref": "TransferConfig" }, "readOnly": true, "type": "array" }, "nextPageToken": { "description": "Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.", "type": "string", "readOnly": true } }, "description": "The returned list of pipelines in the project.", "id": "ListTransferConfigsResponse" }, "TransferRun": { "type": "object", "id": "TransferRun", "properties": { "notificationPubsubTopic": { "readOnly": true, "description": "Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`", "type": "string" }, "errorStatus": { "$ref": "Status", "description": "Status of the transfer run." }, "name": { "description": "Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.", "type": "string" }, "runTime": { "format": "google-datetime", "description": "For batch transfer runs, specifies the date and time of the data should be ingested.", "type": "string" }, "updateTime": { "description": "Output only. Last time the data transfer run state was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "dataSourceId": { "description": "Output only. Data source id.", "readOnly": true, "type": "string" }, "schedule": { "type": "string", "description": "Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. Time when transfer run ended. Parameter ignored by server for input requests.", "format": "google-datetime", "type": "string" }, "startTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Time when transfer run was started. Parameter ignored by server for input requests.", "type": "string" }, "state": { "description": "Data transfer run state. Ignored for input requests.", "type": "string", "enum": [ "TRANSFER_STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "enumDescriptions": [ "State placeholder (0).", "Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).", "Data transfer is in progress (3).", "Data transfer completed successfully (4).", "Data transfer failed (5).", "Data transfer is cancelled (6)." ] }, "destinationDatasetId": { "description": "Output only. The BigQuery target dataset id.", "type": "string", "readOnly": true }, "scheduleTime": { "type": "string", "description": "Minimum time after which a transfer run can be started.", "format": "google-datetime" }, "userId": { "description": "Deprecated. Unique ID of the user on whose behalf transfer is done.", "format": "int64", "type": "string" }, "emailPreferences": { "$ref": "EmailPreferences", "description": "Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.", "readOnly": true }, "params": { "description": "Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq", "type": "object", "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "description": "Represents a data transfer run." }, "ListTransferLogsResponse": { "id": "ListTransferLogsResponse", "properties": { "transferMessages": { "readOnly": true, "description": "Output only. The stored pipeline transfer messages.", "items": { "$ref": "TransferMessage" }, "type": "array" }, "nextPageToken": { "readOnly": true, "description": "Output only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results.", "type": "string" } }, "type": "object", "description": "The returned list transfer run messages." }, "CheckValidCredsResponse": { "id": "CheckValidCredsResponse", "properties": { "hasValidCreds": { "description": "If set to `true`, the credentials exist and are valid.", "type": "boolean" } }, "type": "object", "description": "A response indicating whether the credentials exist and are valid." }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object" }, "TransferMessage": { "id": "TransferMessage", "type": "object", "description": "Represents a user facing message for a particular data transfer run.", "properties": { "messageText": { "description": "Message text.", "type": "string" }, "severity": { "type": "string", "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "enumDescriptions": [ "No severity specified.", "Informational message.", "Warning message.", "Error message." ], "description": "Message severity." }, "messageTime": { "format": "google-datetime", "description": "Time when message was logged.", "type": "string" } } }, "EncryptionConfiguration": { "description": "Represents the encryption configuration for a transfer.", "id": "EncryptionConfiguration", "properties": { "kmsKeyName": { "type": "string", "description": "The name of the KMS key used for encrypting BigQuery data." } }, "type": "object" }, "ListTransferRunsResponse": { "description": "The returned list of pipelines in the project.", "properties": { "transferRuns": { "description": "Output only. The stored pipeline transfer runs.", "readOnly": true, "type": "array", "items": { "$ref": "TransferRun" } }, "nextPageToken": { "description": "Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results.", "readOnly": true, "type": "string" } }, "type": "object", "id": "ListTransferRunsResponse" }, "TimeRange": { "type": "object", "id": "TimeRange", "description": "A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).", "properties": { "startTime": { "format": "google-datetime", "type": "string", "description": "Start time of the range of transfer runs. For example, `\"2017-05-25T00:00:00+00:00\"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive)." }, "endTime": { "description": "End time of the range of transfer runs. For example, `\"2017-05-30T00:00:00+00:00\"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).", "format": "google-datetime", "type": "string" } } }, "ScheduleOptionsV2": { "id": "ScheduleOptionsV2", "description": "V2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.", "properties": { "eventDrivenSchedule": { "description": "Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.", "$ref": "EventDrivenSchedule" }, "timeBasedSchedule": { "description": "Time based transfer schedule options. This is the default schedule option.", "$ref": "TimeBasedSchedule" }, "manualSchedule": { "$ref": "ManualSchedule", "description": "Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true." } }, "type": "object" }, "MetadataDestination": { "type": "object", "description": "The metadata destination of the transfer config.", "properties": { "dataplexConfiguration": { "description": "The Dataplex Universal Catalog configuration.", "$ref": "DataplexConfiguration" } }, "id": "MetadataDestination" }, "PartitionDetail": { "type": "object", "description": "Partition details related to hierarchy.", "id": "PartitionDetail", "properties": { "table": { "description": "Optional. Name of the table which has the partitions.", "type": "string" } } }, "StartManualTransferRunsResponse": { "id": "StartManualTransferRunsResponse", "type": "object", "properties": { "runs": { "type": "array", "items": { "$ref": "TransferRun" }, "description": "The transfer runs that were created." } }, "description": "A response to start manual transfer runs." }, "ManualSchedule": { "id": "ManualSchedule", "description": "Options customizing manual transfers schedule.", "type": "object", "properties": {} }, "Empty": { "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "id": "Empty" }, "TableDetail": { "type": "object", "description": "Table details related to hierarchy.", "id": "TableDetail", "properties": { "partitionCount": { "type": "string", "description": "Optional. Total number of partitions being tracked within the table.", "format": "int64" } } }, "ListDataSourcesResponse": { "id": "ListDataSourcesResponse", "type": "object", "description": "Returns list of supported data sources and their metadata.", "properties": { "dataSources": { "type": "array", "description": "List of supported data sources and their transfer settings.", "items": { "$ref": "DataSource" } }, "nextPageToken": { "readOnly": true, "type": "string", "description": "Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results." } } }, "StartManualTransferRunsRequest": { "description": "A request to start manual transfer runs.", "id": "StartManualTransferRunsRequest", "type": "object", "properties": { "requestedTimeRange": { "description": "A time_range start and end timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_time_range must be a past time and cannot include future time values.", "$ref": "TimeRange" }, "requestedRunTime": { "description": "A run_time timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_run_time must be a past time and cannot include future time values.", "type": "string", "format": "google-datetime" } } }, "DataSourceParameter": { "id": "DataSourceParameter", "type": "object", "properties": { "minValue": { "type": "number", "description": "For integer and double values specifies minimum allowed value.", "format": "double" }, "displayName": { "description": "Parameter display name in the user interface.", "type": "string" }, "required": { "description": "Is parameter required.", "type": "boolean" }, "type": { "description": "Parameter type.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "RECORD", "PLUS_PAGE", "LIST" ], "enumDescriptions": [ "Type unspecified.", "String parameter.", "Integer parameter (64-bits). Will be serialized to json as string.", "Double precision floating point parameter.", "Boolean parameter.", "Deprecated. This field has no effect.", "Page ID for a Google+ Page.", "List of strings parameter." ] }, "immutable": { "description": "Cannot be changed after initial creation.", "type": "boolean" }, "validationDescription": { "description": "Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.", "type": "string" }, "maxListSize": { "format": "int64", "type": "string", "description": "For list parameters, the max size of the list." }, "fields": { "items": { "$ref": "DataSourceParameter" }, "description": "Deprecated. This field has no effect.", "type": "array" }, "maxValue": { "type": "number", "description": "For integer and double values specifies maximum allowed value.", "format": "double" }, "recurse": { "type": "boolean", "description": "Deprecated. This field has no effect." }, "description": { "type": "string", "description": "Parameter description." }, "allowedValues": { "description": "All possible values for the parameter.", "items": { "type": "string" }, "type": "array" }, "deprecated": { "description": "If true, it should not be used in new transfers, and it should not be visible to users.", "type": "boolean" }, "validationHelpUrl": { "type": "string", "description": "URL to a help document to further explain the naming requirements." }, "paramId": { "type": "string", "description": "Parameter identifier." }, "validationRegex": { "type": "string", "description": "Regular expression which can be used for parameter validation." }, "repeated": { "description": "Deprecated. This field has no effect.", "type": "boolean" } }, "description": "A parameter used to define custom fields in a data source definition." }, "Location": { "properties": { "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" } }, "description": "A resource that represents a Google Cloud location.", "type": "object", "id": "Location" } }, "parameters": { "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "location": "query" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "quotaUser": { "location": "query", "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.", "type": "string" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "prettyPrint": { "type": "boolean", "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true" }, "$.xgafv": { "location": "query", "type": "string", "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ] }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "key": { "location": "query", "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.", "type": "string" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" } }, "ownerName": "Google", "id": "bigquerydatatransfer:v1", "ownerDomain": "google.com", "documentationLink": "https://cloud.google.com/bigquery-transfer/", "baseUrl": "https://bigquerydatatransfer.googleapis.com/", "version_module": true }