{ "revision": "20260423", "discoveryVersion": "v1", "canonicalName": "BigQuery Data Transfer", "documentationLink": "https://cloud.google.com/bigquery-transfer/", "version": "v1", "baseUrl": "https://bigquerydatatransfer.googleapis.com/", "version_module": true, "auth": { "oauth2": { "scopes": { "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" }, "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." } } } }, "kind": "discovery#restDescription", "title": "BigQuery Data Transfer API", "endpoints": [ { "location": "asia-south1", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.asia-south1.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.asia-south2.rep.googleapis.com/", "location": "asia-south2", "description": "Regional Endpoint" }, { "endpointUrl": "https://bigquerydatatransfer.europe-west1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west1" }, { "location": "europe-west2", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west2.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.europe-west3.rep.googleapis.com/", "location": "europe-west3", "description": "Regional Endpoint" }, { "endpointUrl": "https://bigquerydatatransfer.europe-west4.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west4" }, { "location": "europe-west6", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west6.rep.googleapis.com/" }, { "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" }, { "endpointUrl": "https://bigquerydatatransfer.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "northamerica-northeast2", "endpointUrl": "https://bigquerydatatransfer.northamerica-northeast2.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.us-central1.rep.googleapis.com/", "location": "us-central1", "description": "Regional Endpoint" }, { "location": "us-central2", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-central2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "us-east1", "endpointUrl": "https://bigquerydatatransfer.us-east1.rep.googleapis.com/" }, { "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/" }, { "location": "us-east7", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-east7.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.us-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-south1" }, { "description": "Regional Endpoint", "location": "us-west1", "endpointUrl": "https://bigquerydatatransfer.us-west1.rep.googleapis.com/" }, { "location": "us-west2", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-west2.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.us-west3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west3" }, { "endpointUrl": "https://bigquerydatatransfer.us-west4.rep.googleapis.com/", "location": "us-west4", "description": "Regional Endpoint" }, { "endpointUrl": "https://bigquerydatatransfer.us-west8.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west8" } ], "ownerName": "Google", "batchPath": "batch", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "basePath": "", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "name": "bigquerydatatransfer", "fullyEncodeReservedExpansion": true, "id": "bigquerydatatransfer:v1", "servicePath": "", "description": "Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.", "ownerDomain": "google.com", "mtlsRootUrl": "https://bigquerydatatransfer.mtls.googleapis.com/", "parameters": { "alt": { "description": "Data format for response.", "location": "query", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "type": "string" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "$.xgafv": { "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "location": "query", "description": "V1 error format." }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "key": { "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.", "location": "query", "type": "string" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "quotaUser": { "type": "string", "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.", "location": "query" } }, "resources": { "projects": { "resources": { "locations": { "resources": { "dataSources": { "methods": { "get": { "parameterOrder": [ "name" ], "description": "Retrieves a supported data source and returns its settings.", "path": "v1/{+name}", "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.locations.dataSources.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", "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}/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}`", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}", "response": { "$ref": "DataSource" } }, "list": { "parameterOrder": [ "parent" ], "description": "Lists supported data sources and returns their settings.", "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}/dataSources", "httpMethod": "GET", "id": "bigquerydatatransfer.projects.locations.dataSources.list", "parameters": { "parent": { "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}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "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" }, "pageSize": { "location": "query", "format": "int32", "description": "Page size. The default page size is the maximum value of 1000 results.", "type": "integer" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources", "response": { "$ref": "ListDataSourcesResponse" } }, "checkValidCreds": { "path": "v1/{+name}:checkValidCreds", "request": { "$ref": "CheckValidCredsRequest" }, "httpMethod": "POST", "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" ], "description": "Returns true if valid credentials exist for the given data source and requesting user.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds", "response": { "$ref": "CheckValidCredsResponse" }, "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds", "parameters": { "name": { "location": "path", "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}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$" } } } } }, "transferConfigs": { "methods": { "get": { "id": "bigquerydatatransfer.projects.locations.transferConfigs.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "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}`", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", "response": { "$ref": "TransferConfig" }, "parameterOrder": [ "name" ], "description": "Returns information about a data transfer config.", "path": "v1/{+name}", "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" ] }, "startManualRuns": { "path": "v1/{+parent}:startManualRuns", "request": { "$ref": "StartManualTransferRunsRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns", "response": { "$ref": "StartManualTransferRunsResponse" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/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}`", "required": true, "location": "path" } } }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes a data transfer configuration, including any associated transfer runs and logs.", "httpMethod": "DELETE", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "type": "string", "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}`", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", "response": { "$ref": "Empty" } }, "scheduleRuns": { "parameterOrder": [ "parent" ], "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" ], "httpMethod": "POST", "deprecated": true, "path": "v1/{+parent}:scheduleRuns", "request": { "$ref": "ScheduleTransferRunsRequest" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns", "parameters": { "parent": { "location": "path", "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}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns", "response": { "$ref": "ScheduleTransferRunsResponse" } }, "create": { "id": "bigquerydatatransfer.projects.locations.transferConfigs.create", "parameters": { "parent": { "location": "path", "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.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "authorizationCode": { "type": "string", "location": "query", "deprecated": true, "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." }, "versionInfo": { "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.", "location": "query" }, "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" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs", "response": { "$ref": "TransferConfig" }, "parameterOrder": [ "parent" ], "description": "Creates a new data transfer configuration.", "httpMethod": "POST", "path": "v1/{+parent}/transferConfigs", "request": { "$ref": "TransferConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "parameterOrder": [ "name" ], "description": "Updates a data transfer configuration. All fields must be set, even if they are not updated.", "httpMethod": "PATCH", "path": "v1/{+name}", "request": { "$ref": "TransferConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch", "parameters": { "updateMask": { "description": "Required. Required list of fields to be updated in this request.", "location": "query", "format": "google-fieldmask", "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.", "location": "query", "deprecated": true, "type": "string" }, "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" }, "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.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "type": "string" }, "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 update the transfer config.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", "response": { "$ref": "TransferConfig" } }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs", "response": { "$ref": "ListTransferConfigsResponse" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.list", "parameters": { "pageSize": { "type": "integer", "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32" }, "dataSourceIds": { "location": "query", "description": "When specified, only configurations of requested data sources are returned.", "type": "string", "repeated": true }, "parent": { "type": "string", "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}`", "required": true, "location": "path" }, "pageToken": { "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.", "type": "string" } }, "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", "path": "v1/{+parent}/transferConfigs", "parameterOrder": [ "parent" ], "description": "Returns information about all transfer configs owned by a project in the specified location." } }, "resources": { "transferResources": { "methods": { "get": { "id": "bigquerydatatransfer.projects.locations.transferConfigs.transferResources.get", "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}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/transferResources/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/transferResources/{transferResourcesId}", "response": { "$ref": "TransferResource" }, "parameterOrder": [ "name" ], "description": "Returns a transfer resource.", "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", "path": "v1/{+name}" }, "list": { "id": "bigquerydatatransfer.projects.locations.transferConfigs.transferResources.list", "parameters": { "pageSize": { "location": "query", "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.", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/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}`", "required": true, "location": "path" }, "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" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/transferResources", "response": { "$ref": "ListTransferResourcesResponse" }, "parameterOrder": [ "parent" ], "description": "Returns information about transfer resources.", "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", "path": "v1/{+parent}/transferResources" } } }, "runs": { "resources": { "transferLogs": { "methods": { "list": { "path": "v1/{+parent}/transferLogs", "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" ], "parameterOrder": [ "parent" ], "description": "Returns log messages for the transfer run.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs", "response": { "$ref": "ListTransferLogsResponse" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list", "parameters": { "messageTypes": { "location": "query", "description": "Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.", "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "enumDescriptions": [ "No severity specified.", "Informational message.", "Warning message.", "Error message." ], "type": "string", "repeated": true }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string", "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}`", "required": true, "location": "path" }, "pageToken": { "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.", "location": "query", "type": "string" }, "pageSize": { "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32", "type": "integer" } } } } } }, "methods": { "delete": { "parameterOrder": [ "name" ], "description": "Deletes the specified transfer run.", "httpMethod": "DELETE", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string", "location": "path", "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}`", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "response": { "$ref": "Empty" } }, "get": { "httpMethod": "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" ], "parameterOrder": [ "name" ], "description": "Returns information about the particular transfer run.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "response": { "$ref": "TransferRun" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get", "parameters": { "name": { "location": "path", "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}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$" } } }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs", "response": { "$ref": "ListTransferRunsResponse" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list", "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "Page size. The default page size is the maximum value of 1000 results.", "type": "integer" }, "states": { "description": "When specified, only transfer runs with requested states are returned.", "location": "query", "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, "type": "string" }, "parent": { "type": "string", "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}`", "required": true, "location": "path" }, "pageToken": { "type": "string", "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.", "location": "query" }, "runAttempt": { "type": "string", "enumDescriptions": [ "All runs should be returned.", "Only latest run per day should be returned." ], "enum": [ "RUN_ATTEMPT_UNSPECIFIED", "LATEST" ], "location": "query", "description": "Indicates how run attempts are to be pulled." } }, "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", "path": "v1/{+parent}/runs", "parameterOrder": [ "parent" ], "description": "Returns information about running and completed transfer runs." } } } } } }, "methods": { "enrollDataSources": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1/{+name}:enrollDataSources", "request": { "$ref": "EnrollDataSourcesRequest" }, "parameterOrder": [ "name" ], "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}/locations/{locationsId}:enrollDataSources", "response": { "$ref": "Empty" }, "id": "bigquerydatatransfer.projects.locations.enrollDataSources", "parameters": { "name": { "location": "path", "description": "Required. The name of the project resource in the form: `projects/{project_id}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "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", "path": "v1/{+name}/locations", "parameterOrder": [ "name" ], "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.", "flatPath": "v1/projects/{projectsId}/locations", "response": { "$ref": "ListLocationsResponse" }, "id": "bigquerydatatransfer.projects.locations.list", "parameters": { "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "format": "int32", "type": "integer" }, "name": { "type": "string", "pattern": "^projects/[^/]+$", "description": "The resource that owns the locations collection, if applicable.", "required": true, "location": "path" }, "extraLocationTypes": { "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string", "repeated": true }, "filter": { "location": "query", "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).", "type": "string" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" } } }, "get": { "parameterOrder": [ "name" ], "description": "Gets information about a location.", "path": "v1/{+name}", "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.locations.get", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Resource name for the location.", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "response": { "$ref": "Location" } }, "unenrollDataSources": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1/{+name}:unenrollDataSources", "request": { "$ref": "UnenrollDataSourcesRequest" }, "parameterOrder": [ "name" ], "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:unenrollDataSources", "response": { "$ref": "Empty" }, "id": "bigquerydatatransfer.projects.locations.unenrollDataSources", "parameters": { "name": { "description": "Required. The name of the project resource in the form: `projects/{project_id}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } } } } }, "dataSources": { "methods": { "list": { "httpMethod": "GET", "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" ], "parameterOrder": [ "parent" ], "description": "Lists supported data sources and returns their settings.", "flatPath": "v1/projects/{projectsId}/dataSources", "response": { "$ref": "ListDataSourcesResponse" }, "id": "bigquerydatatransfer.projects.dataSources.list", "parameters": { "parent": { "pattern": "^projects/[^/]+$", "type": "string", "location": "path", "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}`", "required": true }, "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" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Page size. The default page size is the maximum value of 1000 results." } } }, "checkValidCreds": { "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds", "response": { "$ref": "CheckValidCredsResponse" }, "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds", "parameters": { "name": { "pattern": "^projects/[^/]+/dataSources/[^/]+$", "type": "string", "location": "path", "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}`", "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" ], "path": "v1/{+name}:checkValidCreds", "request": { "$ref": "CheckValidCredsRequest" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "description": "Returns true if valid credentials exist for the given data source and requesting user." }, "get": { "httpMethod": "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" ], "parameterOrder": [ "name" ], "description": "Retrieves a supported data source and returns its settings.", "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}", "response": { "$ref": "DataSource" }, "id": "bigquerydatatransfer.projects.dataSources.get", "parameters": { "name": { "pattern": "^projects/[^/]+/dataSources/[^/]+$", "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}/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}`", "required": true, "location": "path" } } } } }, "transferConfigs": { "methods": { "create": { "parameterOrder": [ "parent" ], "description": "Creates a new data transfer configuration.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1/{+parent}/transferConfigs", "request": { "$ref": "TransferConfig" }, "id": "bigquerydatatransfer.projects.transferConfigs.create", "parameters": { "authorizationCode": { "type": "string", "location": "query", "deprecated": true, "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." }, "versionInfo": { "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.", "location": "query" }, "serviceAccountName": { "type": "string", "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)." }, "parent": { "location": "path", "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.", "required": true, "type": "string", "pattern": "^projects/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/transferConfigs", "response": { "$ref": "TransferConfig" } }, "patch": { "id": "bigquerydatatransfer.projects.transferConfigs.patch", "parameters": { "updateMask": { "type": "string", "description": "Required. Required list of fields to be updated in this request.", "location": "query", "format": "google-fieldmask" }, "authorizationCode": { "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.", "location": "query", "deprecated": true }, "serviceAccountName": { "type": "string", "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)." }, "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.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" }, "versionInfo": { "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 update the transfer config.", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "response": { "$ref": "TransferConfig" }, "parameterOrder": [ "name" ], "description": "Updates a data transfer configuration. All fields must be set, even if they are not updated.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "request": { "$ref": "TransferConfig" }, "httpMethod": "PATCH" }, "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", "path": "v1/{+parent}/transferConfigs", "parameterOrder": [ "parent" ], "description": "Returns information about all transfer configs owned by a project in the specified location.", "flatPath": "v1/projects/{projectsId}/transferConfigs", "response": { "$ref": "ListTransferConfigsResponse" }, "id": "bigquerydatatransfer.projects.transferConfigs.list", "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Page size. The default page size is the maximum value of 1000 results." }, "dataSourceIds": { "location": "query", "description": "When specified, only configurations of requested data sources are returned.", "type": "string", "repeated": true }, "parent": { "type": "string", "pattern": "^projects/[^/]+$", "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}`", "required": true, "location": "path" }, "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" } } }, "delete": { "httpMethod": "DELETE", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Deletes a data transfer configuration, including any associated transfer runs and logs.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "response": { "$ref": "Empty" }, "id": "bigquerydatatransfer.projects.transferConfigs.delete", "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}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "type": "string" } } }, "scheduleRuns": { "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns", "response": { "$ref": "ScheduleTransferRunsResponse" }, "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns", "parameters": { "parent": { "location": "path", "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}`", "required": true, "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}:scheduleRuns", "request": { "$ref": "ScheduleTransferRunsRequest" }, "httpMethod": "POST", "deprecated": true, "parameterOrder": [ "parent" ], "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." }, "get": { "parameterOrder": [ "name" ], "description": "Returns information about a data transfer config.", "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", "path": "v1/{+name}", "id": "bigquerydatatransfer.projects.transferConfigs.get", "parameters": { "name": { "location": "path", "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}`", "required": true, "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "response": { "$ref": "TransferConfig" } }, "startManualRuns": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}:startManualRuns", "request": { "$ref": "StartManualTransferRunsRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "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.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns", "response": { "$ref": "StartManualTransferRunsResponse" }, "id": "bigquerydatatransfer.projects.transferConfigs.startManualRuns", "parameters": { "parent": { "location": "path", "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}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" } } } }, "resources": { "runs": { "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" ], "httpMethod": "GET", "path": "v1/{+parent}/runs", "parameterOrder": [ "parent" ], "description": "Returns information about running and completed transfer runs.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs", "response": { "$ref": "ListTransferRunsResponse" }, "id": "bigquerydatatransfer.projects.transferConfigs.runs.list", "parameters": { "pageSize": { "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32", "type": "integer" }, "states": { "description": "When specified, only transfer runs with requested states are returned.", "location": "query", "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, "type": "string" }, "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}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" }, "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." }, "runAttempt": { "enum": [ "RUN_ATTEMPT_UNSPECIFIED", "LATEST" ], "description": "Indicates how run attempts are to be pulled.", "location": "query", "type": "string", "enumDescriptions": [ "All runs should be returned.", "Only latest run per day should be returned." ] } } }, "delete": { "httpMethod": "DELETE", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Deletes the specified transfer run.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "response": { "$ref": "Empty" }, "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete", "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}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string" } } }, "get": { "id": "bigquerydatatransfer.projects.transferConfigs.runs.get", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "location": "path", "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}`", "required": true } }, "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "response": { "$ref": "TransferRun" }, "parameterOrder": [ "name" ], "description": "Returns information about the particular transfer run.", "httpMethod": "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" ] } }, "resources": { "transferLogs": { "methods": { "list": { "parameterOrder": [ "parent" ], "description": "Returns log messages for the 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" ], "httpMethod": "GET", "path": "v1/{+parent}/transferLogs", "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list", "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "Page size. The default page size is the maximum value of 1000 results.", "type": "integer" }, "messageTypes": { "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "location": "query", "description": "Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.", "type": "string", "repeated": true, "enumDescriptions": [ "No severity specified.", "Informational message.", "Warning message.", "Error message." ] }, "parent": { "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string", "location": "path", "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}`", "required": true }, "pageToken": { "type": "string", "location": "query", "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." } }, "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs", "response": { "$ref": "ListTransferLogsResponse" } } } } } }, "transferResources": { "methods": { "get": { "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/transferResources/{transferResourcesId}", "response": { "$ref": "TransferResource" }, "id": "bigquerydatatransfer.projects.transferConfigs.transferResources.get", "parameters": { "name": { "location": "path", "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}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/transferResources/[^/]+$" } }, "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}", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Returns a transfer resource." }, "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", "path": "v1/{+parent}/transferResources", "parameterOrder": [ "parent" ], "description": "Returns information about transfer resources.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/transferResources", "response": { "$ref": "ListTransferResourcesResponse" }, "id": "bigquerydatatransfer.projects.transferConfigs.transferResources.list", "parameters": { "parent": { "location": "path", "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}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" }, "pageToken": { "type": "string", "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.", "location": "query" }, "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": { "location": "query", "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.", "type": "integer" } } } } } } } }, "methods": { "enrollDataSources": { "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:enrollDataSources", "request": { "$ref": "EnrollDataSourcesRequest" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "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" }, "id": "bigquerydatatransfer.projects.enrollDataSources", "parameters": { "name": { "location": "path", "description": "Required. The name of the project resource in the form: `projects/{project_id}`", "required": true, "pattern": "^projects/[^/]+$", "type": "string" } } } } } }, "schemas": { "TransferStatusSummary": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "$ref": "TransferStatusMetric" }, "description": "Optional. List of transfer status metrics." }, "progressUnit": { "description": "Input only. Unit based on which transfer status progress should be calculated.", "enumDescriptions": [ "Default value.", "Bytes.", "Objects." ], "enum": [ "TRANSFER_STATUS_UNIT_UNSPECIFIED", "TRANSFER_STATUS_UNIT_BYTES", "TRANSFER_STATUS_UNIT_OBJECTS" ], "type": "string" } }, "id": "TransferStatusSummary", "description": "Status summary of the resource being transferred." }, "HierarchyDetail": { "id": "HierarchyDetail", "description": "Details about the hierarchy.", "properties": { "partitionDetail": { "description": "Optional. Partition details related to hierarchy.", "$ref": "PartitionDetail" }, "tableDetail": { "description": "Optional. Table details related to hierarchy.", "$ref": "TableDetail" } }, "type": "object" }, "EnrollDataSourcesRequest": { "id": "EnrollDataSourcesRequest", "description": "A request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab.", "properties": { "dataSourceIds": { "type": "array", "items": { "type": "string" }, "description": "Data sources that are enrolled. It is required to provide at least one data source id." } }, "type": "object" }, "UserInfo": { "id": "UserInfo", "description": "Information about a user.", "type": "object", "properties": { "email": { "description": "E-mail address of the user.", "type": "string" } } }, "DataSource": { "id": "DataSource", "description": "Defines the properties and custom parameters for a data source.", "properties": { "name": { "type": "string", "readOnly": true, "description": "Output only. Data source resource name." }, "dataRefreshType": { "type": "string", "enum": [ "DATA_REFRESH_TYPE_UNSPECIFIED", "SLIDING_WINDOW", "CUSTOM_SLIDING_WINDOW" ], "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." ] }, "updateDeadlineSeconds": { "type": "integer", "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." }, "authorizationType": { "enum": [ "AUTHORIZATION_TYPE_UNSPECIFIED", "AUTHORIZATION_CODE", "GOOGLE_PLUS_AUTHORIZATION_CODE", "FIRST_PARTY_OAUTH" ], "type": "string", "description": "Indicates the type of authorization.", "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." ] }, "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", "type": "array", "items": { "type": "string" } }, "description": { "type": "string", "description": "User friendly data source description string." }, "transferType": { "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." ], "deprecated": true, "type": "string", "description": "Deprecated. This field has no effect.", "enum": [ "TRANSFER_TYPE_UNSPECIFIED", "BATCH", "STREAMING" ] }, "supportsMultipleTransfers": { "type": "boolean", "description": "Deprecated. This field has no effect.", "deprecated": true }, "supportsCustomSchedule": { "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.", "type": "boolean" }, "defaultSchedule": { "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`.", "type": "string" }, "minimumScheduleInterval": { "type": "string", "description": "The minimum interval for scheduler to schedule runs.", "format": "google-duration" }, "helpUrl": { "type": "string", "description": "Url for the help document for this data source." }, "manualRunsDisabled": { "description": "Disables backfilling and manual run scheduling for the data source.", "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "DataSourceParameter" }, "description": "Data source parameters." }, "defaultDataRefreshWindowDays": { "type": "integer", "format": "int32", "description": "Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`." }, "dataSourceId": { "description": "Data source id.", "type": "string" }, "displayName": { "type": "string", "description": "User friendly data source name." }, "clientId": { "description": "Data source client id which should be used to receive refresh token.", "type": "string" } }, "type": "object" }, "Status": { "id": "Status", "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", "properties": { "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." }, "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } } } }, "TableDetail": { "type": "object", "properties": { "partitionCount": { "type": "string", "format": "int64", "description": "Optional. Total number of partitions being tracked within the table." } }, "id": "TableDetail", "description": "Table details related to hierarchy." }, "ScheduleTransferRunsRequest": { "id": "ScheduleTransferRunsRequest", "description": "A request to schedule transfer runs for a time range.", "properties": { "startTime": { "format": "google-datetime", "description": "Required. Start time of the range of transfer runs. For example, `\"2017-05-25T00:00:00+00:00\"`.", "type": "string" }, "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" } }, "type": "object" }, "TransferRun": { "type": "object", "properties": { "emailPreferences": { "readOnly": true, "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.", "$ref": "EmailPreferences" }, "destinationDatasetId": { "description": "Output only. The BigQuery target dataset id.", "readOnly": true, "type": "string" }, "notificationPubsubTopic": { "type": "string", "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}`", "readOnly": true }, "endTime": { "type": "string", "description": "Output only. Time when transfer run ended. Parameter ignored by server for input requests.", "readOnly": true, "format": "google-datetime" }, "updateTime": { "type": "string", "description": "Output only. Last time the data transfer run state was updated.", "readOnly": true, "format": "google-datetime" }, "userId": { "type": "string", "format": "int64", "description": "Deprecated. Unique ID of the user on whose behalf transfer is done." }, "schedule": { "readOnly": true, "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.", "type": "string" }, "runTime": { "type": "string", "description": "For batch transfer runs, specifies the date and time of the data should be ingested.", "format": "google-datetime" }, "dataSourceId": { "type": "string", "readOnly": true, "description": "Output only. Data source id." }, "scheduleTime": { "type": "string", "description": "Minimum time after which a transfer run can be started.", "format": "google-datetime" }, "startTime": { "type": "string", "description": "Output only. Time when transfer run was started. Parameter ignored by server for input requests.", "readOnly": true, "format": "google-datetime" }, "name": { "type": "string", "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." }, "errorStatus": { "description": "Status of the transfer run.", "$ref": "Status" }, "state": { "enum": [ "TRANSFER_STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string", "description": "Data transfer run state. Ignored for input requests.", "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)." ] }, "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", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true, "type": "object" } }, "id": "TransferRun", "description": "Represents a data transfer run." }, "TransferMessage": { "id": "TransferMessage", "description": "Represents a user facing message for a particular data transfer run.", "properties": { "messageTime": { "description": "Time when message was logged.", "format": "google-datetime", "type": "string" }, "messageText": { "description": "Message text.", "type": "string" }, "severity": { "description": "Message severity.", "enumDescriptions": [ "No severity specified.", "Informational message.", "Warning message.", "Error message." ], "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "type": "string" } }, "type": "object" }, "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": { "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.", "$ref": "ManualSchedule" }, "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" } }, "type": "object" }, "EventDrivenSchedule": { "id": "EventDrivenSchedule", "description": "Options customizing EventDriven transfers schedule.", "type": "object", "properties": { "pubsubSubscription": { "description": "Pub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription}", "type": "string" } } }, "CheckValidCredsResponse": { "id": "CheckValidCredsResponse", "description": "A response indicating whether the credentials exist and are valid.", "type": "object", "properties": { "hasValidCreds": { "description": "If set to `true`, the credentials exist and are valid.", "type": "boolean" } } }, "ListTransferResourcesResponse": { "id": "ListTransferResourcesResponse", "description": "Response for the `ListTransferResources` RPC.", "properties": { "transferResources": { "readOnly": true, "description": "Output only. The transfer resources.", "type": "array", "items": { "$ref": "TransferResource" } }, "nextPageToken": { "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.", "readOnly": true, "type": "string" } }, "type": "object" }, "ListDataSourcesResponse": { "id": "ListDataSourcesResponse", "description": "Returns list of supported data sources and their metadata.", "properties": { "dataSources": { "type": "array", "items": { "$ref": "DataSource" }, "description": "List of supported data sources and their transfer settings." }, "nextPageToken": { "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.", "readOnly": true } }, "type": "object" }, "TransferConfig": { "id": "TransferConfig", "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.", "type": "object", "properties": { "displayName": { "type": "string", "description": "User specified display name for the data transfer." }, "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" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Data transfer modification time. Ignored by server on input.", "type": "string" }, "userId": { "description": "Deprecated. Unique ID of the user on whose behalf transfer is done.", "format": "int64", "type": "string" }, "datasetRegion": { "type": "string", "readOnly": true, "description": "Output only. Region in which BigQuery dataset is located." }, "schedule": { "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": "string" }, "dataSourceId": { "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", "type": "string" }, "ownerInfo": { "readOnly": true, "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.", "$ref": "UserInfo" }, "emailPreferences": { "description": "Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.", "$ref": "EmailPreferences" }, "error": { "readOnly": true, "description": "Output only. Error code with detailed information about reason of the latest config failure.", "$ref": "Status" }, "destinationDatasetId": { "type": "string", "description": "The BigQuery target dataset id." }, "notificationPubsubTopic": { "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}`", "type": "string" }, "nextRunTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Next time when data transfer will run.", "type": "string" }, "state": { "readOnly": true, "description": "Output only. State of the most recently updated transfer run.", "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)." ], "type": "string" }, "params": { "type": "object", "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", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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." }, "disabled": { "type": "boolean", "description": "Is this config disabled. When set to true, no runs will be scheduled for this transfer config." }, "scheduleOptions": { "description": "Options customizing the data transfer schedule.", "$ref": "ScheduleOptions" }, "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.", "$ref": "EncryptionConfiguration" }, "managedTableType": { "description": "The classification of the destination table.", "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." ], "type": "string", "enum": [ "MANAGED_TABLE_TYPE_UNSPECIFIED", "NATIVE", "BIGLAKE" ] }, "name": { "type": "string", "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." } } }, "UnenrollDataSourcesRequest": { "type": "object", "properties": { "dataSourceIds": { "type": "array", "items": { "type": "string" }, "description": "Data sources that are unenrolled. It is required to provide at least one data source id." } }, "id": "UnenrollDataSourcesRequest", "description": "A request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's `Transfer` tab." }, "EncryptionConfiguration": { "type": "object", "properties": { "kmsKeyName": { "description": "The name of the KMS key used for encrypting BigQuery data.", "type": "string" } }, "id": "EncryptionConfiguration", "description": "Represents the encryption configuration for a transfer." }, "ListTransferConfigsResponse": { "type": "object", "properties": { "transferConfigs": { "description": "Output only. The stored pipeline transfer configurations.", "readOnly": true, "type": "array", "items": { "$ref": "TransferConfig" } }, "nextPageToken": { "readOnly": true, "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" } }, "id": "ListTransferConfigsResponse", "description": "The returned list of pipelines in the project." }, "ScheduleOptions": { "id": "ScheduleOptions", "description": "Options customizing the data transfer schedule.", "properties": { "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": { "type": "string", "format": "google-datetime", "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." }, "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. The time when a data transfer can be triggered manually is not limited by this option.", "format": "google-datetime" } }, "type": "object" }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "properties": { "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" }, "type": "object" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } }, "type": "object" }, "TransferRunBrief": { "type": "object", "properties": { "run": { "type": "string", "description": "Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}`" }, "startTime": { "description": "Optional. Start time of the transfer run.", "format": "google-datetime", "type": "string" } }, "id": "TransferRunBrief", "description": "Basic information about a transfer run." }, "TransferResource": { "type": "object", "properties": { "type": { "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "RESOURCE_TYPE_TABLE", "RESOURCE_TYPE_PARTITION" ], "type": "string", "description": "Optional. Resource type.", "enumDescriptions": [ "Default value.", "Table resource type.", "Partition resource type." ] }, "hierarchyDetail": { "description": "Optional. Details about the hierarchy.", "$ref": "HierarchyDetail" }, "name": { "description": "Identifier. Resource name.", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. Time when the resource was last updated.", "readOnly": true, "format": "google-datetime" }, "latestRun": { "description": "Optional. Run details for the latest run.", "$ref": "TransferRunBrief" }, "latestStatusDetail": { "description": "Optional. Status details for the latest run.", "$ref": "TransferResourceStatusDetail" }, "lastSuccessfulRun": { "description": "Output only. Run details for the last successful run.", "$ref": "TransferRunBrief", "readOnly": true }, "destination": { "description": "Optional. Resource destination.", "enumDescriptions": [ "Default value.", "BigQuery.", "Dataproc Metastore.", "BigLake Metastore.", "BigLake REST Catalog.", "BigLake Hive Catalog." ], "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" ], "type": "string" } }, "id": "TransferResource", "description": "Resource (table/partition) that is being transferred." }, "ScheduleTransferRunsResponse": { "id": "ScheduleTransferRunsResponse", "description": "A response to schedule transfer runs for a time range.", "properties": { "runs": { "type": "array", "items": { "$ref": "TransferRun" }, "description": "The transfer runs that were scheduled." } }, "type": "object" }, "PartitionDetail": { "id": "PartitionDetail", "description": "Partition details related to hierarchy.", "properties": { "table": { "type": "string", "description": "Optional. Name of the table which has the partitions." } }, "type": "object" }, "ListTransferLogsResponse": { "id": "ListTransferLogsResponse", "description": "The returned list transfer run messages.", "properties": { "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" }, "transferMessages": { "type": "array", "items": { "$ref": "TransferMessage" }, "description": "Output only. The stored pipeline transfer messages.", "readOnly": true } }, "type": "object" }, "DataSourceParameter": { "id": "DataSourceParameter", "description": "A parameter used to define custom fields in a data source definition.", "properties": { "minValue": { "type": "number", "description": "For integer and double values specifies minimum allowed value.", "format": "double" }, "deprecated": { "description": "If true, it should not be used in new transfers, and it should not be visible to users.", "type": "boolean" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "RECORD", "PLUS_PAGE", "LIST" ], "description": "Parameter type.", "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." ] }, "validationDescription": { "type": "string", "description": "Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values." }, "paramId": { "description": "Parameter identifier.", "type": "string" }, "description": { "description": "Parameter description.", "type": "string" }, "required": { "type": "boolean", "description": "Is parameter required." }, "fields": { "description": "Deprecated. This field has no effect.", "type": "array", "items": { "$ref": "DataSourceParameter" } }, "allowedValues": { "description": "All possible values for the parameter.", "type": "array", "items": { "type": "string" } }, "immutable": { "type": "boolean", "description": "Cannot be changed after initial creation." }, "validationHelpUrl": { "description": "URL to a help document to further explain the naming requirements.", "type": "string" }, "displayName": { "description": "Parameter display name in the user interface.", "type": "string" }, "maxListSize": { "format": "int64", "description": "For list parameters, the max size of the list.", "type": "string" }, "recurse": { "description": "Deprecated. This field has no effect.", "type": "boolean" }, "repeated": { "description": "Deprecated. This field has no effect.", "type": "boolean" }, "validationRegex": { "type": "string", "description": "Regular expression which can be used for parameter validation." }, "maxValue": { "type": "number", "format": "double", "description": "For integer and double values specifies maximum allowed value." } }, "type": "object" }, "ListTransferRunsResponse": { "type": "object", "properties": { "transferRuns": { "type": "array", "items": { "$ref": "TransferRun" }, "description": "Output only. The stored pipeline transfer runs.", "readOnly": true }, "nextPageToken": { "readOnly": true, "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.", "type": "string" } }, "id": "ListTransferRunsResponse", "description": "The returned list of pipelines in the project." }, "ListLocationsResponse": { "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "type": "object", "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations." }, "StartManualTransferRunsRequest": { "id": "StartManualTransferRunsRequest", "description": "A request to start manual transfer runs.", "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": { "type": "string", "format": "google-datetime", "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": "object" }, "StartManualTransferRunsResponse": { "id": "StartManualTransferRunsResponse", "description": "A response to start manual transfer runs.", "type": "object", "properties": { "runs": { "type": "array", "items": { "$ref": "TransferRun" }, "description": "The transfer runs that were created." } } }, "TimeRange": { "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).", "type": "object", "properties": { "startTime": { "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).", "format": "google-datetime" }, "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" } } }, "TransferResourceStatusDetail": { "id": "TransferResourceStatusDetail", "description": "Status details of the resource being transferred.", "properties": { "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." ] }, "completedPercentage": { "description": "Output only. Percentage of the transfer completed. Valid values: 0-100.", "readOnly": true, "format": "double", "type": "number" }, "summary": { "description": "Optional. Transfer status summary of the resource.", "$ref": "TransferStatusSummary" }, "error": { "description": "Optional. Transfer error details for the resource.", "$ref": "Status" } }, "type": "object" }, "ManualSchedule": { "properties": {}, "type": "object", "id": "ManualSchedule", "description": "Options customizing manual transfers schedule." }, "TimeBasedSchedule": { "properties": { "schedule": { "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": "string" }, "startTime": { "format": "google-datetime", "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.", "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "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." } }, "type": "object", "id": "TimeBasedSchedule", "description": "Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message." }, "Empty": { "id": "Empty", "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", "properties": {} }, "TransferStatusMetric": { "properties": { "unit": { "description": "Optional. Unit for measuring progress (e.g., BYTES).", "enumDescriptions": [ "Default value.", "Bytes.", "Objects." ], "enum": [ "TRANSFER_STATUS_UNIT_UNSPECIFIED", "TRANSFER_STATUS_UNIT_BYTES", "TRANSFER_STATUS_UNIT_OBJECTS" ], "type": "string" }, "failed": { "type": "string", "format": "int64", "description": "Optional. Number of units that failed to transfer." }, "completed": { "type": "string", "description": "Optional. Number of units transferred successfully.", "format": "int64" }, "total": { "description": "Optional. Total number of units for the transfer.", "format": "int64", "type": "string" }, "pending": { "type": "string", "description": "Optional. Number of units pending transfer.", "format": "int64" } }, "type": "object", "id": "TransferStatusMetric", "description": "Metrics for tracking the transfer status." }, "EmailPreferences": { "id": "EmailPreferences", "description": "Represents preferences for sending email notifications for transfer run events.", "properties": { "enableFailureEmail": { "description": "If true, email notifications will be sent on transfer run failures.", "type": "boolean" } }, "type": "object" }, "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": {} } }, "protocol": "rest" }