2022-12-06
▼ ▲ bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list
Parameter Order: parent
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs
Parameters:
pageSize
Description: Page size. The default page size is the maximum value of 1000 results.
Type: integer
Location: query
Format: int32
pageToken
Location: query
Type: string
Description: Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
messageTypes
Enum:
Location: query
Description: Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
Repeated: Yes
Enum Descriptions:
Type: string
parent
Description: Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Description: Returns log messages for the transfer run.
Path: v1/{+parent}/transferLogs
Scopes:
▼ ▲ bigquerydatatransfer.projects.transferConfigs.runs.get
Parameters:
name
Pattern: ^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Path: v1/{+name}
HTTP Method: GET
Scopes:
Parameter Order: name
Description: Returns information about the particular transfer run.
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
▼ ▲ bigquerydatatransfer.projects.transferConfigs.runs.list
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs
Scopes:
Description: Returns information about running and completed transfer runs.
HTTP Method: GET
Parameters:
pageToken
Description: Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
Type: string
Location: query
runAttempt
Enum Descriptions:
Description: Indicates how run attempts are to be pulled.
Type: string
Enum:
Location: query
pageSize
Location: query
Type: integer
Format: int32
Description: Page size. The default page size is the maximum value of 1000 results.
parent
Location: path
Description: Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Type: string
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Required: Yes
states
Enum Descriptions:
Enum:
Location: query
Type: string
Description: When specified, only transfer runs with requested states are returned.
Repeated: Yes
Path: v1/{+parent}/runs
▼ ▲ bigquerydatatransfer.projects.transferConfigs.runs.delete
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
HTTP Method: DELETE
Description: Deletes the specified transfer run.
Path: v1/{+name}
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Type: string
Scopes:
Parameter Order: name
▼ ▲ bigquerydatatransfer.projects.transferConfigs.get
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
Type: string
Required: Yes
Description: Returns information about a data transfer config.
Parameter Order: name
Scopes:
Path: v1/{+name}
▼ ▲ bigquerydatatransfer.projects.transferConfigs.create
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/transferConfigs
Path: v1/{+parent}/transferConfigs
HTTP Method: POST
Description: Creates a new data transfer configuration.
Parameters:
authorizationCode
Type: string
Description: 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://www.gstatic.com/bigquerydatatransfer/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 a 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
versionInfo
Type: string
Location: query
Description: Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/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 a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
serviceAccountName
Description: Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
Type: string
Location: query
parent
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.
▼ ▲ bigquerydatatransfer.projects.transferConfigs.patch
Path: v1/{+name}
Parameters:
authorizationCode
Type: string
Description: 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://www.gstatic.com/bigquerydatatransfer/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 a 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
Type: string
Format: google-fieldmask
Location: query
Description: Required. Required list of fields to be updated in this request.
serviceAccountName
Description: Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
Type: string
Location: query
versionInfo
Type: string
Location: query
Description: Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/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 a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
name
Required: Yes
Type: string
Description: The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/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/[^/]+$
Location: path
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}
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
Parameter Order: name
HTTP Method: PATCH
▼ ▲ bigquerydatatransfer.projects.transferConfigs.delete
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Type: string
Location: path
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
Parameter Order: name
Scopes:
Description: Deletes a data transfer configuration, including any associated transfer runs and logs.
Path: v1/{+name}
▼ ▲ bigquerydatatransfer.projects.transferConfigs.scheduleRuns
Parameter Order: parent
Scopes:
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.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns
Parameters:
parent
Type: string
Location: path
Description: Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Required: Yes
Path: v1/{+parent}:scheduleRuns
▼ ▲ bigquerydatatransfer.projects.transferConfigs.list
Path: v1/{+parent}/transferConfigs
Scopes:
Flat Path: v1/projects/{projectsId}/transferConfigs
Parameter Order: parent
Parameters:
parent
Location: path
Type: string
Description: Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
Required: Yes
Pattern: ^projects/[^/]+$
dataSourceIds
Type: string
Description: When specified, only configurations of requested data sources are returned.
Location: query
Repeated: Yes
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.
Type: string
Location: query
pageSize
Description: Page size. The default page size is the maximum value of 1000 results.
Location: query
Format: int32
Type: integer
Description: Returns information about all transfer configs owned by a project in the specified location.
HTTP Method: GET
▼ ▲ bigquerydatatransfer.projects.transferConfigs.startManualRuns
Path: v1/{+parent}:startManualRuns
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns
Parameters:
parent
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Location: path
Required: Yes
Description: Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Type: string
HTTP Method: POST
Scopes:
Description: Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.
▼ ▲ bigquerydatatransfer.projects.locations.dataSources.get
Parameters:
name
Type: string
Location: path
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$
Parameter Order: name
Scopes:
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}
Description: Retrieves a supported data source and returns its settings.
Path: v1/{+name}
▼ ▲ bigquerydatatransfer.projects.locations.dataSources.checkValidCreds
Path: v1/{+name}:checkValidCreds
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$
Type: string
Description: Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
Parameter Order: name
HTTP Method: POST
Scopes:
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds
Description: Returns true if valid credentials exist for the given data source and requesting user.
▼ ▲ bigquerydatatransfer.projects.locations.dataSources.list
Parameter Order: parent
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources
Description: Lists supported data sources and returns their settings.
Path: v1/{+parent}/dataSources
Scopes:
Parameters:
pageSize
Type: integer
Format: int32
Description: Page size. The default page size is the maximum value of 1000 results.
Location: query
pageToken
Type: string
Location: query
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.
parent
Location: path
Description: Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.runs.delete
HTTP Method: DELETE
Scopes:
Parameter Order: name
Parameters:
name
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Location: path
Type: string
Description: Deletes the specified transfer run.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
Path: v1/{+name}
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.runs.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs
Parameters:
pageToken
Description: Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
Location: query
Type: string
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
Description: Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Location: path
Type: string
states
Location: query
Enum:
Description: When specified, only transfer runs with requested states are returned.
Type: string
Repeated: Yes
Enum Descriptions:
pageSize
Description: Page size. The default page size is the maximum value of 1000 results.
Format: int32
Type: integer
Location: query
runAttempt
Enum:
Type: string
Description: Indicates how run attempts are to be pulled.
Location: query
Enum Descriptions:
Parameter Order: parent
HTTP Method: GET
Path: v1/{+parent}/runs
Description: Returns information about running and completed transfer runs.
Scopes:
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.runs.get
Description: Returns information about the particular transfer run.
Parameters:
name
Required: Yes
Location: path
Type: string
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
Scopes:
Path: v1/{+name}
HTTP Method: GET
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list
Path: v1/{+parent}/transferLogs
Description: Returns log messages for the transfer run.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs
Scopes:
HTTP Method: GET
Parameters:
messageTypes
Type: string
Repeated: Yes
Location: query
Enum Descriptions:
Description: Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
Enum:
parent
Description: Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Type: string
Location: path
Required: Yes
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
pageSize
Description: Page size. The default page size is the maximum value of 1000 results.
Type: integer
Format: int32
Location: query
Parameter Order: parent
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.create
Description: Creates a new data transfer configuration.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs
Path: v1/{+parent}/transferConfigs
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.
Required: Yes
authorizationCode
Description: 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://www.gstatic.com/bigquerydatatransfer/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 a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
Type: string
Location: query
serviceAccountName
Location: query
Description: Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
Type: string
versionInfo
Location: query
Description: Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/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 a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
Type: string
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.delete
Parameter Order: name
Parameters:
name
Required: Yes
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
Type: string
Path: v1/{+name}
HTTP Method: DELETE
Scopes:
Description: Deletes a data transfer configuration, including any associated transfer runs and logs.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.patch
Parameters:
updateMask
Description: Required. Required list of fields to be updated in this request.
Format: google-fieldmask
Type: string
Location: query
authorizationCode
Location: query
Type: string
Description: 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://www.gstatic.com/bigquerydatatransfer/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 a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
name
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
Type: string
Description: The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
Required: Yes
Location: path
versionInfo
Location: query
Type: string
Description: Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/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 a 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.
serviceAccountName
Description: Optional service account name. 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
HTTP Method: PATCH
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}
Path: v1/{+name}
Description: Updates a data transfer configuration. All fields must be set, even if they are not updated.
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.list
Path: v1/{+parent}/transferConfigs
Scopes:
HTTP Method: GET
Description: Returns information about all transfer configs owned by a project in the specified location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs
Parameter Order: parent
Parameters:
parent
Description: Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
dataSourceIds
Location: query
Type: string
Description: When specified, only configurations of requested data sources are returned.
Repeated: Yes
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.
Type: string
Location: query
pageSize
Type: integer
Description: Page size. The default page size is the maximum value of 1000 results.
Format: int32
Location: query
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}
Path: v1/{+name}
Parameter Order: name
Description: Returns information about a data transfer config.
Scopes:
HTTP Method: GET
Parameters:
name
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns
Parameter Order: parent
Path: v1/{+parent}:scheduleRuns
Scopes:
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}: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.
Parameters:
parent
Type: string
Location: path
Description: Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
HTTP Method: POST
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns
Scopes:
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns
Path: v1/{+parent}:startManualRuns
Parameters:
parent
Required: Yes
Type: string
Location: path
Description: Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
Description: Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.
HTTP Method: POST
▼ ▲ bigquerydatatransfer.projects.locations.enrollDataSources
HTTP Method: POST
Parameters:
name
Location: path
Required: Yes
Description: The name of the project resource in the form: `projects/{project_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Scopes:
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}: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).
Path: v1/{+name}:enrollDataSources
▼ ▲ bigquerydatatransfer.projects.locations.get
Parameter Order: name
Path: v1/{+name}
Description: Gets information about a location.
HTTP Method: GET
Scopes:
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
Parameters:
name
Location: path
Type: string
Description: Resource name for the location.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
▼ ▲ bigquerydatatransfer.projects.locations.list
Flat Path: v1/projects/{projectsId}/locations
Parameter Order: name
Parameters:
name
Type: string
Required: Yes
Location: path
Description: The resource that owns the locations collection, if applicable.
Pattern: ^projects/[^/]+$
filter
Location: query
Type: string
Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize
Location: query
Format: int32
Type: integer
Description: The maximum number of results to return. If not set, the service selects a default.
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
Description: Lists information about the supported locations for this service.
HTTP Method: GET
Scopes:
Path: v1/{+name}/locations
▼ ▲ bigquerydatatransfer.projects.dataSources.list
Scopes:
Description: Lists supported data sources and returns their settings.
Parameters:
pageSize
Format: int32
Type: integer
Location: query
Description: Page size. The default page size is the maximum value of 1000 results.
parent
Description: Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
Type: string
Location: path
Pattern: ^projects/[^/]+$
Required: Yes
pageToken
Location: query
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.
Path: v1/{+parent}/dataSources
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/dataSources
Parameter Order: parent
▼ ▲ bigquerydatatransfer.projects.dataSources.get
Path: v1/{+name}
Scopes:
Flat Path: v1/projects/{projectsId}/dataSources/{dataSourcesId}
HTTP Method: GET
Parameter Order: name
Description: Retrieves a supported data source and returns its settings.
Parameters:
name
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
Type: string
Pattern: ^projects/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
▼ ▲ bigquerydatatransfer.projects.dataSources.checkValidCreds
Parameters:
name
Pattern: ^projects/[^/]+/dataSources/[^/]+$
Description: Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
Required: Yes
Location: path
Type: string
Parameter Order: name
Flat Path: v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds
Description: Returns true if valid credentials exist for the given data source and requesting user.
Scopes:
HTTP Method: POST
Path: v1/{+name}:checkValidCreds
▼ ▲ bigquerydatatransfer.projects.enrollDataSources
Parameter Order: name
Scopes:
Parameters:
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+$
Description: The name of the project resource in the form: `projects/{project_id}`
Path: v1/{+name}:enrollDataSources
Flat Path: v1/projects/{projectsId}: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).
HTTP Method: POST
▼ ▲ bigquerydatatransfer.projects.locations.list
Path: v1/{+name}/locations
Description: Lists information about the supported locations for this service.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations
Scopes:
HTTP Method: GET
Parameters:
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).
Type: string
Location: query
name
Pattern: ^projects/[^/]+$
Required: Yes
Description: The resource that owns the locations collection, if applicable.
Location: path
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.
Type: string
Location: query
pageSize
Description: The maximum number of results to return. If not set, the service selects a default.
Format: int32
Type: integer
Location: query
▼ ▲ bigquerydatatransfer.projects.locations.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Description: Resource name for the location.
Parameter Order: name
Description: Gets information about a location.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
Scopes:
HTTP Method: GET
▼ ▲ bigquerydatatransfer.projects.locations.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).
Flat Path: v1/projects/{projectsId}/locations/{locationsId}:enrollDataSources
Scopes:
Parameter Order: name
Path: v1/{+name}:enrollDataSources
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: The name of the project resource in the form: `projects/{project_id}`
Type: string
Location: path
HTTP Method: POST
▼ ▲ bigquerydatatransfer.projects.locations.dataSources.get
Scopes:
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$
Location: path
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
Required: Yes
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}
Path: v1/{+name}
Parameter Order: name
Description: Retrieves a supported data source and returns its settings.
▼ ▲ bigquerydatatransfer.projects.locations.dataSources.list
Description: Lists supported data sources and returns their settings.
Parameters:
pageSize
Format: int32
Type: integer
Location: query
Description: Page size. The default page size is the maximum value of 1000 results.
pageToken
Type: string
Location: query
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.
parent
Type: string
Required: Yes
Location: path
Description: Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
HTTP Method: GET
Parameter Order: parent
Path: v1/{+parent}/dataSources
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources
Scopes:
▼ ▲ bigquerydatatransfer.projects.locations.dataSources.checkValidCreds
Description: Returns true if valid credentials exist for the given data source and requesting user.
Scopes:
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$
Required: Yes
Description: Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
Type: string
Location: path
HTTP Method: POST
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds
Path: v1/{+name}:checkValidCreds
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.delete
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}
Path: v1/{+name}
HTTP Method: DELETE
Scopes:
Parameters:
name
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
Required: Yes
Type: string
Description: Deletes a data transfer configuration, including any associated transfer runs and logs.
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
Description: Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Type: string
Required: Yes
Location: path
Description: Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns
Path: v1/{+parent}:startManualRuns
Scopes:
HTTP Method: POST
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.patch
HTTP Method: PATCH
Description: Updates a data transfer configuration. All fields must be set, even if they are not updated.
Parameters:
name
Description: The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/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/[^/]+$
Type: string
Location: path
Required: Yes
updateMask
Description: Required. Required list of fields to be updated in this request.
Location: query
Type: string
Format: google-fieldmask
authorizationCode
Location: query
Description: 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://www.gstatic.com/bigquerydatatransfer/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 a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.
Type: string
serviceAccountName
Location: query
Type: string
Description: Optional service account name. 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).
versionInfo
Location: query
Type: string
Description: Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/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 a 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.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
Type: string
Location: path
Required: Yes
Scopes:
Path: v1/{+name}
Description: Returns information about a data transfer config.
HTTP Method: GET
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns
Path: v1/{+parent}:scheduleRuns
Parameter Order: parent
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}: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.
Parameters:
parent
Required: Yes
Type: string
Description: Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
Scopes:
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.create
Parameters:
authorizationCode
Location: query
Type: string
Description: 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://www.gstatic.com/bigquerydatatransfer/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 a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
serviceAccountName
Type: string
Description: Optional service account name. 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
versionInfo
Description: Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/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 a 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
parent
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
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.
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new data transfer configuration.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs
HTTP Method: POST
Parameter Order: parent
Path: v1/{+parent}/transferConfigs
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.list
Scopes:
HTTP Method: GET
Parameters:
pageSize
Description: Page size. The default page size is the maximum value of 1000 results.
Type: integer
Format: int32
Location: query
parent
Required: Yes
Description: Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
dataSourceIds
Location: query
Description: When specified, only configurations of requested data sources are returned.
Repeated: Yes
Type: string
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
Path: v1/{+parent}/transferConfigs
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs
Description: Returns information about all transfer configs owned by a project in the specified location.
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list
Scopes:
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs
Path: v1/{+parent}/transferLogs
Description: Returns log messages for the transfer run.
Parameters:
parent
Description: Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Type: string
messageTypes
Description: Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
Repeated: Yes
Location: query
Enum:
Type: string
Enum Descriptions:
pageSize
Description: Page size. The default page size is the maximum value of 1000 results.
Type: integer
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.
Type: string
Location: query
HTTP Method: GET
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.runs.get
Parameter Order: name
Description: Returns information about the particular transfer run.
Path: v1/{+name}
Parameters:
name
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Required: Yes
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
Scopes:
HTTP Method: GET
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.runs.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs
Path: v1/{+parent}/runs
Scopes:
Description: Returns information about running and completed transfer runs.
HTTP Method: GET
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
Description: Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Type: string
Location: path
pageSize
Description: Page size. The default page size is the maximum value of 1000 results.
Format: int32
Type: integer
Location: query
states
Location: query
Enum Descriptions:
Repeated: Yes
Type: string
Enum:
Description: When specified, only transfer runs with requested states are returned.
pageToken
Type: string
Location: query
Description: Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
runAttempt
Type: string
Location: query
Description: Indicates how run attempts are to be pulled.
Enum Descriptions:
Enum:
Parameter Order: parent
▼ ▲ bigquerydatatransfer.projects.locations.transferConfigs.runs.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
Description: Deletes the specified transfer run.
Parameter Order: name
HTTP Method: DELETE
Path: v1/{+name}
Scopes:
Parameters:
name
Required: Yes
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
▼ ▲ bigquerydatatransfer.projects.dataSources.list
Flat Path: v1/projects/{projectsId}/dataSources
HTTP Method: GET
Parameter Order: parent
Scopes:
Parameters:
pageToken
Type: string
Location: query
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.
pageSize
Location: query
Format: int32
Type: integer
Description: Page size. The default page size is the maximum value of 1000 results.
parent
Description: Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+$
Type: string
Location: path
Required: Yes
Description: Lists supported data sources and returns their settings.
Path: v1/{+parent}/dataSources
▼ ▲ bigquerydatatransfer.projects.dataSources.get
Path: v1/{+name}
Description: Retrieves a supported data source and returns its settings.
Flat Path: v1/projects/{projectsId}/dataSources/{dataSourcesId}
Scopes:
HTTP Method: GET
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/dataSources/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
▼ ▲ bigquerydatatransfer.projects.dataSources.checkValidCreds
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/dataSources/[^/]+$
Location: path
Description: Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
Flat Path: v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds
Path: v1/{+name}:checkValidCreds
Description: Returns true if valid credentials exist for the given data source and requesting user.
HTTP Method: POST
Scopes:
Parameter Order: name
▼ ▲ bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs
Parameter Order: parent
Description: Returns log messages for the transfer run.
Parameters:
pageToken
Location: query
Description: Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
Type: string
pageSize
Format: int32
Location: query
Type: integer
Description: Page size. The default page size is the maximum value of 1000 results.
parent
Type: string
Location: path
Description: Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Pattern: ^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Required: Yes
messageTypes
Repeated: Yes
Description: Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
Enum:
Type: string
Location: query
Enum Descriptions:
HTTP Method: GET
Path: v1/{+parent}/transferLogs
Scopes:
▼ ▲ bigquerydatatransfer.projects.transferConfigs.runs.delete
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Location: path
Required: Yes
Description: Deletes the specified transfer run.
Path: v1/{+name}
Scopes:
Parameter Order: name
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
HTTP Method: DELETE
▼ ▲ bigquerydatatransfer.projects.transferConfigs.runs.get
Scopes:
Parameters:
name
Pattern: ^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
Type: string
Required: Yes
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
Location: path
Parameter Order: name
Description: Returns information about the particular transfer run.
Path: v1/{+name}
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
▼ ▲ bigquerydatatransfer.projects.transferConfigs.runs.list
Parameter Order: parent
HTTP Method: GET
Description: Returns information about running and completed transfer runs.
Parameters:
parent
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Description: Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
pageSize
Location: query
Description: Page size. The default page size is the maximum value of 1000 results.
Type: integer
Format: int32
states
Description: When specified, only transfer runs with requested states are returned.
Repeated: Yes
Enum Descriptions:
Type: string
Enum:
Location: query
runAttempt
Enum:
Type: string
Description: Indicates how run attempts are to be pulled.
Location: query
Enum Descriptions:
pageToken
Location: query
Description: Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
Type: string
Scopes:
Path: v1/{+parent}/runs
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs
▼ ▲ bigquerydatatransfer.projects.transferConfigs.scheduleRuns
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.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns
Parameters:
parent
Required: Yes
Description: Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Location: path
Type: string
Scopes:
Parameter Order: parent
▼ ▲ bigquerydatatransfer.projects.transferConfigs.delete
HTTP Method: DELETE
Path: v1/{+name}
Description: Deletes a data transfer configuration, including any associated transfer runs and logs.
Parameters:
name
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Type: string
Required: Yes
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
Location: path
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}
Scopes:
Parameter Order: name
▼ ▲ bigquerydatatransfer.projects.transferConfigs.get
Description: Returns information about a data transfer config.
Scopes:
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Description: Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
HTTP Method: GET
▼ ▲ bigquerydatatransfer.projects.transferConfigs.patch
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
serviceAccountName
Location: query
Type: string
Description: Optional service account name. 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).
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: Required. Required list of fields to be updated in this request.
name
Description: The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
Type: string
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Location: path
Required: Yes
authorizationCode
Type: string
Description: 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://www.gstatic.com/bigquerydatatransfer/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 a 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
versionInfo
Type: string
Description: Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/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 a 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
HTTP Method: PATCH
Description: Updates a data transfer configuration. All fields must be set, even if they are not updated.
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}
▼ ▲ bigquerydatatransfer.projects.transferConfigs.startManualRuns
Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns
Path: v1/{+parent}:startManualRuns
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/transferConfigs/[^/]+$
Required: Yes
Description: Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
Location: path
Parameter Order: parent
Scopes:
HTTP Method: POST
Description: Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.
▼ ▲ bigquerydatatransfer.projects.transferConfigs.list
Parameters:
parent
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
pageSize
Type: integer
Description: Page size. The default page size is the maximum value of 1000 results.
Format: int32
Location: query
pageToken
Location: query
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.
dataSourceIds
Description: When specified, only configurations of requested data sources are returned.
Location: query
Type: string
Repeated: Yes
HTTP Method: GET
Description: Returns information about all transfer configs owned by a project in the specified location.
Path: v1/{+parent}/transferConfigs
Scopes:
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/transferConfigs
▼ ▲ bigquerydatatransfer.projects.transferConfigs.create
Description: Creates a new data transfer configuration.
Parameters:
serviceAccountName
Description: Optional service account name. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about [using service accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
Type: string
Location: query
parent
Required: Yes
Type: string
Pattern: ^projects/[^/]+$
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.
Location: path
authorizationCode
Type: string
Location: query
Description: 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://www.gstatic.com/bigquerydatatransfer/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 a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
versionInfo
Type: string
Description: Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/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 a 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
Flat Path: v1/projects/{projectsId}/transferConfigs
Path: v1/{+parent}/transferConfigs
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ bigquerydatatransfer.projects.enrollDataSources
HTTP Method: POST
Scopes:
Parameter Order: name
Description: Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
Parameters:
name
Pattern: ^projects/[^/]+$
Type: string
Description: The name of the project resource in the form: `projects/{project_id}`
Location: path
Required: Yes
Flat Path: v1/projects/{projectsId}:enrollDataSources
Path: v1/{+name}:enrollDataSources