{ "kind": "discovery#restDescription", "version": "v1", "description": "Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.", "ownerDomain": "google.com", "discoveryVersion": "v1", "endpoints": [ { "endpointUrl": "https://bigquerydatatransfer.asia-south1.rep.googleapis.com/", "location": "asia-south1", "description": "Regional Endpoint" }, { "location": "asia-south2", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.asia-south2.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.europe-west1.rep.googleapis.com/", "location": "europe-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://bigquerydatatransfer.europe-west2.rep.googleapis.com/", "location": "europe-west2", "description": "Regional Endpoint" }, { "location": "europe-west3", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west3.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.europe-west4.rep.googleapis.com/", "location": "europe-west4", "description": "Regional Endpoint" }, { "location": "europe-west6", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west6.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.europe-west8.rep.googleapis.com/", "location": "europe-west8", "description": "Regional Endpoint" }, { "location": "europe-west9", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west9.rep.googleapis.com/" }, { "location": "me-central2", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.me-central2.rep.googleapis.com/" }, { "location": "northamerica-northeast1", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.northamerica-northeast1.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2", "description": "Regional Endpoint" }, { "location": "us-central1", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-central1.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.us-central2.rep.googleapis.com/", "location": "us-central2", "description": "Regional Endpoint" }, { "location": "us-east1", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-east1.rep.googleapis.com/" }, { "location": "us-east4", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-east4.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.us-east5.rep.googleapis.com/", "location": "us-east5", "description": "Regional Endpoint" }, { "location": "us-east7", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-east7.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.us-south1.rep.googleapis.com/", "location": "us-south1", "description": "Regional Endpoint" }, { "location": "us-west1", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-west1.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.us-west2.rep.googleapis.com/", "location": "us-west2", "description": "Regional Endpoint" }, { "endpointUrl": "https://bigquerydatatransfer.us-west3.rep.googleapis.com/", "location": "us-west3", "description": "Regional Endpoint" }, { "location": "us-west4", "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-west4.rep.googleapis.com/" }, { "endpointUrl": "https://bigquerydatatransfer.us-west8.rep.googleapis.com/", "location": "us-west8", "description": "Regional Endpoint" } ], "title": "BigQuery Data Transfer API", "baseUrl": "https://bigquerydatatransfer.googleapis.com/", "parameters": { "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "alt": { "default": "json", "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" ], "description": "Data format for response.", "type": "string", "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" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "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" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "$.xgafv": { "location": "query", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "type": "string" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query", "type": "boolean" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" } }, "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." } } } }, "ownerName": "Google", "id": "bigquerydatatransfer:v1", "mtlsRootUrl": "https://bigquerydatatransfer.mtls.googleapis.com/", "name": "bigquerydatatransfer", "version_module": true, "canonicalName": "BigQuery Data Transfer", "resources": { "projects": { "methods": { "enrollDataSources": { "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}:enrollDataSources", "path": "v1/{+name}:enrollDataSources", "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).", "parameters": { "name": { "required": true, "location": "path", "description": "Required. The name of the project resource in the form: `projects/{project_id}`", "pattern": "^projects/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "EnrollDataSourcesRequest" }, "response": { "$ref": "Empty" }, "id": "bigquerydatatransfer.projects.enrollDataSources", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "locations": { "methods": { "enrollDataSources": { "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:enrollDataSources", "path": "v1/{+name}:enrollDataSources", "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).", "parameters": { "name": { "type": "string", "description": "Required. The name of the project resource in the form: `projects/{project_id}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "request": { "$ref": "EnrollDataSourcesRequest" }, "response": { "$ref": "Empty" }, "id": "bigquerydatatransfer.projects.locations.enrollDataSources", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "unenrollDataSources": { "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.locations.unenrollDataSources", "path": "v1/{+name}:unenrollDataSources", "description": "Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the [BigQuery UI](https://console.cloud.google.com/bigquery). Data transfers configurations of unenrolled data sources will not be scheduled.", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the project resource in the form: `projects/{project_id}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "UnenrollDataSourcesRequest" }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:unenrollDataSources" }, "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" }, "extraLocationTypes": { "repeated": true, "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "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" }, "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "type": "string", "required": true, "location": "path" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}/locations", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "id": "bigquerydatatransfer.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" ], "response": { "$ref": "ListLocationsResponse" }, "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET" }, "get": { "response": { "$ref": "Location" }, "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", "path": "v1/{+name}", "description": "Gets information about a location.", "parameters": { "name": { "type": "string", "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}" } }, "resources": { "dataSources": { "methods": { "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources", "response": { "$ref": "ListDataSourcesResponse" }, "id": "bigquerydatatransfer.projects.locations.dataSources.list", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1/{+parent}/dataSources", "description": "Lists supported data sources and returns their settings.", "parameters": { "parent": { "type": "string", "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}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" }, "pageSize": { "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32", "type": "integer" }, "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" } }, "parameterOrder": [ "parent" ] }, "get": { "path": "v1/{+name}", "description": "Retrieves a supported data source and returns its settings.", "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}/dataSources/{data_source_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "DataSource" }, "id": "bigquerydatatransfer.projects.locations.dataSources.get", "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", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}" }, "checkValidCreds": { "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds", "response": { "$ref": "CheckValidCredsResponse" }, "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1/{+name}:checkValidCreds", "description": "Returns true if valid credentials exist for the given data source and requesting user.", "parameters": { "name": { "required": true, "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CheckValidCredsRequest" } } } }, "transferConfigs": { "methods": { "delete": { "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", "response": { "$ref": "Empty" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "description": "Deletes a data transfer configuration, including any associated transfer runs and logs.", "parameters": { "name": { "location": "path", "required": true, "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$" } }, "parameterOrder": [ "name" ] }, "create": { "path": "v1/{+parent}/transferConfigs", "description": "Creates a new data transfer configuration.", "parameters": { "serviceAccountName": { "description": "Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).", "location": "query", "type": "string" }, "authorizationCode": { "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 create the transfer config.", "location": "query", "deprecated": true }, "parent": { "required": true, "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.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "versionInfo": { "description": "Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "TransferConfig" }, "response": { "$ref": "TransferConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.create", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs" }, "list": { "response": { "$ref": "ListTransferConfigsResponse" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.list", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1/{+parent}/transferConfigs", "description": "Returns information about all transfer configs owned by a project in the specified location.", "parameters": { "parent": { "type": "string", "description": "Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must be `US` and `parent` should be in the following form: * `projects/{project_id} If you are using the regionalized method, `parent` should be in the following form: * `projects/{project_id}/locations/{location_id}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true }, "pageSize": { "type": "integer", "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32" }, "dataSourceIds": { "description": "When specified, only configurations of requested data sources are returned.", "location": "query", "type": "string", "repeated": true }, "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" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs" }, "scheduleRuns": { "parameters": { "parent": { "required": true, "location": "path", "type": "string", "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "ScheduleTransferRunsRequest" }, "deprecated": true, "path": "v1/{+parent}:scheduleRuns", "description": "Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns", "response": { "$ref": "ScheduleTransferRunsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns", "httpMethod": "POST" }, "startManualRuns": { "response": { "$ref": "StartManualTransferRunsResponse" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}:startManualRuns", "description": "Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each.", "parameters": { "parent": { "required": true, "location": "path", "type": "string", "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "StartManualTransferRunsRequest" }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns" }, "get": { "path": "v1/{+name}", "description": "Returns information about a data transfer config.", "parameters": { "name": { "type": "string", "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "TransferConfig" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.get", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}" }, "patch": { "path": "v1/{+name}", "description": "Updates a data transfer configuration. All fields must be set, even if they are not updated.", "parameters": { "updateMask": { "type": "string", "description": "Required. Required list of fields to be updated in this request.", "location": "query", "format": "google-fieldmask" }, "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" }, "authorizationCode": { "deprecated": true, "type": "string", "description": "Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", "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" }, "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.", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "request": { "$ref": "TransferConfig" }, "response": { "$ref": "TransferConfig" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}" } }, "resources": { "transferResources": { "methods": { "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/transferResources/{transferResourcesId}", "httpMethod": "GET", "id": "bigquerydatatransfer.projects.locations.transferConfigs.transferResources.get", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "TransferResource" }, "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/transferResources/[^/]+$", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "description": "Returns a transfer resource." }, "list": { "id": "bigquerydatatransfer.projects.locations.transferConfigs.transferResources.list", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "ListTransferResourcesResponse" }, "parameters": { "parent": { "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "type": "string", "location": "path", "required": true }, "pageSize": { "type": "integer", "description": "Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32" }, "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": { "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", "type": "string" } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/transferResources", "description": "Returns information about transfer resources.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/transferResources", "httpMethod": "GET" } } }, "runs": { "methods": { "delete": { "response": { "$ref": "Empty" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "description": "Deletes the specified transfer run.", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}" }, "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs", "response": { "$ref": "ListTransferRunsResponse" }, "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1/{+parent}/runs", "description": "Returns information about running and completed transfer runs.", "parameters": { "parent": { "required": true, "location": "path", "description": "Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "type": "string" }, "pageSize": { "type": "integer", "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32" }, "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": { "description": "Indicates how run attempts are to be pulled.", "type": "string", "enumDescriptions": [ "All runs should be returned.", "Only latest run per day should be returned." ], "enum": [ "RUN_ATTEMPT_UNSPECIFIED", "LATEST" ], "location": "query" }, "states": { "location": "query", "repeated": true, "type": "string", "description": "When specified, only transfer runs with requested states are returned.", "enumDescriptions": [ "State placeholder (0).", "Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).", "Data transfer is in progress (3).", "Data transfer completed successfully (4).", "Data transfer failed (5).", "Data transfer is cancelled (6)." ], "enum": [ "TRANSFER_STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ] } }, "parameterOrder": [ "parent" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "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.transferConfigs.runs.get", "response": { "$ref": "TransferRun" }, "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "description": "Returns information about the particular transfer run." } }, "resources": { "transferLogs": { "methods": { "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs", "response": { "$ref": "ListTransferLogsResponse" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list", "path": "v1/{+parent}/transferLogs", "description": "Returns log messages for the transfer run.", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. Transfer run name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string" }, "pageSize": { "type": "integer", "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32" }, "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" }, "messageTypes": { "enumDescriptions": [ "No severity specified.", "Informational message.", "Warning message.", "Error message." ], "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "type": "string", "description": "Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.", "repeated": true, "location": "query" } }, "parameterOrder": [ "parent" ] } } } } } } } } }, "transferConfigs": { "methods": { "delete": { "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "response": { "$ref": "Empty" }, "id": "bigquerydatatransfer.projects.transferConfigs.delete", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "description": "Deletes a data transfer configuration, including any associated transfer runs and logs.", "parameters": { "name": { "location": "path", "required": true, "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}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" } }, "parameterOrder": [ "name" ] }, "create": { "flatPath": "v1/projects/{projectsId}/transferConfigs", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.transferConfigs.create", "response": { "$ref": "TransferConfig" }, "parameters": { "parent": { "description": "Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.", "pattern": "^projects/[^/]+$", "type": "string", "location": "path", "required": true }, "versionInfo": { "description": "Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", "location": "query", "type": "string" }, "serviceAccountName": { "description": "Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).", "location": "query", "type": "string" }, "authorizationCode": { "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.", "location": "query", "type": "string", "deprecated": true } }, "parameterOrder": [ "parent" ], "request": { "$ref": "TransferConfig" }, "path": "v1/{+parent}/transferConfigs", "description": "Creates a new data transfer configuration." }, "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/transferConfigs", "response": { "$ref": "ListTransferConfigsResponse" }, "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.transferConfigs.list", "path": "v1/{+parent}/transferConfigs", "description": "Returns information about all transfer configs owned by a project in the specified location.", "parameters": { "dataSourceIds": { "repeated": true, "type": "string", "description": "When specified, only configurations of requested data sources are returned.", "location": "query" }, "pageToken": { "type": "string", "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" }, "parent": { "required": true, "location": "path", "type": "string", "description": "Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must be `US` and `parent` should be in the following form: * `projects/{project_id} If you are using the regionalized method, `parent` should be in the following form: * `projects/{project_id}/locations/{location_id}`", "pattern": "^projects/[^/]+$" }, "pageSize": { "type": "integer", "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32" } }, "parameterOrder": [ "parent" ] }, "scheduleRuns": { "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "location": "path", "required": true } }, "parameterOrder": [ "parent" ], "request": { "$ref": "ScheduleTransferRunsRequest" }, "deprecated": true, "path": "v1/{+parent}:scheduleRuns", "description": "Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.", "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ScheduleTransferRunsResponse" } }, "startManualRuns": { "response": { "$ref": "StartManualTransferRunsResponse" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.transferConfigs.startManualRuns", "path": "v1/{+parent}:startManualRuns", "description": "Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each.", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "StartManualTransferRunsRequest" }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns" }, "patch": { "parameters": { "authorizationCode": { "deprecated": true, "type": "string", "description": "Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", "location": "query" }, "updateMask": { "description": "Required. Required list of fields to be updated in this request.", "location": "query", "format": "google-fieldmask", "type": "string" }, "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" }, "name": { "required": true, "location": "path", "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.", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "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" } }, "parameterOrder": [ "name" ], "request": { "$ref": "TransferConfig" }, "path": "v1/{+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" ], "id": "bigquerydatatransfer.projects.transferConfigs.patch", "response": { "$ref": "TransferConfig" }, "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "httpMethod": "PATCH" }, "get": { "id": "bigquerydatatransfer.projects.transferConfigs.get", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "TransferConfig" }, "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}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "description": "Returns information about a data transfer config.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", "httpMethod": "GET" } }, "resources": { "runs": { "methods": { "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs", "response": { "$ref": "ListTransferRunsResponse" }, "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.transferConfigs.runs.list", "path": "v1/{+parent}/runs", "description": "Returns information about running and completed transfer runs.", "parameters": { "states": { "enumDescriptions": [ "State placeholder (0).", "Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).", "Data transfer is in progress (3).", "Data transfer completed successfully (4).", "Data transfer failed (5).", "Data transfer is cancelled (6)." ], "enum": [ "TRANSFER_STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "description": "When specified, only transfer runs with requested states are returned.", "type": "string", "repeated": true, "location": "query" }, "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": { "enumDescriptions": [ "All runs should be returned.", "Only latest run per day should be returned." ], "enum": [ "RUN_ATTEMPT_UNSPECIFIED", "LATEST" ], "type": "string", "description": "Indicates how run attempts are to be pulled.", "location": "query" }, "parent": { "location": "path", "required": true, "description": "Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "type": "string" }, "pageSize": { "type": "integer", "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32" } }, "parameterOrder": [ "parent" ] }, "delete": { "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "path": "v1/{+name}", "description": "Deletes the specified transfer run.", "parameters": { "name": { "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ], "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete" }, "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.transferConfigs.runs.get", "response": { "$ref": "TransferRun" }, "parameters": { "name": { "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}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "description": "Returns information about the particular transfer run.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", "httpMethod": "GET" } }, "resources": { "transferLogs": { "methods": { "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs", "response": { "$ref": "ListTransferLogsResponse" }, "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1/{+parent}/transferLogs", "description": "Returns log messages for the transfer run.", "parameters": { "pageToken": { "type": "string", "description": "Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.", "location": "query" }, "messageTypes": { "repeated": true, "location": "query", "enumDescriptions": [ "No severity specified.", "Informational message.", "Warning message.", "Error message." ], "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "type": "string", "description": "Message types to return. If not populated - INFO, WARNING and ERROR messages are returned." }, "parent": { "required": true, "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}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "type": "string" }, "pageSize": { "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32", "type": "integer" } }, "parameterOrder": [ "parent" ] } } } } }, "transferResources": { "methods": { "get": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/transferResources/{transferResourcesId}", "response": { "$ref": "TransferResource" }, "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.transferConfigs.transferResources.get", "path": "v1/{+name}", "description": "Returns a transfer resource.", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. The name of the transfer resource in the form of: * `projects/{project}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` * `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/transferResources/[^/]+$" } }, "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/transferResources", "response": { "$ref": "ListTransferResourcesResponse" }, "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.transferConfigs.transferResources.list", "path": "v1/{+parent}/transferResources", "description": "Returns information about transfer resources.", "parameters": { "parent": { "required": true, "location": "path", "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}`", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" }, "pageSize": { "description": "Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32", "type": "integer" }, "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": { "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" } }, "parameterOrder": [ "parent" ] } } } } }, "dataSources": { "methods": { "get": { "response": { "$ref": "DataSource" }, "id": "bigquerydatatransfer.projects.dataSources.get", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1/{+name}", "description": "Retrieves a supported data source and returns its settings.", "parameters": { "name": { "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}`", "pattern": "^projects/[^/]+/dataSources/[^/]+$", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}" }, "checkValidCreds": { "parameters": { "name": { "description": "Required. The name of the data source. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/dataSources/{data_source_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", "pattern": "^projects/[^/]+/dataSources/[^/]+$", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CheckValidCredsRequest" }, "path": "v1/{+name}:checkValidCreds", "description": "Returns true if valid credentials exist for the given data source and requesting user.", "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "CheckValidCredsResponse" }, "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds", "httpMethod": "POST" }, "list": { "flatPath": "v1/projects/{projectsId}/dataSources", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "bigquerydatatransfer.projects.dataSources.list", "response": { "$ref": "ListDataSourcesResponse" }, "parameters": { "parent": { "type": "string", "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}`", "pattern": "^projects/[^/]+$", "location": "path", "required": true }, "pageSize": { "type": "integer", "description": "Page size. The default page size is the maximum value of 1000 results.", "location": "query", "format": "int32" }, "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" } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/dataSources", "description": "Lists supported data sources and returns their settings." } } } } } }, "protocol": "rest", "servicePath": "", "revision": "20260406", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "documentationLink": "https://cloud.google.com/bigquery-transfer/", "basePath": "", "schemas": { "TransferConfig": { "type": "object", "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.", "properties": { "state": { "readOnly": true, "enumDescriptions": [ "State placeholder (0).", "Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).", "Data transfer is in progress (3).", "Data transfer completed successfully (4).", "Data transfer failed (5).", "Data transfer is cancelled (6)." ], "enum": [ "TRANSFER_STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "description": "Output only. State of the most recently updated transfer run.", "type": "string" }, "nextRunTime": { "type": "string", "description": "Output only. Next time when data transfer will run.", "format": "google-datetime", "readOnly": true }, "ownerInfo": { "description": "Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.", "readOnly": true, "$ref": "UserInfo" }, "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" }, "managedTableType": { "description": "The classification of the destination table.", "type": "string", "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." ], "enum": [ "MANAGED_TABLE_TYPE_UNSPECIFIED", "NATIVE", "BIGLAKE" ] }, "destinationDatasetId": { "description": "The BigQuery target dataset id.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Data transfer modification time. Ignored by server on input.", "format": "google-datetime", "type": "string" }, "datasetRegion": { "readOnly": true, "description": "Output only. Region in which BigQuery dataset is located.", "type": "string" }, "notificationPubsubTopic": { "type": "string", "description": "Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`" }, "scheduleOptions": { "$ref": "ScheduleOptions", "description": "Options customizing the data transfer schedule." }, "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" }, "dataRefreshWindowDays": { "type": "integer", "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.", "format": "int32" }, "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" }, "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" }, "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." } }, "error": { "$ref": "Status", "readOnly": true, "description": "Output only. Error code with detailed information about reason of the latest config failure." }, "scheduleOptionsV2": { "description": "Options customizing different types of data transfer schedule. This field replaces \"schedule\" and \"schedule_options\" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.", "$ref": "ScheduleOptionsV2" }, "disabled": { "type": "boolean", "description": "Is this config disabled. When set to true, no runs will be scheduled for this transfer config." }, "userId": { "description": "Deprecated. Unique ID of the user on whose behalf transfer is done.", "format": "int64", "type": "string" }, "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." }, "displayName": { "type": "string", "description": "User specified display name for the data transfer." } }, "id": "TransferConfig" }, "ScheduleTransferRunsResponse": { "type": "object", "description": "A response to schedule transfer runs for a time range.", "properties": { "runs": { "description": "The transfer runs that were scheduled.", "type": "array", "items": { "$ref": "TransferRun" } } }, "id": "ScheduleTransferRunsResponse" }, "Location": { "properties": { "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" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "type": "object", "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" } }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" } }, "id": "Location", "type": "object", "description": "A resource that represents a Google Cloud location." }, "TableDetail": { "description": "Table details related to hierarchy.", "type": "object", "id": "TableDetail", "properties": { "partitionCount": { "type": "string", "description": "Optional. Total number of partitions being tracked within the table.", "format": "int64" } } }, "HierarchyDetail": { "description": "Details about the hierarchy.", "type": "object", "id": "HierarchyDetail", "properties": { "tableDetail": { "$ref": "TableDetail", "description": "Optional. Table details related to hierarchy." }, "partitionDetail": { "description": "Optional. Partition details related to hierarchy.", "$ref": "PartitionDetail" } } }, "CheckValidCredsResponse": { "description": "A response indicating whether the credentials exist and are valid.", "type": "object", "id": "CheckValidCredsResponse", "properties": { "hasValidCreds": { "description": "If set to `true`, the credentials exist and are valid.", "type": "boolean" } } }, "EmailPreferences": { "id": "EmailPreferences", "properties": { "enableFailureEmail": { "type": "boolean", "description": "If true, email notifications will be sent on transfer run failures." } }, "description": "Represents preferences for sending email notifications for transfer run events.", "type": "object" }, "ListTransferRunsResponse": { "properties": { "transferRuns": { "description": "Output only. The stored pipeline transfer runs.", "type": "array", "readOnly": true, "items": { "$ref": "TransferRun" } }, "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", "type": "object", "description": "The returned list of pipelines in the project." }, "ScheduleOptions": { "description": "Options customizing the data transfer schedule.", "type": "object", "id": "ScheduleOptions", "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" }, "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" }, "endTime": { "type": "string", "description": "Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.", "format": "google-datetime" } } }, "StartManualTransferRunsResponse": { "type": "object", "description": "A response to start manual transfer runs.", "properties": { "runs": { "description": "The transfer runs that were created.", "type": "array", "items": { "$ref": "TransferRun" } } }, "id": "StartManualTransferRunsResponse" }, "TransferResource": { "type": "object", "description": "Resource (table/partition) that is being transferred.", "properties": { "latestStatusDetail": { "$ref": "TransferResourceStatusDetail", "description": "Optional. Status details for the latest run." }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. Time when the resource was last updated.", "format": "google-datetime" }, "hierarchyDetail": { "$ref": "HierarchyDetail", "description": "Optional. Details about the hierarchy." }, "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" ], "description": "Optional. Resource destination.", "type": "string" }, "latestRun": { "description": "Optional. Run details for the latest run.", "$ref": "TransferRunBrief" }, "type": { "description": "Optional. Resource type.", "type": "string", "enumDescriptions": [ "Default value.", "Table resource type.", "Partition resource type." ], "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "RESOURCE_TYPE_TABLE", "RESOURCE_TYPE_PARTITION" ] }, "lastSuccessfulRun": { "$ref": "TransferRunBrief", "readOnly": true, "description": "Output only. Run details for the last successful run." }, "name": { "description": "Identifier. Resource name.", "type": "string" } }, "id": "TransferResource" }, "ScheduleOptionsV2": { "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" }, "timeBasedSchedule": { "description": "Time based transfer schedule options. This is the default schedule option.", "$ref": "TimeBasedSchedule" }, "eventDrivenSchedule": { "$ref": "EventDrivenSchedule", "description": "Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial." } }, "id": "ScheduleOptionsV2", "type": "object", "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." }, "ScheduleTransferRunsRequest": { "type": "object", "description": "A request to schedule transfer runs for a time range.", "properties": { "startTime": { "type": "string", "description": "Required. Start time of the range of transfer runs. For example, `\"2017-05-25T00:00:00+00:00\"`.", "format": "google-datetime" }, "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" } }, "id": "ScheduleTransferRunsRequest" }, "TransferMessage": { "description": "Represents a user facing message for a particular data transfer run.", "type": "object", "id": "TransferMessage", "properties": { "severity": { "enumDescriptions": [ "No severity specified.", "Informational message.", "Warning message.", "Error message." ], "enum": [ "MESSAGE_SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR" ], "description": "Message severity.", "type": "string" }, "messageTime": { "type": "string", "description": "Time when message was logged.", "format": "google-datetime" }, "messageText": { "type": "string", "description": "Message text." } } }, "EnrollDataSourcesRequest": { "id": "EnrollDataSourcesRequest", "properties": { "dataSourceIds": { "items": { "type": "string" }, "type": "array", "description": "Data sources that are enrolled. It is required to provide at least one data source id." } }, "description": "A request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab.", "type": "object" }, "UnenrollDataSourcesRequest": { "properties": { "dataSourceIds": { "type": "array", "description": "Data sources that are unenrolled. It is required to provide at least one data source id.", "items": { "type": "string" } } }, "id": "UnenrollDataSourcesRequest", "type": "object", "description": "A request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's `Transfer` tab." }, "ListTransferLogsResponse": { "type": "object", "description": "The returned list transfer run messages.", "properties": { "transferMessages": { "readOnly": true, "items": { "$ref": "TransferMessage" }, "description": "Output only. The stored pipeline transfer messages.", "type": "array" }, "nextPageToken": { "readOnly": true, "type": "string", "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." } }, "id": "ListTransferLogsResponse" }, "ListLocationsResponse": { "properties": { "locations": { "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request.", "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "id": "ListLocationsResponse", "type": "object", "description": "The response message for Locations.ListLocations." }, "ListDataSourcesResponse": { "type": "object", "description": "Returns list of supported data sources and their metadata.", "properties": { "dataSources": { "items": { "$ref": "DataSource" }, "type": "array", "description": "List of supported data sources and their transfer settings." }, "nextPageToken": { "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.", "type": "string", "readOnly": true } }, "id": "ListDataSourcesResponse" }, "TransferRunBrief": { "id": "TransferRunBrief", "properties": { "startTime": { "description": "Optional. Start time of the transfer run.", "format": "google-datetime", "type": "string" }, "run": { "type": "string", "description": "Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}`" } }, "description": "Basic information about a transfer run.", "type": "object" }, "StartManualTransferRunsRequest": { "properties": { "requestedTimeRange": { "description": "A time_range start and end timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_time_range must be a past time and cannot include future time values.", "$ref": "TimeRange" }, "requestedRunTime": { "description": "A run_time timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_run_time must be a past time and cannot include future time values.", "format": "google-datetime", "type": "string" } }, "id": "StartManualTransferRunsRequest", "type": "object", "description": "A request to start manual transfer runs." }, "ListTransferResourcesResponse": { "type": "object", "description": "Response for the `ListTransferResources` RPC.", "properties": { "nextPageToken": { "type": "string", "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 }, "transferResources": { "readOnly": true, "items": { "$ref": "TransferResource" }, "type": "array", "description": "Output only. The transfer resources." } }, "id": "ListTransferResourcesResponse" }, "DataSource": { "properties": { "updateDeadlineSeconds": { "description": "The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.", "format": "int32", "type": "integer" }, "helpUrl": { "description": "Url for the help document for this data source.", "type": "string" }, "defaultDataRefreshWindowDays": { "description": "Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.", "format": "int32", "type": "integer" }, "transferType": { "description": "Deprecated. This field has no effect.", "type": "string", "deprecated": true, "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." ], "enum": [ "TRANSFER_TYPE_UNSPECIFIED", "BATCH", "STREAMING" ] }, "parameters": { "items": { "$ref": "DataSourceParameter" }, "type": "array", "description": "Data source parameters." }, "description": { "type": "string", "description": "User friendly data source description string." }, "dataRefreshType": { "description": "Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.", "type": "string", "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." ], "enum": [ "DATA_REFRESH_TYPE_UNSPECIFIED", "SLIDING_WINDOW", "CUSTOM_SLIDING_WINDOW" ] }, "clientId": { "type": "string", "description": "Data source client id which should be used to receive refresh token." }, "supportsMultipleTransfers": { "description": "Deprecated. This field has no effect.", "type": "boolean", "deprecated": true }, "dataSourceId": { "type": "string", "description": "Data source id." }, "displayName": { "type": "string", "description": "User friendly data source name." }, "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" }, "name": { "readOnly": true, "type": "string", "description": "Output only. Data source resource name." }, "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" } }, "manualRunsDisabled": { "type": "boolean", "description": "Disables backfilling and manual run scheduling for the data source." }, "minimumScheduleInterval": { "type": "string", "description": "The minimum interval for scheduler to schedule runs.", "format": "google-duration" }, "supportsCustomSchedule": { "type": "boolean", "description": "Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule." }, "authorizationType": { "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." ], "enum": [ "AUTHORIZATION_TYPE_UNSPECIFIED", "AUTHORIZATION_CODE", "GOOGLE_PLUS_AUTHORIZATION_CODE", "FIRST_PARTY_OAUTH" ] } }, "id": "DataSource", "type": "object", "description": "Defines the properties and custom parameters for a data source." }, "ManualSchedule": { "description": "Options customizing manual transfers schedule.", "type": "object", "id": "ManualSchedule", "properties": {} }, "UserInfo": { "id": "UserInfo", "properties": { "email": { "description": "E-mail address of the user.", "type": "string" } }, "description": "Information about a user.", "type": "object" }, "TransferRun": { "id": "TransferRun", "properties": { "runTime": { "description": "For batch transfer runs, specifies the date and time of the data should be ingested.", "format": "google-datetime", "type": "string" }, "scheduleTime": { "type": "string", "description": "Minimum time after which a transfer run can be started.", "format": "google-datetime" }, "updateTime": { "readOnly": true, "description": "Output only. Last time the data transfer run state was updated.", "format": "google-datetime", "type": "string" }, "destinationDatasetId": { "description": "Output only. The BigQuery target dataset id.", "type": "string", "readOnly": true }, "notificationPubsubTopic": { "readOnly": true, "description": "Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`", "type": "string" }, "schedule": { "type": "string", "description": "Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.", "readOnly": true }, "state": { "enumDescriptions": [ "State placeholder (0).", "Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).", "Data transfer is in progress (3).", "Data transfer completed successfully (4).", "Data transfer failed (5).", "Data transfer is cancelled (6)." ], "enum": [ "TRANSFER_STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string", "description": "Data transfer run state. Ignored for input requests." }, "name": { "description": "Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.", "type": "string" }, "endTime": { "description": "Output only. Time when transfer run ended. Parameter ignored by server for input requests.", "format": "google-datetime", "type": "string", "readOnly": true }, "startTime": { "readOnly": true, "type": "string", "description": "Output only. Time when transfer run was started. Parameter ignored by server for input requests.", "format": "google-datetime" }, "userId": { "description": "Deprecated. Unique ID of the user on whose behalf transfer is done.", "format": "int64", "type": "string" }, "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." }, "type": "object", "readOnly": true }, "dataSourceId": { "description": "Output only. Data source id.", "type": "string", "readOnly": true }, "errorStatus": { "description": "Status of the transfer run.", "$ref": "Status" }, "emailPreferences": { "readOnly": true, "$ref": "EmailPreferences", "description": "Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from." } }, "description": "Represents a data transfer run.", "type": "object" }, "EventDrivenSchedule": { "description": "Options customizing EventDriven transfers schedule.", "type": "object", "id": "EventDrivenSchedule", "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" } } }, "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", "id": "TimeRange", "properties": { "startTime": { "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", "type": "string" }, "endTime": { "type": "string", "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" } } }, "TransferResourceStatusDetail": { "description": "Status details of the resource being transferred.", "type": "object", "id": "TransferResourceStatusDetail", "properties": { "state": { "type": "string", "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." ], "enum": [ "RESOURCE_TRANSFER_STATE_UNSPECIFIED", "RESOURCE_TRANSFER_PENDING", "RESOURCE_TRANSFER_RUNNING", "RESOURCE_TRANSFER_SUCCEEDED", "RESOURCE_TRANSFER_FAILED", "RESOURCE_TRANSFER_CANCELLED" ] }, "summary": { "description": "Optional. Transfer status summary of the resource.", "$ref": "TransferStatusSummary" }, "error": { "$ref": "Status", "description": "Optional. Transfer error details for the resource." }, "completedPercentage": { "readOnly": true, "description": "Output only. Percentage of the transfer completed. Valid values: 0-100.", "format": "double", "type": "number" } } }, "EncryptionConfiguration": { "description": "Represents the encryption configuration for a transfer.", "type": "object", "id": "EncryptionConfiguration", "properties": { "kmsKeyName": { "description": "The name of the KMS key used for encrypting BigQuery data.", "type": "string" } } }, "TransferStatusMetric": { "description": "Metrics for tracking the transfer status.", "type": "object", "id": "TransferStatusMetric", "properties": { "total": { "type": "string", "description": "Optional. Total number of units for the transfer.", "format": "int64" }, "completed": { "type": "string", "description": "Optional. Number of units transferred successfully.", "format": "int64" }, "pending": { "type": "string", "description": "Optional. Number of units pending transfer.", "format": "int64" }, "failed": { "type": "string", "description": "Optional. Number of units that failed to transfer.", "format": "int64" }, "unit": { "type": "string", "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" ] } } }, "PartitionDetail": { "description": "Partition details related to hierarchy.", "type": "object", "id": "PartitionDetail", "properties": { "table": { "type": "string", "description": "Optional. Name of the table which has the partitions." } } }, "DataSourceParameter": { "properties": { "displayName": { "type": "string", "description": "Parameter display name in the user interface." }, "validationRegex": { "type": "string", "description": "Regular expression which can be used for parameter validation." }, "validationHelpUrl": { "description": "URL to a help document to further explain the naming requirements.", "type": "string" }, "paramId": { "type": "string", "description": "Parameter identifier." }, "required": { "description": "Is parameter required.", "type": "boolean" }, "allowedValues": { "items": { "type": "string" }, "type": "array", "description": "All possible values for the parameter." }, "minValue": { "type": "number", "description": "For integer and double values specifies minimum allowed value.", "format": "double" }, "repeated": { "type": "boolean", "description": "Deprecated. This field has no effect." }, "description": { "description": "Parameter description.", "type": "string" }, "validationDescription": { "description": "Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.", "type": "string" }, "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." ], "enum": [ "TYPE_UNSPECIFIED", "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "RECORD", "PLUS_PAGE", "LIST" ], "type": "string", "description": "Parameter type." }, "maxListSize": { "type": "string", "description": "For list parameters, the max size of the list.", "format": "int64" }, "deprecated": { "type": "boolean", "description": "If true, it should not be used in new transfers, and it should not be visible to users." }, "recurse": { "description": "Deprecated. This field has no effect.", "type": "boolean" }, "maxValue": { "description": "For integer and double values specifies maximum allowed value.", "format": "double", "type": "number" }, "immutable": { "description": "Cannot be changed after initial creation.", "type": "boolean" }, "fields": { "description": "Deprecated. This field has no effect.", "type": "array", "items": { "$ref": "DataSourceParameter" } } }, "id": "DataSourceParameter", "type": "object", "description": "A parameter used to define custom fields in a data source definition." }, "CheckValidCredsRequest": { "id": "CheckValidCredsRequest", "properties": {}, "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" }, "TimeBasedSchedule": { "properties": { "startTime": { "type": "string", "description": "Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment.", "format": "google-datetime" }, "endTime": { "description": "Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment.", "format": "google-datetime", "type": "string" }, "schedule": { "type": "string", "description": "Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source." } }, "id": "TimeBasedSchedule", "type": "object", "description": "Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message." }, "Status": { "type": "object", "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).", "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } }, "message": { "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.", "type": "string" } }, "id": "Status" }, "ListTransferConfigsResponse": { "description": "The returned list of pipelines in the project.", "type": "object", "id": "ListTransferConfigsResponse", "properties": { "transferConfigs": { "readOnly": true, "items": { "$ref": "TransferConfig" }, "type": "array", "description": "Output only. The stored pipeline transfer configurations." }, "nextPageToken": { "description": "Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.", "type": "string", "readOnly": true } } }, "Empty": { "properties": {}, "id": "Empty", "type": "object", "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); }" }, "TransferStatusSummary": { "type": "object", "description": "Status summary of the resource being transferred.", "properties": { "metrics": { "description": "Optional. List of transfer status metrics.", "type": "array", "items": { "$ref": "TransferStatusMetric" } }, "progressUnit": { "type": "string", "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" ] } }, "id": "TransferStatusSummary" } }, "batchPath": "batch" }